SHOW LOGICAL REPLICATION JOBS

This feature is in and subject to change. To share feedback and/or issues, contact Support.

Logical data replication is only supported in CockroachDB self-hosted clusters. The SHOW LOGICAL REPLICATION JOBS statement shows details of jobs on a cluster.

This page is a reference for the SHOW LOGICAL REPLICATION JOBS SQL statement, which includes information on its parameters and possible options. For more details on monitoring LDR, refer to the page.

Required privileges

You must have one of the following to run SHOW LOGICAL REPLICATION JOBS:

• The .
• The , which can view all jobs (including admin -owned jobs).

Use the statement:

GRANT SYSTEM VIEWJOB TO user;

Synopsis

xml version=“1.0” encoding=“UTF-8”?

Parameters

Parameter	Description
show\_logical\_replication\_jobs\_options	Option to modify the output.

Options

Option	Description
details	Includes the additional columns: replication\_start\_time, conflict\_resolution\_type, description.

Responses

Field	Response
job\_id	The job’s ID. Use with , , , .
status	The job’s current state. Possible values: pending, paused, pause-requested, failed, succeeded, canceled, cancel-requested, running, retry-running, retry-reverting, reverting, revert-failed. Refer to for a description of each status.
tables	The fully qualified name of the table(s) that are part of the LDR job.
replicated\_time	The latest at which the destination cluster has consistent data. This time advances automatically as long as the LDR job proceeds without error. replicated\_time is updated periodically (every 30s).
replication\_start\_time	The start time of the LDR job.
conflict\_resolution\_type	The type of : LWW last write wins.
command	Description of the job including the replicating table(s) and the cluster connections.

Example

In the destination cluster’s SQL shell, you can query SHOW LOGICAL REPLICATION JOBS to view the LDR jobs running on the cluster:

SHOW LOGICAL REPLICATION JOBS;

        job_id        | status  |          tables           | replicated_time
----------------------+---------+---------------------------+------------------
1012877040439033857   | running | {database.public.table}   | NULL
(1 row)

For additional detail on each LDR job, use the WITH details option:

SHOW LOGICAL REPLICATION JOBS WITH details;

        job_id        |  status  |            tables              |        replicated_time        |    replication_start_time     | conflict_resolution_type |                                      command
----------------------+----------+--------------------------------+-------------------------------+-------------------------------+--------------------------+-----------------------------------------------------------------------------------------
  1010959260799270913 | running  | {movr.public.promo_codes}      | 2024-10-24 17:50:05+00        | 2024-10-10 20:04:42.196982+00 | LWW                      | LOGICAL REPLICATION STREAM into movr.public.promo_codes from external://cluster_a
  1014047902397333505 | canceled | {defaultdb.public.office_dogs} | 2024-10-24 17:30:25+00        | 2024-10-21 17:54:20.797643+00 | LWW                      | LOGICAL REPLICATION STREAM into defaultdb.public.office_dogs from external://cluster_a

See also