doctl databases get

Generated on 6 October 2021 from doctl v1.65.0 (ab70dba)
Go to Navigation

Usage

doctl databases get <database-id> [flags]

Aliases

g

Description

This command retrieves the following details about the specified database cluster:

  • The database ID, in UUID format
  • The name you gave the database cluster
  • The database engine (e.g. redis, pg, mysql)
  • The engine version (e.g. 11 for PostgreSQL version 11)
  • The number of nodes in the database cluster
  • The region the database cluster resides in (e.g. sfo2, nyc1)
  • The current status of the database cluster (e.g. online)
  • The size of the machine running the database instance (e.g. db-s-1vcpu-1gb)
  • A connection string for the database cluster
  • The date and time when the database cluster was created

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: ID, Name, Engine, Version, NumNodes, Region, Status, Size, URI, Created
--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
Control Panel Blog Pricing Careers Terms Privacy Status API Docs Tutorials Support