Skip to content

database_postgres.md

Latest commit

 

History

History
98 lines (78 loc) · 4.2 KB

database_postgres.md

File metadata and controls

98 lines (78 loc) · 4.2 KB
page_title planetscale_database_postgres Data Source - terraform-provider-planetscale
subcategory
description DatabasePostgres DataSource

planetscale_database_postgres (Data Source)

DatabasePostgres DataSource

Example Usage

data "planetscale_database_postgres" "my_databasepostgres" {
  id           = "...my_id..."
  organization = "...my_organization..."
}

Schema

Required

  • id (String) The ID of the database
  • organization (String) Organization name slug from list_organizations. Example: acme.

Read-Only

  • 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
  • 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
  • html_url (String) The URL to see this database's branches in the web UI
  • 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
  • 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_data (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.
  • 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_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_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 region_data

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
  • 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