planetscalepostgresbranch_roles (Data Source)

June 1, 2026 ยท View on GitHub

PostgresBranchRoles DataSource

Example Usage

data "planetscale_postgres_branch_roles" "my_postgresbranchroles" {
  branch       = "...my_branch..."
  database     = "...my_database..."
  organization = "...my_organization..."
}

Schema

Required

  • branch (String) Branch name from list_branches. Example: main.
  • database (String) Database name slug from list_databases. Example: app-db.
  • organization (String) Organization name slug from list_organizations. Example: acme.

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:

  • access_host_url (String) The database connection string
  • actor (Attributes) (see below for nested schema)
  • base_username (String) The base username without branch routing suffix
  • branch (Attributes) (see below for nested schema)
  • created_at (String) When the role was created
  • database_name (String) The database name
  • default (Boolean) Whether the role is the default postgres user
  • deleted_at (String) When the role was deleted
  • disabled_at (String) When the role was disabled
  • drop_failed (String) Error message available when dropping the role fails
  • dropped_at (String) When the role was dropped
  • expired (Boolean) True if the credentials are expired
  • expires_at (String) When the role expires
  • id (String) The ID of the role
  • inherited_roles (Set of String) Database roles these credentials inherit
  • name (String) The name of the role
  • password (String) The plain text password, available only after create
  • private_access_host_url (String) The database connection string for private connections
  • private_connection_service_name (String) The service name to set up private connectivity
  • query_safety_settings (Attributes) (see below for nested schema)
  • ttl (Number) Number of seconds before the credentials expire
  • updated_at (String) When the role was updated
  • username (String) The database user name

Nested Schema for data.actor

Read-Only:

  • avatar_url (String) The URL of the actor's avatar
  • display_name (String) The name of the actor
  • id (String) The ID of the actor

Nested Schema for data.branch

Read-Only:

  • created_at (String) When the resource was created
  • deleted_at (String) When the resource was deleted, if deleted
  • id (String) The ID for the resource
  • name (String) The name for the resource
  • updated_at (String) When the resource was last updated

Nested Schema for data.query_safety_settings

Read-Only:

  • require_where_on_delete (String) Require WHERE clause on DELETE statements
  • require_where_on_update (String) Require WHERE clause on UPDATE statements