Manage databases from the CLI

Create, inspect, resize, start, stop and delete Square Cloud databases with squarecloud db, and print or rotate their TLS certificate and password.

squarecloud db manages the MongoDB, MySQL, PostgreSQL and Redis databases of your account. It also works as squarecloud database.

Databases have no configuration file, so [dbID] is either the ID you pass or, when you omit it in a terminal, a picker of your databases. Find IDs with squarecloud db list.

squarecloud db create

Usage

squarecloud db create --name <name> --memory <MB> --type <engine> --version <version> [--json]

Flag	Description
--name <name>	Database name, 1 to 32 characters.
--memory <MB>	Allocated memory in MB.
--type <engine>	mongo, mysql, redis or postgres.
--version <version>	Engine version: a major version, such as 17 for PostgreSQL or 8 for MongoDB, or a full version.

All four flags are required: without them, the command prints its help. Creating a database needs a Standard, Pro or Enterprise plan.

squarecloud db create --name my-db --memory 1024 --type postgres --version 17

Output

✓ Database my-db (<dbID>) created successfully
Save the password now: it is shown only once and cannot be recovered.
  PASSWORD: <password>
  URL: <connection URL>

The password is shown only once. db info doesn’t show it again; if you lose it, rotate it with db credentials reset password.

With --json, it prints the created database, password and connection URL included, as JSON.

squarecloud db list

Usage

squarecloud db list [--json]

Prints the name, ID, engine, memory and cluster of every database in your account.

squarecloud db info

Usage

squarecloud db info [dbID] [--json]

Shows the database ID, name, engine, memory, port, cluster, owner and creation date.

squarecloud db update

Usage

squarecloud db update [dbID] [--name <name>] [--memory <MB>]

Flag	Description
--name <name>	New database name.
--memory <MB>	New allocated memory in MB.

Renames the database or changes its memory. Pass at least one of the two flags: without them, the command prints its help.

squarecloud db update <dbID> --memory 2048

squarecloud db start

Usage

squarecloud db start [dbID]

Starts a stopped database. If it is already running, the CLI says so (It is already running.) and exits with code 0.

squarecloud db stop

Usage

squarecloud db stop [dbID]

Stops a running database. If it is already stopped, the CLI says so (It is already stopped.) and exits with code 0.

squarecloud db status

Usage

squarecloud db status [dbID] [--all] [--raw] [--json]

Flag	Description
--all	Shows every database instead of one: database ID, whether it is running, CPU and memory.
--raw	Prints the raw numeric stats as JSON instead of the table.

Prints the database ID, CPU usage, memory, disk and status.

squarecloud db metrics

Usage

squarecloud db metrics [dbID] [--json]

Prints the last 24 hours of the database’s CPU usage, RAM usage and network traffic, one row per 5-minute data point.

squarecloud db credentials certificate

Usage

squarecloud db credentials certificate [dbID]

Prints the database’s TLS certificate, which clients use to connect over TLS.

squarecloud db credentials certificate <dbID> > certificate.pem
# Saves the certificate to a file.

squarecloud db credentials reset

Usage

squarecloud db credentials reset <password|certificate> [dbID] [-y]

Flag	Description
-y, --yes	Skips the confirmation prompt.

Rotates the password or the TLS certificate, after a y/N confirmation. The old one stops working immediately, so update every client that uses it. A new password is printed once; after rotating the certificate, get the new one with db credentials certificate.

squarecloud db credentials reset password <dbID>

squarecloud db delete

Usage

squarecloud db delete [dbID] [-y]

Flag	Description
-y, --yes	Skips the confirmation prompt.

Deleting a database is permanent. To keep a copy of the data, run squarecloud db snapshot create --download first.

Asks Delete the database <dbID>? This action is irreversible [y/N] before deleting.

Related

Command	API	JavaScript SDK	VS Code
create	POST /v2/databases	api.databases.create()	Create database
list	GET /v2/users/me	api.account.me()	Databases section
info	GET .../{database_id}	api.databases.get()
update	PATCH .../{database_id}	api.databases.update()
start	POST .../start	api.databases.start()	Start
stop	POST .../stop	api.databases.stop()	Stop
status	GET .../status	api.databases.status()
status --all	GET /v2/databases/status	api.databases.statusAll()
metrics	GET .../metrics	api.databases.metrics()
credentials certificate	GET .../credentials/certificate	api.databases.certificate()	Download TLS certificate
credentials reset	POST .../credentials/reset	api.databases.resetCredentials()
delete	DELETE .../{database_id}	api.databases.delete()	Delete

Snapshots of databases are on Snapshots.