Debian Codegraph @

releasenotes/notes/switch-to-alembic-b438de67c5b22a40.yaml

raw
1 ---
2 upgrade:
3 - |
4 The database migration engine has changed from `sqlalchemy-migrate`__ to
5 `alembic`__. For most deployments, this should have minimal to no impact
6 and the switch should be mostly transparent. The main user-facing impact is
7 the change in schema versioning. While sqlalchemy-migrate used a linear,
8 integer-based versioning scheme, which required placeholder migrations to
9 allow for potential migration backports, alembic uses a distributed version
10 control-like schema where a migration's ancestor is encoded in the file and
11 branches are possible. The alembic migration files therefore use a
12 arbitrary UUID-like naming scheme and the ``masakari-manage db_sync``
13 command now expects such an version when manually specifying the version
14 that should be applied. For example::
15
16 $ masakari-manage db sync c6214ca60943
17
18 Attempting to specify an sqlalchemy-migrate-based version will result in an
19 error.
20
21 .. __: https://sqlalchemy-migrate.readthedocs.io/en/latest/
22 .. __: https://alembic.sqlalchemy.org/en/latest/