doctl databases pool get

Go to Navigation


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




This command retrieves the following information about the specified connection pool for the specified database cluster:

  • The database user that the connection pool uses. When excluded, all connections to the database use the inbound user.
  • The connection pool’s name
  • The connection pool’s size
  • The database within the cluster that the connection pool connects to
  • The pool mode for the connection pool. Possible values: session, transaction, or statement
  • A connection string for the connection pool

You can get a list of existing connection pools by calling:

doctl databases pool list <database-cluster-id>

You can get a list of existing database clusters and their IDs by calling:

doctl databases list


The following example retrieves the details for a connection pool named example-pool and uses the --format flag to return only the pool’s name and connection string:

doctl databases pool get ca9f591d-fb58-5555-a0ef-1c02d1d1e352 example-pool --format Name,URI


Option Description
--format Columns for output in a comma-separated list. Possible values: User, Name, Size, Database, Mode, URI.
--help , -h Help for this command
--no-header Return raw data with no headers
Default: false
Command Description
doctl databases pool Display commands for managing connection pools

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