This document will go over the key points of migrating and setting up Postgres support in Whisparr.
This guide was been created by the amazing Roxedus.
Postgres databases are NOT backed up by Whisparr, any backups must be implemented and maintained by the user
First, we need a Postgres instance. This guide is written for usage of the
postgres:14 Docker image.
Do not even think about using the
docker create --name=postgres14 \ -e POSTGRES_PASSWORD=qstick \ -e POSTGRES_USER=qstick \ -e POSTGRES_DB=whisparr-main \ -p 5432:5432/tcp \ -v /path/to/appdata/postgres14:/var/lib/postgresql/data \ postgres:14
Whisparr needs two databases, the default names of these are:
whisparr-mainThis is used to store all configuration and history
whisparr-logThis is used to store events that produce a logentry
Whisparr will not create the databases for you. Make sure you create them ahead of time
You can give the databases any name you want but make sure
config.xml file has the correct names. For further information see schema creation.
We need to tell Whisparr to use Postgres. The
config.xml should already be populated with the entries we need:
<PostgresUser>qstick</PostgresUser> <PostgresPassword>qstick</PostgresPassword> <PostgresPort>5432</PostgresPort> <PostgresHost>postgres14</PostgresHost>
If you want to specify a database name then should also include the following configuration:
Only after creating both databases you can start the Whisparr migration from SQLite to Postgres.
If you do not want to migrate a existing SQLite database to Postgres then you are already finished with this guide!
To migrate data we can use PGLoader. It does, however, have some gotchas:
--with "quote identifiers"to make them sensitive.
Do not drop any tables in the Postgres instance
Before starting a migration please ensure that you have run Whisparr against the created Postgres databases at least once successfully. Begin the migration by doing the following:
Open your preferred database management tool and connect to the Postgres database instance
Run the following commands:
DELETE FROM "Profiles"
DELETE FROM "QualityDefinitions"
DELETE FROM "DelayProfiles"
Start the migration by using either of these options:
pgloader --with "quote identifiers" --with "data only" whisparr.db 'postgresql://qstick:qstick@localhost/whisparr-main'
docker run -v /absolute/path/to/whisparr.db:/whisparr.db --network=host ghcr.io/roxedus/pgloader --with "quote identifiers" --with "data only" /whisparr.db "postgresql://qstick:qstick@localhost/whisparr-main"
With these handled, it is pretty straightforward after telling it to not mess with the scheme using
--with "data only"