doctl databases connection

Generated on 17 January 2023 from doctl v1.92.0 ( 31aa0f4 )

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

Option	Description
`--format`	Columns for output in a comma-separated list. Possible values: ```URI`,` Database`,` Host`,` Port`,` User`,` Password`,` SSL`.
`--help` , `-h`	Help for this command
`--no-header`	Return raw data with no headers Default: `false`

Command	Description
doctl databases	Display commands that manage databases

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