planetscalevitessbranch (Data Source)

June 1, 2026 ยท View on GitHub

VitessBranch DataSource

Example Usage

data "planetscale_vitess_branch" "my_vitessbranch" {
  database     = "...my_database..."
  id           = "...my_id..."
  organization = "...my_organization..."
}

Schema

Required

  • database (String) Database name slug from list_databases. Example: app-db.
  • id (String) The ID of the branch
  • organization (String) Organization name slug from list_organizations. Example: acme.

Read-Only

  • actor (Attributes) (see below for nested schema)
  • cluster_size (String) The SKU representing the branch's cluster size
  • html_url (String) Planetscale app URL for the branch
  • mysql_address (String) The MySQL address for the branch
  • mysql_edge_address (String) The address of the MySQL provider for the branch
  • name (String) The name of the branch
  • parent_branch (String) The name of the parent branch from which the branch was created
  • ready (Boolean) Whether or not the branch is ready to serve queries
  • region_data (Attributes) (see below for nested schema)
  • state (String) The current state of the branch
  • url (String) Planetscale API URL for the branch

Nested Schema for actor

Read-Only:

  • id (String) The ID of the actor

Nested Schema for region_data

Read-Only:

  • id (String) The ID of the region
  • mysql_supported (Boolean) Whether the region supports MySQL/Vitess databases
  • postgresql_supported (Boolean) Whether the region supports PostgreSQL databases