SHOW VIRTUAL CLUSTER

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

New in v23.2: The SHOW VIRTUAL CLUSTER statement lists all virtual clusters running in a CockroachDB cluster. SHOW VIRTUAL CLUSTER supports inspecting virtual cluster status only as part of the workflow.

PCR happens between an active primary cluster and a passive standby cluster that accepts updates from the primary cluster. The unit of replication is a virtual cluster, which is part of the underlying infrastructure in the primary and standby clusters. The CockroachDB cluster has:

• The system virtual cluster manages the cluster’s control plane and the replication of the cluster’s data. Admins connect to the system virtual cluster to configure and manage the underlying CockroachDB cluster, set up PCR, create and manage a virtual cluster, and observe metrics and logs for the CockroachDB cluster and each virtual cluster.
• Each other virtual cluster manages its own data plane. Users connect to a virtual cluster by default, rather than the system virtual cluster. To connect to the system virtual cluster, the connection string must be modified. Virtual clusters contain user data and run application workloads. When PCR is enabled, the non-system virtual cluster on both primary and secondary clusters is named application.

For more detail, refer to the .

Required privileges

SHOW VIRTUAL CLUSTER requires either:

• The admin role.
• The MANAGEVIRTUALCLUSTER .

Use the statement:

GRANT SYSTEM MANAGEVIRTUALCLUSTER TO user;

Synopsis

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

Parameters

Parameter	Description
virtual\_cluster\_spec	The name of the virtual cluster.
REPLICATION STATUS	Display the details of a replication stream.
CAPABILITIES	Display the of a virtual cluster.

Responses

This table lists all possible responses from the different SHOW VIRTUAL CLUSTER statements:

Field	Response
id	The ID of a virtual cluster.
name	The name of the standby (destination) virtual cluster.
data\_state	The state of the data on a virtual cluster. This can show one of the following: initializing replication, ready, replicating, replication paused, replication pending cutover, replication cutting over, replication error. Refer to Data state for more detail on each response.
service\_mode	The service mode shows whether a virtual cluster is ready to accept SQL requests. This can show one none or shared. When shared, a virtual cluster’s SQL connections will be served by the same nodes that are serving the system virtual cluster.
source\_tenant\_name	The name of the primary (source) virtual cluster.
source\_cluster\_uri	The URI of the primary (source) cluster. The standby cluster connects to the primary cluster using this URI when .
replication\_job\_id	The ID of the replication job.
replicated\_time	The latest timestamp at which the standby cluser has consistent data — that is, the latest time you can cut over to. This time advances automatically as long as the replication proceeds without error. replicated\_time is updated periodically (every 30s).
retained\_time	The earliest timestamp at which the standby cluster has consistent data — that is, the earliest time you can cut over to.
cutover\_time	The time at which the cutover will begin. This can be in the past or the future. Refer to .
capability\_name	The name.
capability\_value	Whether the is enabled for a virtual cluster.

Data state

State	Description
initializing replication	The replication job is completing the initial scan of data from the primary cluster before it starts replicating data in real time.
ready	A virtual cluster’s data is ready for use.
replicating	The replication job has started and is replicating data.
replication paused	The replication job is paused due to an error or a manual request with .
replication pending cutover	The replication job is running and the cutover time has been set. Once the the replication reaches the cutover time, the cutover will begin automatically.
replication cutting over	The job has started cutting over. The cutover time can no longer be changed. Once cutover is complete, A virtual cluster will be available for use with .
replication error	An error has occurred. You can find more detail in the error message and the . Note: A PCR job will retry for 3 minutes before failing.

Examples

Show all virtual clusters

List all virtual clusters:

SHOW VIRTUAL CLUSTERS;

Show a virtual cluster

To show more details about the application virtual cluster:

SHOW VIRTUAL CLUSTER application;

  id |     name           | data_state  | service_mode | source_tenant_name |                                                  source_cluster_uri                                                   | replication_job_id |       replicated_time        |         retained_time         | cutover_time
-----+--------------------+-------------+--------------+--------------------+-----------------------------------------------------------------------------------------------------------------------+--------------------+------------------------------+-------------------------------+---------------
   5 | application        | replicating | none         | application        | postgresql://user:redacted@host?options=-ccluster%3Dsystem&sslmode=verify-full&sslrootcert=redacted | 911803003607220225 | 2023-10-26 17:36:52.27978+00 | 2023-10-26 14:36:52.279781+00 |         NULL

Show replication status

To show the replication status of all virtual clusters:

SHOW VIRTUAL CLUSTERS WITH REPLICATION STATUS;

To show the replication status of the application virtual cluster:

SHOW VIRTUAL CLUSTER application WITH REPLICATION STATUS;

See also