PAUSE SCHEDULES

On this page Carat arrow pointing down
Warning:
CockroachDB v21.1 is no longer supported. For more details, see the Release Support Policy.

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.

Synopsis

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

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

icon/buttons/copy
> 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:

icon/buttons/copy
> 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.

See also


Yes No
On this page

Yes No