Jobs Page

On this page Carat arrow pointing down
Warning:
CockroachDB v22.2 is no longer supported as of June 5, 2024. For more details, refer to the Release Support Policy.

The Jobs page of the DB Console provides details about long-running tasks performed by your cluster. These can include:

All users can see their own jobs, and admin users can view all jobs performed across all nodes in the cluster.

To view this page, click Jobs in the left-hand navigation of the DB Console.

Note:

By default, jobs are deleted every 14 days. You can change this interval using the jobs.retention_time cluster setting.

The Jobs list is designed for you to manage pending work. It is not intended to display the canonical record of all jobs that have run. If you need a historical record of all jobs you have run, you should log this information externally.

Jobs table

Use the Jobs table to see recently created and completed jobs.

The following screenshot shows ALTER TABLE jobs:

DB Console Jobs Page

Filter jobs

Use the controls to filter jobs:

  • Status: filter jobs by job status.
  • Type: filter jobs by type. Automatic table statistics jobs are not displayed even when the Type menu is set to All. To view these jobs, set Type to Auto-Statistics Creation.
  • Show: toggle between showing the latest 50 jobs or all jobs.

The status line after the filters shows the number of jobs displayed and a message indicating the oldest time (in UTC) that jobs are shown for. The oldest time is calculated as now - the duration of the jobs.retention_time cluster setting, set to 28 days by default.

The table is paginated with 20 jobs per page. Click the page controls following the table to traverse pages.

The following are displayed for each job:

Column Description
Description SQL statement that created the job.
Status Current job status or completion progress.
Job ID Unique job ID. This value is used to pause, resume, or cancel jobs.
User Name User that created the job.
Creation Time (UTC) Date and time the job was created.
Modified Time (UTC) Date and time the job was modified.
Last Execution Time (UTC) Date and time the job was last executed.
High-water Timestamp A checkpoint for a changefeed job's progress that guarantees that all changes before (or at) the timestamp have been emitted. Hover over the high-water timestamp to view the system time.
Execution Count Number of times the job was executed.
Coordinator Node ID of the coordinating node.

To view job details, click the job description.

Job status

Status Description
PENDING Job is created but has not started running.
PAUSED Job is paused.
PAUSE-REQUESTED A request has been issued to pause the job. The status will move to PAUSED when the node running the job registers the request.
FAILED Job failed to complete.
SUCCEEDED Job successfully completed.
CANCELED Job was canceled.
CANCEL-REQUESTED A request has been issued to cancel the job. The status will move to CANCELED when the node running the job registers the request.
RUNNING Job is running. A job that is running will be displayed with its percent completion and time remaining, rather than the RUNNING status.
REVERTING Job failed or was canceled and its changes are being reverted.
REVERT-FAILED Job encountered a non-retryable error when reverting the changes. It is necessary to manually clean up a job with this status.
RETRYING Job is retrying another job that failed.

Job details

The job ID, creation time, user, status, and error messages (if any) are also shown.

DB Console Jobs Page

See also


Yes No
On this page

Yes No