LinuxCommandLibrary

doctl-databases-options

Show available DigitalOcean database options

TLDR

Run a doctl databases options command with an access token

$ doctl [[d|databases]] [[o|options]] [command] [[-t|--access-token]] [access_token]
copy

Retrieve a list of the available database engines
$ doctl [[d|databases]] [[o|options]] [[eng|engines]]
copy

Retrieve a list of the available regions for a given database engine
$ doctl [[d|databases]] [[o|options]] [[r|regions]] --engine [pg|mysql|redis|mongodb]
copy

Retrieve a list of the available slugs for a given database engine
$ doctl [[d|databases]] [[o|options]] [[s|slugs]] --engine [pg|mysql|redis|mongodb]
copy

Retrieve a list of the available versions for a given database engine
$ doctl [[d|databases]] [[o|options]] [[v|versions]] --engine [pg|mysql|redis|mongodb]
copy

SYNOPSIS

doctl databases options <cluster-id> [--format <format>] [--no-header] [--verbose]

PARAMETERS

<cluster-id>
    ID of the target database cluster (required positional argument)

--format <format>
    Output columns/format: normal, json, or custom like id,name,value-type (default: normal)

--no-header
    Suppress column headers in tabular output

--verbose
    Enable verbose logging for debugging

DESCRIPTION

The doctl databases options command retrieves and displays the configurable options available for a specific DigitalOcean Managed Database cluster. These options include settings like node count adjustments, version upgrades, trusted sources for connections, maintenance windows, and performance tuning parameters specific to the database engine (e.g., PostgreSQL, MySQL). It helps administrators inspect current values, defaults, allowed ranges, and types before applying changes via other doctl databases subcommands.

This is part of the doctl CLI tool for interacting with DigitalOcean's API, enabling scripted management of cloud resources. Output is tabular by default, showing columns for option ID, name, value type, default, current value, allowed values, and type. Useful for DevOps workflows, compliance checks, and optimization.

CAVEATS

Requires DigitalOcean API token via DO_API_TOKEN env var or doctl auth init. Cluster must exist and user have access. Not all options are editable; some are read-only.

EXAMPLE

$ doctl databases options 9cc5f1e6-5c91-44b8-9e4e-8f59bb3cc6b3
Shows table with options like maintenance_dow, nodes.

JSON OUTPUT

Use --format json for parsing in scripts:
doctl databases options <id> --format json | jq '.[] | select(.name=="nodes")'

HISTORY

Introduced in doctl v1.9.0 (2019) with Managed Databases support; evolved with API v2 features for engine-specific options.

SEE ALSO

doctl(1), doctl-databases(1), doctl-databases-clusters-list(1), doctl-databases-options-update(1)

Copied to clipboard