kallithea Files · docs/dev/dbmigrations.rst

Files @ df5a67678b96

Branch filter:

Location: kallithea/docs/dev/dbmigrations.rst

df5a67678b96 2.9 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

mads

celeryd: let the gearbox command use db session as most other gearbox commands do

304aae43194c changed the common gearbox wrapper so make_app_without_logging
only was run for commands tagged as requires_db_session. That broke celeryd -
even a plain 'gearbox celeryd -c my.ini' would fail on the safety check in
celerypylons asserting on tg.config having 'celery.imports' configuration.

The gearbox celeryd command did not really require a db session - it just
required app configuration so it could create db sessions on the fly.

To to get the missing make_app_without_logging invocation back, set
requires_db_session (the default for our gearbox commands).

requires_db_session not only calls make_app_without_logging (which undo the
effect from 304aae43194c), it also calls setup_cache_regions,
engine_from_config, and init_model. These were also invoked explicitly in
celeryd code - these double invocations are dropped too.

Also, make_app_without_logging will call into tg and thus invoke the
setup_configuration hook which will set kallithea.CELERY_ON and call
load_rcextensions. The celeryd code for doing that is thus dropped.

=======================
Database schema changes
=======================

Kallithea uses Alembic for :ref:`database migrations <upgrade_db>`
(upgrades and downgrades).

If you are developing a Kallithea feature that requires database schema
changes, you should make a matching Alembic database migration script:

1. :ref:`Create a Kallithea configuration and database <setup>` for testing
   the migration script, or use existing ``development.ini`` setup.

   Ensure that this database is up to date with the latest database
   schema *before* the changes you're currently developing. (Do not
   create the database while your new schema changes are applied.)

2. Create a separate throwaway configuration for iterating on the actual
   database changes::

    gearbox make-config temp.ini

   Edit the file to change database settings. SQLite is typically fine,
   but make sure to change the path to e.g. ``temp.db``, to avoid
   clobbering any existing database file.

3. Make your code changes (including database schema changes in ``db.py``).

4. After every database schema change, recreate the throwaway database
   to test the changes::

    rm temp.db
    gearbox setup-db -c temp.ini --repos=/var/repos --user=doe --email doe@example.com --password=123456 --no-public-access --force-yes
    gearbox repo-scan -c temp.ini

5. Once satisfied with the schema changes, auto-generate a draft Alembic
   script using the development database that has *not* been upgraded.
   (The generated script will upgrade the database to match the code.)

   ::

    alembic -c development.ini revision -m "area: add cool feature" --autogenerate

6. Edit the script to clean it up and fix any problems.

   Note that for changes that simply add columns, it may be appropriate
   to not remove them in the downgrade script (and instead do nothing),
   to avoid the loss of data. Unknown columns will simply be ignored by
   Kallithea versions predating your changes.

7. Run ``alembic -c development.ini upgrade head`` to apply changes to
   the (non-throwaway) database, and test the upgrade script. Also test
   downgrades.

   The included ``development.ini`` has full SQL logging enabled. If
   you're using another configuration file, you may want to enable it
   by setting ``level = DEBUG`` in section ``[handler_console_sql]``.

The Alembic migration script should be committed in the same revision as
the database schema (``db.py``) changes.

See the `Alembic documentation`__ for more information, in particular
the tutorial and the section about auto-generating migration scripts.

.. __: http://alembic.zzzcomputing.com/en/latest/


Troubleshooting
---------------

* If ``alembic --autogenerate`` responds "Target database is not up to
  date", you need to either first use Alembic to upgrade the database
  to the most recent version (before your changes), or recreate the
  database from scratch (without your schema changes applied).