doctl databases connection
Generated on 9 Apr 2025
from doctl version
v1.124.0
Usage
doctl databases connection <database-cluster-id> [flags]Aliases
connDescription
Retrieves the following connection details for a database cluster:
- A 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 value indicating if the connection should be made over SSL
While you can use these connection details, you can manually update the connection string’s parameters to change how you connect to the database, such using a private hostname, custom username, or a different database.
Example
The following example retrieves the connection details for a database cluster with the ID f81d4fae-7dec-11d0-a765-00a0c91e6bf6:
doctl databases connection f81d4fae-7dec-11d0-a765-00a0c91e6bf6Flags
| 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 |
--private |
Returns connection details that use the database’s VPC network connection. Default: false |
Related Commands
| 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: |
--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 |