This feature is in preview. This feature is subject to change. To share feedback and/or issues, contact Support.
This is an enterprise-only feature. Request a 30-day trial license to try it out.
New in v23.2:
The DROP VIRTUAL CLUSTER
statement removes virtual clusters. Virtual clusters are used only as part of the physical cluster replication workflow.
Physical cluster replication 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. Each cluster has:
- The system interface manages the cluster's control plane and the replication of the virtual cluster.
- The virtual cluster manages its own data plane. Users connect to the virtual cluster that contains the application user data.
For more detail, refer to the Physical Cluster Replication Overview.
The DROP VIRTUAL CLUSTER
statement will delete all data related to the specified virtual cluster.
Required privileges
DROP VIRTUAL CLUSTER
requires one of the following privileges:
- The
admin
role. - The
MANAGEVIRTUALCLUSTER
system privilege allows the user to run all the relatedVIRTUAL CLUSTER
SQL statements for physical cluster replication.
Use the GRANT SYSTEM
statement:
GRANT SYSTEM MANAGEVIRTUALCLUSTER TO user;
Synopsis
Parameters
Parameter | Description |
---|---|
IF EXISTS |
Drop the virtual cluster if it exists. If it does not exist, do not return an error. |
virtual_cluster_spec |
The name of the virtual cluster. |
IMMEDIATE |
Drop the virtual cluster immediately instead of waiting for garbage collection (GC TTL). |
Examples
Remove a virtual cluster
To remove a virtual cluster from a CockroachDB cluster:
DROP VIRTUAL CLUSTER IF EXISTS application;
Remove a virtual cluster without waiting for garbage collection
Use IMMEDIATE
to drop a virtual cluster instead of waiting for data to be garbage collected:
DROP VIRTUAL CLUSTER IF EXISTS application IMMEDIATE;