dokploy_database
Create, manage, and control databases (Postgres, MySQL, MariaDB, MongoDB, Redis, LibSQL) with actions for deployment, environment variables, status changes, and port configuration.
Instructions
Manage databases (postgres/mysql/mariadb/mongo/redis/libsql). create: dbType+name+environmentId+databasePassword. Per-engine extras — postgres/mysql/mariadb: REQUIRE databaseName+databaseUser; mysql/mariadb also accept databaseRootPassword. mongo: REQUIRES databaseUser (databaseName not used). redis: only databasePassword (no databaseName/User). libsql: REQUIRES appName+dockerImage+sqldNode (primary|replica); accepts sqldPrimaryUrl+enableNamespaces. get: dbType+databaseId (returns metadata + masked env summary — never values). update: dbType+databaseId+fields. move: dbType+databaseId+targetEnvironmentId. start/stop/deploy/rebuild/remove: dbType+databaseId. reload: dbType+databaseId+appName. changeStatus: dbType+databaseId+applicationStatus (idle|running|done|error). saveEnvironment: dbType+databaseId+env (full replace). setEnvVars: dbType+databaseId + set?/unset? (merge inside the server, masked confirmation only). getEnvKeys: dbType+databaseId — KEY names only. getEnvValuesUnsafe: dbType+databaseId — UNSAFE escape hatch that returns full KEY=VALUE pairs. saveExternalPort: dbType+databaseId+externalPort (libsql also accepts externalGRPCPort/externalAdminPort).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| env | No | Environment variables as KEY=VALUE pairs, one per line. Used by saveEnvironment (full replace). | |
| set | No | setEnvVars: KEY=VALUE pairs to upsert, one per line. | |
| name | No | ||
| unset | No | setEnvVars: list of KEY names to remove. | |
| action | Yes | ||
| dbType | Yes | postgres, mysql, mariadb, mongo, redis, or libsql | |
| appName | No | ||
| command | No | ||
| cpuLimit | No | ||
| serverId | No | ||
| sqldNode | No | libsql sqld role | |
| databaseId | No | ||
| description | No | ||
| dockerImage | No | ||
| memoryLimit | No | ||
| databaseName | No | ||
| databaseUser | No | ||
| externalPort | No | ||
| environmentId | No | ||
| sqldPrimaryUrl | No | libsql replica primary URL | |
| databasePassword | No | ||
| enableNamespaces | No | libsql multi-tenant namespaces | |
| externalGRPCPort | No | libsql only | |
| applicationStatus | No | ||
| externalAdminPort | No | libsql only | |
| targetEnvironmentId | No | ||
| databaseRootPassword | No | mysql/mariadb only |