PAUSE SCHEDULES

On this page

Warning:

CockroachDB v20.2 is no longer supported as of May 10, 2022. For more details, refer to the Release Support Policy.

New in v20.2: The PAUSE SCHEDULES statement can be used to pause backup schedules.

After pausing a schedule, you can resume it with RESUME SCHEDULES.

Required privileges

Only members of the admin role can pause a schedule. By default, the root user belongs to the admin role.

PAUSE SCHEDULES <selectclause>
  select clause: select statement returning schedule id to pause.
PAUSE SCHEDULE <scheduleID>

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`.

> PAUSE SCHEDULE 589963390487363585;

PAUSE SCHEDULES 1

To pause multiple schedules, nest a SELECT clause that retrieves id(s) inside the PAUSE SCHEDULES statement:

> PAUSE SCHEDULES SELECT id FROM [SHOW SCHEDULES] WHERE label = 'schedule_database';

PAUSE SCHEDULES 4

In this example, all schedules with the label schedule_database are paused.