CockroachDB · Schema

UpdateClusterSpecification

Specification for modifying an existing cluster's configuration.

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Properties

Name	Type	Description
dedicated	object	Updated dedicated cluster configuration fields.
serverless	object	Updated serverless cluster configuration fields.
cockroach_version	string	Target CockroachDB version for the upgrade.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateClusterSpecification",
  "title": "UpdateClusterSpecification",
  "type": "object",
  "description": "Specification for modifying an existing cluster's configuration.",
  "properties": {
    "dedicated": {
      "type": "object",
      "description": "Updated dedicated cluster configuration fields."
    },
    "serverless": {
      "type": "object",
      "description": "Updated serverless cluster configuration fields."
    },
    "cockroach_version": {
      "type": "string",
      "description": "Target CockroachDB version for the upgrade."
    }
  }
}