Database Setup

To prepare an empty PostgreSQL database for a Sirveo deployment, follow these steps.

1. Create a login role:

   CREATE ROLE sirveo_app
     WITH PASSWORD 'superSecret' LOGIN;

2. Create a new database, owned by the new role:

   CREATE DATABASE sirveo_db
     WITH OWNER sirveo_app;

When the server starts, database schema creation is performed automatically. When upgrading to a new release, database modifications - if required - are also applied automatically when the server is restarted.

The server’s database credentials should provide sufficient privileges for creating and modifying database objects. Otherwise, no special database configuration is needed.

Note

When downgrading a Sirveo binary to a previous release which used an earlier database schema revision, the Server will not automatically downgrade its database schema.

This is by design, as doing so might require dropping tables and columns, which would result in likely data loss.

In such scenarios, to explicitly downgrade a database schema, follow the 4 steps detailed in this command:

sirveo dump-db-migrations --help

Note

It is possible, but not generally recommended, to manually manage a Sirveo server’s database schema. The binary contains a utility that provides all forward and backward schema modifications. See:

sirveo dump-db-migrations --help