Skip to main content
A Symplax database runs as its own container on one of your servers, next to your apps. Symplax generates the credentials, keeps the data on a persistent volume, and gives you a connection string to use.

​
Engines and versions

You choose the version when you create the database, and you cannot change it afterwards. A newer engine version refuses an older data directory, so moving to a new version means creating a new database and moving your data across.
PostgreSQL 18 and MySQL 9 need server agent 2.1.46 or newer. If your server runs an older agent, Symplax refuses to create them and tells you to update the agent or pick an older version.

​
Create a database

1

Open Databases

Click Databases in the sidebar, then Add Database.
2

Fill in the form

  • Database name: a name for the database, for example my-database.
  • Server: the server the database runs on. Pick the server your app runs on.
  • Engine and Version.
  • Inject into app (optional): an app that should get the connection string. See Attach a database to an app.
3

Create it

Click Create Database. Symplax pulls the image, creates the container and runs health checks. The database shows as Running when it is ready.
You do not set a username or password. Symplax generates a random password for every database and stores it encrypted.

​
Where your data lives

Each database keeps its data on a Docker volume on your server. The data survives restarts of the container and of the server. Stopping a database from Settings keeps all of its data, and Start Database brings it back. Delete Database in Settings removes the container and its volume. This deletes all of the data and cannot be undone. Take a backup and download it first if you might need it.

​
Connection details

Open a database to see Connection Details on its Overview tab: host, port, database name, username and password, plus two connection URLs.
  • APP URL (internal): use this inside an app deployed on the same server. It points at the database’s container name on Symplax’s private network, so it only works from that server.
  • URL: the public connection string, for your laptop or tools like TablePlus, pgAdmin or DBeaver. It appears only while public access is on, because the port is closed to the internet otherwise.
Do not use the public URL inside an app on the same server. Apps on that server cannot reach the database through the server’s public IP. Use the internal URL instead.
Quick Connect on the same tab shows ready-to-copy snippets for common clients, such as Prisma, pg, psycopg2 and ioredis.

​
Who can see the password

The password and both connection URLs are shown only to:
  • the owner of the workspace,
  • team admins,
  • the person who created the database, while their role still lets them manage it.
Everyone else with access to the database sees the host, port and database name, and can still use the database through the dashboard. API keys need the secrets:read scope to read a password.

​
Attach a database to an app

Symplax can write the connection string into an app’s environment variables for you. In the database’s Overview tab, find Linked Apps, select the app and click Inject. You can also pick the app in Inject into app when you create the database. The variable name depends on the engine: If the app is on the same server as the database, it gets the internal URL. If it is on a different server, it gets the public URL, and you need to turn on public access for the app to connect.
Injecting overwrites a variable with the same name if the app already has one. Redeploy the app afterwards so it picks up the new value.

​
How many databases you can have

The limit counts every database you have created, across all your servers. Deleting a database frees its slot. See Plans for everything else each plan includes.

​
Next steps

Console

Browse tables, keys and documents from the dashboard.

Backups

Back up on demand or on a schedule, and restore.

Public access

Connect from your laptop or another host.