On this page 
Warning:
Cockroach Labs will stop providing Assistance Support for v23.1 on November 15, 2024. Prior to that date, upgrade to a more recent version to continue receiving support. For more details, refer to the Release Support Policy.
The PAUSE SCHEDULES statement can be used to pause backup schedules and changefeed schedules.
After pausing a schedule, you can resume it with RESUME SCHEDULES.
Required privileges
The following users can pause a schedule:
- Members of the
adminrole. By default, therootuser belongs to theadminrole. - Owners of a backup schedule, i.e., the user that created the backup schedule.
- Owners of a changefeed schedule, i.e., the user that created the changefeed schedule.
Synopsis
Parameters
| Parameter | Description |
|---|---|
selectclause |
A selection query that returns id(s) to pause. |
scheduleID |
The id of the schedule you want to pause, which can be found with SHOW SCHEDULES. |
Examples
Pause a single schedule
> PAUSE SCHEDULE 589963390487363585;
PAUSE SCHEDULES 1
Pause multiple schedules
To pause multiple schedules, nest a SELECT clause that retrieves id(s) inside the PAUSE SCHEDULES statement:
> PAUSE SCHEDULES WITH x AS (SHOW SCHEDULES) SELECT id FROM x WHERE label = 'schedule_database';
PAUSE SCHEDULES 4
In this example, all schedules with the label schedule_database are paused.
See also
- Manage a Backup Schedule
BACKUPRESTORECREATE CHANGEFEEDSHOW BACKUPSHOW SCHEDULESRESUME SCHEDULESDROP SCHEDULESPAUSE JOBRESUME JOBCANCEL JOB- Take Full and Incremental Backups
- Use the Built-in SQL Client
cockroachCommands Overview
Was this helpful?
