doctl databases replica list

Go to Navigation

Usage

doctl databases replica list <database-cluster-id> [flags]

Aliases

ls

Description

Lists the following details for read-only replicas for the specified database cluster.

  • The replica’s name
  • The region where the database cluster is located, such as nyc3, sfo2
  • The replica’s status. Possible values: forking and active

This command requires the ID of a database cluster, which you can retrieve by calling:

doctl databases list

Example

The following example retrieves a list of read-only replicas for a database cluster with the ID ca9f591d-f38h-5555-a0ef-1c02d1d1e35 and uses the --format flag to return only the ID and URI for each replica:

doctl databases replica list ca9f591d-f38h-5555-a0ef-1c02d1d1e35 --format ID,URI

Flags

Option Description
--format Columns for output in a comma-separated list. Possible values: Name, ID, Region, Status, URI, Created.
--help , -h Help for this command
--no-header Return raw data with no headers
Default: false
Command Description
doctl databases replica Display commands to manage read-only database replicas

Global Flags

Option Description
--access-token, -t API V2 access token
--api-url, -u Override default API endpoint
--config, -c Specify a custom config file
Default:
  • macOS: ${HOME}/Library/Application Support/doctl/config.yaml
  • Linux: ${XDG_CONFIG_HOME}/doctl/config.yaml
  • Windows: %APPDATA%\doctl\config.yaml
--context Specify a custom authentication context name
--http-retry-max Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5
--http-retry-wait-max Set the minimum number of seconds to wait before retrying a failed request
Default: 30
--http-retry-wait-min Set the maximum number of seconds to wait before retrying a failed request
Default: 1
--interactive Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false
--output, -o Desired output format [text|json]
Default: text
--trace Show a log of network activity while performing a command
Default: false
--verbose, -v Enable verbose output
Default: false