PAUSE SCHEDULES

On this page

Warning:

As of June 5, 2024, CockroachDB v22.2 is no longer supported. For more details, refer to 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

The following users can pause a schedule:

Members of the admin role. By default, the root user belongs to the admin role.
New in v22.2: Owners of a backup schedule, i.e., the user that created the backup schedule.

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