planetscale_databases (Data Source)

June 1, 2026 ยท View on GitHub

Databases DataSource

Example Usage

data "planetscale_databases" "my_databases" {
  organization = "...my_organization..."
  q            = "...my_q..."
}

Schema

Required

  • organization (String) Organization name slug from list_organizations. Example: acme.

Optional

  • q (String) Search term to filter databases by name

Read-Only

  • data (Attributes List) (see below for nested schema)
  • type (String) The response type. Always "list" for paginated responses.

Nested Schema for data

Read-Only:

  • allow_data_branching (Boolean) Whether seeding branches with data is enabled for all branches
  • at_backup_restore_branches_limit (Boolean) If the database has reached its backup restored branch limit
  • at_development_branch_usage_limit (Boolean) If the database has reached its development branch limit
  • automatic_migrations (Boolean) Whether to automatically manage Rails migrations during deploy requests.
  • branches_count (Number) The total number of database branches
  • branches_url (String) The URL to retrieve this database's branches via the API
  • created_at (String) When the database was created
  • data_import (Attributes) (see below for nested schema)
  • default_branch (String) The default branch for the database
  • default_branch_read_only_regions_count (Number) Number of read only regions in the default branch
  • default_branch_shard_count (Number) Number of shards in the default branch
  • default_branch_table_count (Number) Number of tables in the default branch schema
  • development_branches_count (Number) The total number of database development branches
  • foreign_keys_enabled (Boolean) Whether foreign key constraints are enabled
  • html_url (String) The URL to see this database's branches in the web UI
  • id (String) The ID of the database
  • insights_enabled (Boolean) True if query insights is enabled for the database
  • insights_raw_queries (Boolean) Whether raw SQL queries are collected
  • issues_count (Number) The total number of ongoing issues within a database
  • kind (String) The kind of database
  • migration_framework (String) Framework used for applying migrations.
  • migration_table_name (String) Table name to use for copying schema migration data.
  • multiple_admins_required_for_deletion (Boolean) If the database requires multiple admins for deletion
  • name (String) Name of the database
  • open_schema_recommendations_count (Number) The total number of schema recommendations
  • plan (String) The database plan
  • production_branch_web_console (Boolean) Whether web console is enabled for production branches
  • production_branches_count (Number) The total number of database production branches
  • ready (Boolean) If the database is ready to be used
  • region (Attributes) (see below for nested schema)
  • require_approval_for_deploy (Boolean) Whether an approval is required to deploy schema changes to this database
  • resize_queued (Boolean) True if a branch has a queued resize request
  • resizing (Boolean) True if a branch is currently resizing
  • restrict_branch_region (Boolean) Whether to restrict branch creation to one region
  • schema_last_updated_at (String) When the default branch schema was last changed.
  • sharded (Boolean) If the database is sharded
  • state (String) State of the database
  • updated_at (String) When the database was last updated
  • url (String) The URL to the database API endpoint

Nested Schema for data.data_import

Read-Only:

  • data_source (Attributes) (see below for nested schema)
  • finished_at (String) When the import finished
  • import_check_errors (String) Errors encountered during the import check
  • started_at (String) When the import started
  • state (String) State of the data import

Nested Schema for data.data_import.data_source

Read-Only:

  • database (String) Database name of the data source
  • hostname (String) Hostname of the data source
  • port (Number) Port of the data source

Nested Schema for data.region

Read-Only:

  • current_default (Boolean) True if the region is the default for new branch creation
  • display_name (String) Name of the region
  • enabled (Boolean) Whether or not the region is currently active
  • id (String) The ID of the region
  • location (String) Location of the region
  • mysql_supported (Boolean) Whether the region supports MySQL/Vitess databases
  • postgresql_supported (Boolean) Whether the region supports PostgreSQL databases
  • provider (String) Provider for the region (ex. AWS)
  • public_ip_addresses (List of String) Public IP addresses for the region
  • slug (String) The slug of the region