doctl databases connection

Go to Navigation

Usage

doctl databases connection <database-id> [flags]

Aliases

conn

Description

This command retrieves the following connection details for a database cluster:

  • The connection string for the database cluster
  • The default database name
  • The fully-qualified domain name of the publicly-connectable host
  • The port on which the database is listening for connections
  • The default username
  • The randomly-generated password for the default username
  • A boolean indicating if the connection should be made over SSL

While these connection details will work, you may wish to use different connection details, such as the private hostname, a custom username, or a different database.

Flags

OptionDescription
--formatColumns for output in a comma-separated list. Possible values: URI, Database, Host, Port, User, Password, SSL
--help, -hHelp for this command
--no-headerReturn raw data with no headers
Default: false
CommandDescription
doctl databasesDisplay commands that manage databases

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