doctl databases create

Go to Navigation


doctl databases create <name> [flags]




This command creates a database cluster with the specified name.

There are a number of flags that customize the configuration, all of which are optional. Without any flags set, a single-node, single-CPU PostgreSQL database cluster will be created.


Option Description
--engine The database engine to be used for the cluster. Possible values are: pg for PostgreSQL, mysql, redis, mongodb, and kafka.
Default: pg
--help , -h Help for this command
--num-nodes The number of nodes in the database cluster. Valid values are 1-3. In addition to the primary node, up to two standby nodes may be added for high availability.
Default: 1
--private-network-uuid The UUID of a VPC to create the database cluster in; the default VPC for the region will be used if excluded
--region The region where the database cluster will be created, e.g. nyc1 or sfo2
Default: nyc1
--restore-from-cluster-name The name of an existing database cluster from which the backup will be restored.
--restore-from-timestamp The timestamp of an existing database cluster backup in UTC combined date and time format (2006-01-02 15:04:05 +0000 UTC). The most recent backup will be used if excluded.
--size The size of the nodes in the database cluster, e.g. `db-s-1vcpu-1gb`` for a 1 CPU, 1GB node. For a list of available size slugs, visit:
Default: db-s-1vcpu-1gb
--tag Comma-separated list of tags to apply to the database cluster.
--version The database engine version, e.g. 14 for PostgreSQL version 14
--wait Boolean that specifies whether to wait for a database to complete before returning control to the terminal
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
  • 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
--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