Databases

A managed database on one of your servers: Postgres, MySQL, MariaDB, MongoDB, Redis or ClickHouse. Deplo creates it, gives you a connection string, and handles backups, logs, metrics and a console.

A database is created like an app, on the server you pick, as a stack named db-<slug>. The slug is generated from the name at creation and never changes. The database joins the network of its environment, so the apps there reach it by name.

Images are the official ones: postgres:<v>-alpine, mysql:<v>, mariadb:<v>, mongo:<v>, redis:<v>-alpine and clickhouse/clickhouse-server:<v>.

Credentials are encrypted and masked. Revealing them needs reveal_secrets.

Create oneCopy Anchor Link

Open DatabasesCopy Anchor Link

Open Storage, then the Databases tab.

New databaseCopy Anchor Link

Click New Database.

Pick the engineCopy Anchor Link

Pick the engine and the Version.

Name itCopy Anchor Link

Name it.

Set the passwordCopy Anchor Link

Use Generate unless you need a specific password.

Pick the serverCopy Anchor Link

Pick the server.

Pick the environmentCopy Anchor Link

Pick the Environment where the apps that will use it live. Leave No environment if your apps are not in a project.

Optional: host portCopy Anchor Link

Set a Host port only if something outside the server needs it. This needs the canExposePorts grant. You can also turn it on later.

Create itCopy Anchor Link

Click Create database.

Then copy the connection string into the app that needs it, as an environment variable of type Secret.

Connect an app to itCopy Anchor Link

An app reaches a database in the same environment and on the same server by name. No port, firewall rule or IP is needed.

DATABASE_URL = postgres://appuser:••••••@db-orders:5432/orders

Set it in the app's Environment tab as a Secret, then redeploy.

In a Compose app every service reaches it. Exceptions: a service with internal: true, one using network_mode:, and one named after Deplo's own infrastructure. See Compose apps.

The overviewCopy Anchor Link

Connection holds the connection string (click to reveal, needs reveal_secrets), the engine and version, the username, the database name and the server.

Networking holds the Environment and the two addresses:

Wrong environment? Use Move to environment in the card menu of the database list.

The switch on the Public row and the Host port field publish the database. This needs configure_databases and the canExposePorts grant.

The three tiles are Health (healthcheck, uptime, restarts), Data (disk and memory use) and Backups (last run and schedule). Data shows - when the server's agent is too old.

Actions, and which ones delete dataCopy Anchor Link

Delete is refused until the host confirms the container and the volume are gone. If the host is permanently gone, a force option appears.

SettingsCopy Anchor Link

Settings -> Connection has the exposure controls and password rotation.

For Redis and ClickHouse, rotating the password recreates the container.

Settings -> Advanced

Redis and --requirepass: the default command contains the password. A custom command without it removes authentication.

Config files are how you set postgresql.conf, my.cnf, redis.conf or an init script. Save and apply writes them and restarts the container.

Move a database to another serverCopy Anchor Link

Settings -> General, then Move on the Server card. Deplo stops the database, copies the data to the new server, and starts it there. The card appears only when you have more than one server.

If the copy fails, the database is blocked from starting until you fix it. This protects your data from being replaced by an empty database.

Move a database to another teamCopy Anchor Link

Settings -> Advanced -> Danger Zone -> Transfer, or Transfer to another team in the card menu. It needs move_databases in both teams.

The data, the host db-<slug> and the connection string stay the same. It lands at the new team's top level and restarts once. Backup schedules and cron jobs are removed, and apps of the old team stop reaching it: the dialog names them. Everything the move costs ->

The other tabsCopy Anchor Link

Logs, Monitoring and Backups work like for an app. Console opens the engine's own shell (psql, mysql, redis-cli) after a one-time confirmation. Cron jobs runs scheduled commands inside the container.

Good to knowCopy Anchor Link

• The username and the database name never change. Renaming the database only changes its label.
• Redeploy and Rebuild do not work while the database is provisioning.
• An app's backup schedule does not cover its database. Schedule both.
• Host port opens the database to anything that can reach the server.
• Capabilities: control_databases for start, stop and restart, configure_databases for settings, delete_databases for Rebuild and Delete, move_databases to hand it to another team.
• Version upgrades are not migrations. A major Postgres upgrade refuses to start on older data. Dump, rebuild, restore.

TroubleshootingCopy Anchor Link

More in Databases and backups.

Next stepsCopy Anchor Link