doctl-databases-options
Show available DigitalOcean database options
TLDR
Run a doctl databases options command with an access token
Retrieve a list of the available database engines
Retrieve a list of the available regions for a given database engine
Retrieve a list of the available slugs for a given database engine
Retrieve a list of the available versions for a given database engine
SYNOPSIS
doctl databases options [flags]
PARAMETERS
-h, --help
Displays help information for the options subcommand.
DESCRIPTION
The doctl databases options command retrieves a comprehensive list of all available configuration options for creating DigitalOcean Managed Databases. This includes details on supported database engines (e.g., PostgreSQL, MySQL, Redis, MongoDB) and their available versions, default versions, connection limits, and supported storage sizes. It also provides information on DigitalOcean regions where managed databases can be deployed, including their availability and supported features. Furthermore, it lists the various database cluster sizes (plans) available, detailing their CPU, RAM, disk space, and pricing information. This command is crucial for users needing to programmatically or interactively determine valid parameters before provisioning a new database cluster.
CAVEATS
Requires the DigitalOcean command-line client (doctl) to be installed and properly authenticated with a DigitalOcean API token. The output is always in JSON format, which can be parsed by other tools or scripts. The specific options (e.g., engine versions, regions, sizes) are dynamic and reflect DigitalOcean's current offerings, thus may change over time.
OUTPUT STRUCTURE
The command's output is a JSON object containing three primary keys:
- engines: Provides details for each supported database engine (e.g., PostgreSQL, MySQL, Redis, MongoDB), including available versions, default version, connection limits per plan, and supported storage sizes.
- regions: Lists DigitalOcean regions where managed databases can be deployed, along with their slug, name, availability, and supported features (i.e., which database engines are available in that region).
- sizes: Describes the different database cluster plans (sizes), detailing their CPU cores, RAM, disk space, and hourly/monthly pricing. Each size also indicates its storage and CPU tier.
HISTORY
The doctl command-line tool, developed by DigitalOcean, has evolved significantly since its initial release to support an expanding range of DigitalOcean services. The databases subcommand, and specifically the options command, was introduced to provide programmatic access to the dynamic configuration choices available for Managed Databases, simplifying automation and scripting of database provisioning.
SEE ALSO
doctl databases create, doctl databases list, doctl databases get, doctl(1) (DigitalOcean CLI)