CockroachDB · Schema

Region

A geographic region where the cluster or its nodes are deployed.

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Properties

Name Type Description
name string Cloud provider region identifier (e.g. us-east-1).
sql_dns string DNS hostname for SQL connections routed to this region.
node_count integer Number of nodes in this region.
View JSON Schema on GitHub

JSON Schema

cockroachdb-region-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Region",
  "title": "Region",
  "type": "object",
  "description": "A geographic region where the cluster or its nodes are deployed.",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Cloud provider region identifier (e.g. us-east-1)."
    },
    "sql_dns": {
      "type": "string",
      "description": "DNS hostname for SQL connections routed to this region."
    },
    "node_count": {
      "type": "integer",
      "description": "Number of nodes in this region."
    }
  }
}