Administrative tasks
====================

Administrative tasks are handled by the command-line interface. To get a quick
overview of available commands, run:

.. code-block:: console

   $ hircine -h

Updating the application
------------------------

To update **hircine**, download the newest wheel and install it in the virtual
environment:

.. code-block:: console

   $ source <VENVDIR>/bin/activate
   (.venv) $ python -m pip install <WHEEL>

Running database migrations
^^^^^^^^^^^^^^^^^^^^^^^^^^^

After the update it might be required to bring the database up-to-date. To do
this, run:

.. code-block:: console

   $ hircine migrate

A backup will be created automatically.

Backing up the database
-----------------------

To save a current backup of the database into the ``backup/`` directory, run:

.. code-block:: console

   $ hircine backup

To restore a previously saved backup, stop **hircine** and simply replace the
``hircine.db`` file with the backup.

Optimizing the database
-----------------------

To optimize the SQLite database, run:

.. code-block:: console

   $ hircine vacuum

This is generally only recommended after deleting a large amount of data. Refer
to the `SQLite documentation
<https://www.sqlite.org/lang_vacuum.html#description>`_ for details on this
process.