On this page
Warning:
GA releases for CockroachDB v23.1 are no longer supported. Cockroach Labs will stop providing LTS Assistance Support for v23.1 LTS releases on November 13, 2025. 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
admin
role. By default, theroot
user belongs to theadmin
role. - 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.