doctl databases replica get

Go to Navigation

Usage

doctl databases replica get <database-id> <replica-name> [flags]

Aliases

g

Description

Gets the following details for the specified read-only replica for the specified database cluster:

  • The name of the replica
  • Information required to connect to the read-only replica
  • The region where the database cluster is located (e.g. nyc3, sfo2)
  • The status of the replica (possible values are creating, forking, or active)
  • A time value given in ISO8601 combined date and time format that represents when the read-only replica was created.

This command requires that you pass in the replica’s name, which you can retrieve by querying a database ID:

doctl databases replica list ca9f591d-5555-5555-a0ef-1c02d1d1e352

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

doctl databases list

Flags

OptionDescription
--formatColumns for output in a comma-separated list. Possible values: Name, Region, Status, URI, Created
--help, -hHelp for this command
--no-headerReturn raw data with no headers
Default: false
CommandDescription
doctl databases replicaDisplay commands to manage read-only database replicas

Global Flags

OptionDescription
--access-token, -tAPI V2 access token
--api-url, -uOverride default API endpoint
--config, -cSpecify 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
--contextSpecify a custom authentication context name
--output, -oDesired output format [text|json]
Default: text
--traceShow a log of network activity while performing a command
Default: false
--verbose, -vEnable verbose output
Default: false