Show Schedules
Summary
The SHOW SCHEDULES command returns a result set listing metadata for any schedule objects defined in the Connect environment.
Syntax
show schedules; |
Parameters
None
Details
The SHOW SCHEDULES result set includes the following columns.
|
Column Name
|
Data Type
|
Description
|
|---|---|---|
| id | string | Unique identifier for each schedule |
| name | string | Schedule name given by developer |
| description | string | Text documentation a developer added to the schedule object |
| current_state | string | Shows the state of the pipeline. Possible values are: ‘running’, ‘ready’, and ‘wait_on_condition’ |
| last_start | instant | The most recent start time for the schedule |
| last_end | instant | The most recent completed time for the schedule |
| last_invocation_id | string | The invocation_id of the step or pipeline given in object_type.
Refer to the |
| object_type | string | Shows if the schedule will fire a “pipeline” or “step” |
| object_name | string | Name of the pipeline or step attached to the schedule |
| cron | string | The cron expression used by the schedule object |
| suspended | boolean | Shows whether the schedule is active or suspended. Refer to RESUME SCHEDULE and SUSPEND SCHEDULE. |
| condition | string | Displays the conditional expression for the schedule (if defined). Allows the schedule to continue execution if a certain boolean condition is met. If false, the schedule will execute the step found inon_condition_false_name. |
| retries | integer | The number of times the schedule will reevaluate condition if it is false |
| retry_interval | integer | Number of minutes between each retry attempt |
| on_condition_false_name | string | Name of the step to execute if the condition evaluates to false after all retries |
| next_fire_time | instant | UTC instant when the schedule will fire next |
| created_by | string | Connect user who created the schedule |
| created_instant | instant | Instant when the schedule was created |
| modified_by | string | Connect user who last modified the schedule |
| modified_instant | instant | Instant when the schedule was last modified |
Examples
show schedules;

select name, object_name, cron, condition, next_fire_time
from (show schedules)
where suspended=false;

Related Commands
