Skip to main content

Overview

Manage databases within your Qovery environment.

Commands

List Databases

List all databases in current environment:
qovery database list
Show credentials in the output:
qovery database list --show-credentials
Flags:
FlagDescription
--organizationOrganization Name
--projectProject Name
--environmentEnvironment Name
--show-credentialsShow Credentials
--jsonJSON output

Deploy Database

Deploy or start a database:
qovery database deploy --database "my-db"
Deploy multiple databases at once:
qovery database deploy --databases "db1,db2"
Flags:
FlagShortDescription
--database-nDatabase Name
--databasesDatabase Names (comma separated)
--watch-wWatch database status until it’s ready or an error occurs
--organizationOrganization Name
--projectProject Name
--environmentEnvironment Name

Redeploy Database

Redeploy an existing database:
qovery database redeploy --database "my-db"
Flags:
FlagShortDescription
--database-nDatabase Name (required)
--watch-wWatch database status until it’s ready or an error occurs
--organizationOrganization Name
--projectProject Name
--environmentEnvironment Name

Stop Database

Stop a running database:
qovery database stop --database "my-db"
Stop multiple databases at once:
qovery database stop --databases "db1,db2"
Flags:
FlagShortDescription
--database-nDatabase Name
--databasesDatabase Names (comma separated)
--watch-wWatch database status until it’s ready or an error occurs
--organizationOrganization Name
--projectProject Name
--environmentEnvironment Name

Cancel Deployment

Cancel a database deployment:
qovery database cancel
Use qovery environment cancel to cancel a database deployment.

Delete Database

Delete a database:
qovery database delete --database "my-db"
Delete multiple databases at once:
qovery database delete --databases "db1,db2"
Deleting a database will permanently delete all data. Make sure you have backups before proceeding.
Flags:
FlagShortDescription
--database-nDatabase Name
--databasesDatabase Names (comma separated)
--watch-wWatch database status until it’s ready or an error occurs
--organizationOrganization Name
--projectProject Name
--environmentEnvironment Name

Examples

Deploy Database

# Set context
qovery context set

# List available databases
qovery database list

# Deploy database
qovery database deploy --database "postgres-main"

# Watch deployment status
qovery database deploy --database "postgres-main" --watch

Stop Database for Maintenance

# Stop database
qovery database stop --database "postgres-main"

# Perform maintenance...

# Restart database
qovery database deploy --database "postgres-main"

List Databases with Credentials

qovery database list --show-credentials

List Databases as JSON

qovery database list --json