Quassel IRC

h1. PostgreSQL

This article describes how you can use Quassel with the PostgreSQL database. It is written from a FreeBSD point of view, but the process should be very similar for any other system out there. 

This appeared in Quassel release 0.5.0.  Using PostgreSQL 9.2 is strongly recommended, otherwise Quassel's prepared statements will have very poor performance, which as the database grows will cause timeouts and make it impossible to connect to the core (see #680 and the maintenance section below).

h2. Requirements

 * PostgreSQL server version 8.3 or greater (version 9.2 or greater strongly recommended)

 * Qt PostgreSQL client libraries (libqt4-sql-psql or libqt5sql5-psql (quassel 0.12.2 and newer) on Debian/Ubuntu, qt4-psql on FreeBSD)

h2. Preparing the database

We will assume you installed PostgreSQL and properly ran the initdb script.

Login using the database account (in my case postgres)

> <pre>$ sudo -u postgres psql</pre>

Now let's create the quassel database and assign an account.

> <pre>postgres=# CREATE USER quassel ENCRYPTED PASSWORD 'somepassword';

CREATE ROLE

postgres=# CREATE DATABASE quassel WITH OWNER quassel ENCODING 'UTF8';

CREATE DATABASE

</pre>

h3. Gentoo specific

Read http://www.gentoo.org/doc/en/postgres-howto.xml if no postgresql-server is installed.

To create an user and a database, just use the following:

<pre>createuser -A -D -P -E -U postgres -W quassel

createdb -U postgres -O quassel -E UTF8 quassel</pre>

h2. Setting up the Quassel Core

Now that the database is running properly, we are going to tell Quassel to use the correct backend.

Use one of the two steps below and you're done!

h3. For a new core

Just connect to the core using a Quassel Client to launch the first run wizard. Select the PostgreSQL backend in the dropdown list and fill in the needed credentials to connect to the Postgres DB you just created.

h3. To migrate an existing core

Make sure the core is not running and then execute the following:

> <pre>$ quasselcore --select-backend=PostgreSQL</pre>

An interactive script will request the necessary information to migrate successfully. localhost can be replaced by /var/run/postgresql (Debian/Ubuntu FHS-compliant location) to use UNIX domain sockets and, if ident is enabled in pg_hba.conf, uid-based authentication.

If your existing database and config file are in a different location than the default then you need to specify the --configdir= parameter as well as the --select-backend= .

For example Ubuntu puts the config dir in /var/lib/quassel so the command for a proper migration would be:

> <pre>$ quasselcore --configdir=/var/lib/quassel --select-backend=PostgreSQL</pre>

If your migration stops with the following message then you probably forgot the --configdir= parameter

<pre> 2010-02-23 18:01:36 Info: PostgreSQL Storage Backend is ready. Quassel Schema Version: 14                                                                                       

Switched backend to: PostgreSQL                                                         

No currently active backend. Skipping migration.                                        

New backend does not support migration: PostgreSQL                                      

Add a new user:                                                                         

Username:</pre>

h2. Troubleshooting

If your migration fails with a message like this

<pre>

  Error Number: -1

  Error Message: "ERROR:  insert or update on table "backlog" violates foreign key constraint "backlog_bufferid_fkey"

DETAIL:  Key (bufferid)=(855) is not present in table "buffer".

QPSQL: Unable to create query"

</pre>

your SQLite DB probably contains leftovers from e.g. a deleted network. Make sure you have a backup and try to clean the invalid data sets from the database by issuing

<pre>

$ sqlite3 quassel-storage.sqlite 

sqlite> delete from buffer where bufferid in (select b.bufferid from buffer b left join network n using (networkid) where n.networkid is null);

sqlite> delete from backlog where messageid in (select bl.messageid from backlog bl left join buffer b using (bufferid) where b.bufferid is null);

</pre>

If your migration fails with a message like this

<pre>

("QSQLITE")

2016-01-02 03:27:49 Info: SQLite Storage Backend is ready. Quassel Schema Version: 18

("QSQLITE")

Core::selectBackend(): unsupported backend: PostgreSQL

    supported backends are: SQLite

</pre>

you've probably forgotten to install the Postgres adapter library package mentioned in the requirements above.

h3. Restarting migration

If you have to restart your migration you'll likely get this error:

<pre>

Backend already initialized. Skipping Migration

</pre>

To fix that you have to drop the quassel databse and start over:

First switch back to SQLite:

<pre> quasselcore --configdir=/var/lib/quassel --select-backend=SQLite</pre>

Then DROP the PostgreSQL Quassel database:

<pre>

$ sudo -u postgres psql

DROP DATABASE quassel;

</pre>

And then start over with recreating the database as described above.

h2. Migrating core to a new server

Install core on the new server.

Shutdown old core and new cores.

Dump old database without exporting credentials. In this example db is called quassel:

<pre>pg_dump --clean --no-owner --no-acl --file=quassel-dump.sql quassel</pre>

Copy SQL dump to the new server:

<pre>scp -C -o CompressionLevel=9 quassel-dump.sql user@newserver.com:~</pre>

Import dump on the new server:

<pre>psql -d dbname -U user  -h db1.server.com < quassel-dump.sql</pre>

Run --select-backend on the new server. You'll get compltain:

<pre>Backend already initialized. Skipping Migration</pre>

... don't care about ti.

You also might want to reset the password of your quassel user. 

<pre>./quasselcore-static-0.8.0 --change-userpass=quasseluser</pre>

Then start quasselcore on the new server and everything should be intact. You might need to reconfigure IRC servers.

h1. PostgreSQL performance and maintenance

You need PostgreSQL 9.2 (or newer) which fixes an issue with the performance of prepared statements.  Ubuntu/Debian users can use "these instructions":https://wiki.postgresql.org/wiki/Apt#PostgreSQL_packages_for_Debian_and_Ubuntu and run pg_upgradecluster to migrate existing data.

<pre>

\timing on

SET maintenance_work_mem = '512MB';  -- temporarily give all your free ram to PostgreSQL

VACUUM ANALYZE;

CLUSTER backlog USING backlog_bufferid_idx;

VACUUM ANALYZE;

ALTER ROLE quassel SET random_page_cost TO DEFAULT;

ALTER ROLE quassel SET work_mem TO '16MB';

\drds

</pre>

The CLUSTER and ANALYSE operations will take effect immediately, the settings changes for the quassel user will take effect the next time quasselcore or postgresql is restarted.