On this page
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.