Annotation Interface VirtualCluster


@Documented @Retention(RUNTIME) @Target(METHOD) public @interface VirtualCluster
Routes the annotated method to a Cockroach vCluster (virtual cluster) for workload isolation on shared capacity.

When a proxied method carrying this annotation opens a transaction, the value is applied as SET LOCAL application_name to tag the session. Combine with Workload to also set the transaction QoS.

Scope (v1): workload tagging/QoS. Routing to a distinct vCluster endpoint is platform-dependent and not performed here.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    The virtual cluster name (e.g.
  • Element Details

    • value

      String value
      The virtual cluster name (e.g. analytics).