diff --git a/_includes/v22.2/backups/view-scheduled-backups.md b/_includes/v22.2/backups/view-scheduled-backups.md new file mode 100644 index 00000000000..7fe90989bc2 --- /dev/null +++ b/_includes/v22.2/backups/view-scheduled-backups.md @@ -0,0 +1,7 @@ + When a [backup is created by a schedule](create-schedule-for-backup.html), it is stored within a collection of backups in the given location. To view details for a backup created by a schedule, you can use the following: + +- `SHOW BACKUPS IN collectionURI` statement to [view a list of the full backup's subdirectories](show-backup.html#view-a-list-of-the-available-full-backup-subdirectories). +- `SHOW BACKUP FROM subdirectory IN collectionURI` statement to [view a list of the full and incremental backups that are stored in a specific full backup's subdirectory](show-backup.html#view-a-list-of-the-full-and-incremental-backups-in-a-specific-full-backup-subdirectory). +- Use the [Schedules page](ui-schedules-page.html) in the [DB Console](ui-overview.html) to view a list of created backup schedules and their individual details. + +For more details, see [`SHOW BACKUP`](show-backup.html). \ No newline at end of file diff --git a/_includes/v22.2/sidebar-data/reference.json b/_includes/v22.2/sidebar-data/reference.json index 2ddd26baaea..abe7ce1a2ff 100644 --- a/_includes/v22.2/sidebar-data/reference.json +++ b/_includes/v22.2/sidebar-data/reference.json @@ -1817,6 +1817,12 @@ "/${VERSION}/ui-jobs-page.html" ] }, + { + "title": "Schedules Page", + "urls": [ + "/${VERSION}/ui-schedules-page.html" + ] + }, { "title": "Advanced Debug Page", "urls": [ diff --git a/images/v22.2/schedule-id-screen.png b/images/v22.2/schedule-id-screen.png new file mode 100644 index 00000000000..cca4210765d Binary files /dev/null and b/images/v22.2/schedule-id-screen.png differ diff --git a/images/v22.2/schedules-page.png b/images/v22.2/schedules-page.png new file mode 100644 index 00000000000..bfe91725965 Binary files /dev/null and b/images/v22.2/schedules-page.png differ diff --git a/v22.2/create-schedule-for-backup.md b/v22.2/create-schedule-for-backup.md index d360b551cca..7ee84b30908 100644 --- a/v22.2/create-schedule-for-backup.md +++ b/v22.2/create-schedule-for-backup.md @@ -237,12 +237,7 @@ Because the [`FULL BACKUP` clause](#full-backup-clause) was not included, Cockro ### View scheduled backup details -When a [backup is created by a schedule](create-schedule-for-backup.html), it is stored within a collection of backups in the given location. To view details for a backup created by a schedule, you can use the following: - -- `SHOW BACKUPS IN collectionURI` statement to [view a list of the full backup's subdirectories](show-backup.html#view-a-list-of-the-available-full-backup-subdirectories). -- `SHOW BACKUP FROM subdirectory IN collectionURI` statement to [view a list of the full and incremental backups that are stored in a specific full backup's subdirectory](show-backup.html#view-a-list-of-the-full-and-incremental-backups-in-a-specific-full-backup-subdirectory). - -For more details, see [`SHOW BACKUP`](show-backup.html). +{% include {{ page.version.version }}/backups/view-scheduled-backups.md %} ## See also diff --git a/v22.2/manage-a-backup-schedule.md b/v22.2/manage-a-backup-schedule.md index 6a447302a7c..67a0ca89c3e 100644 --- a/v22.2/manage-a-backup-schedule.md +++ b/v22.2/manage-a-backup-schedule.md @@ -64,12 +64,7 @@ For a tutorial on how to use Prometheus to set up monitoring and alerting, see [ ## View scheduled backup details - When a [backup is created by a schedule](create-schedule-for-backup.html), it is stored within a collection of backups in the given location. To view details for a backup created by a schedule, you can use the following: - -- `SHOW BACKUPS IN collectionURI` statement to [view a list of the full backup's subdirectories](show-backup.html#view-a-list-of-the-available-full-backup-subdirectories). -- `SHOW BACKUP FROM subdirectory IN collectionURI` statement to [view a list of the full and incremental backups that are stored in a specific full backup's subdirectory](show-backup.html#view-a-list-of-the-full-and-incremental-backups-in-a-specific-full-backup-subdirectory). - -For more details, see [`SHOW BACKUP`](show-backup.html). +{% include {{ page.version.version }}/backups/view-scheduled-backups.md %} ## View and control the backup schedule diff --git a/v22.2/ui-schedules-page.md b/v22.2/ui-schedules-page.md new file mode 100644 index 00000000000..82dd8e6bc94 --- /dev/null +++ b/v22.2/ui-schedules-page.md @@ -0,0 +1,54 @@ +--- +title: Schedules Page +summary: The Schedules page of the DB Console provides details about scheduled tasks performed by your cluster. +toc: true +docs_area: reference.db_console +--- + +{% include_cached new-in.html version="v22.2" %} The **Schedules** page of the DB Console provides details about the scheduled tasks performed by your cluster. These can include: + +- [Scheduled backups](manage-a-backup-schedule.html) +- [Scheduled auto statistics compaction](cost-based-optimizer.html#table-statistics) +- [Row-level TTL](row-level-ttl.html) + +To view these details, [access the DB console](ui-overview.html#db-console-access) and click **Schedules** in the left-hand navigation. + +## Filter schedules + +- Use the **Status** menu to filter schedules by schedule status, displaying all schedules, only active schedules, or only paused schedules. +- Use the **Show** menu to toggle displaying the latest 50 schedules or all schedules on the cluster. + +## Schedules list + +Use the **Schedules** list to see your active and paused schedules. + +- To view schedule details click the schedule ID. +- If you drop a schedule, it will no longer be listed. + +The following screenshot shows a list of backups and automated statistics compaction schedules: + +Schedules Page UI in the DB Console showing a list of schedules + +Column | Description +---------------------+-------------- +Schedule ID | The unique ID for the schedule. This is used to [pause](pause-schedules.html), [resume](resume-schedules.html), and [drop](drop-schedules.html) schedules. +Label | The label given to the schedule on creation. +Status | The current status of the schedule, **Active** or **Paused**. +Next Execution Time (UTC) | The next time at which the scheduled task will run. +Recurrence | How often the schedule will run. +Jobs Running | The number of jobs currently running for that schedule. +Owner | The user that created the schedule. +Creation Time (UTC) | The time at which the user originally created the schedule. + +## Schedule details + +Click on a schedule ID to view the full SQL statement that the schedule runs. For example, the following screenshot shows the resulting [`BACKUP`](backup.html) statement for a full cluster backup recurring every day: + +UI for each individual schedule ID displaying the CREATE SCHEDULE SQL statement + +You may also view a `protected_timestamp_record` on this page. This indicates that the schedule is actively managing its own [protected timestamp](architecture/storage-layer.html#protected-timestamps) records independently of [GC TTL](configure-replication-zones.html#gc-ttlseconds). See [Protected timestamps and scheduled backups](create-schedule-for-backup.html#protected-timestamps-and-scheduled-backups) for more detail. + +## See also + +- [`CREATE SCHEDULE FOR BACKUP`](create-schedule-for-backup.html) +- [Take Full and Incremental Backups](take-full-and-incremental-backups.html) \ No newline at end of file