Aerich is a database migrations tool for Tortoise-ORM, which is like alembic for SQLAlchemy, or like Django ORM with it's own migration solution.
Just install from pypi:
> pip install aerich> aerich -h Usage: aerich [OPTIONS] COMMAND [ARGS]... Options: -V, --version Show the version and exit. -c, --config TEXT Config file. [default: aerich.ini] --app TEXT Tortoise-ORM app name. -n, --name TEXT Name of section in .ini file to use for aerich config. [default: aerich] -h, --help Show this message and exit. Commands: downgrade Downgrade to specified version. heads Show current available heads in migrate location. history List all migrate items. init Init config file and generate root migrate location. init-db Generate schema and generate app migrate location. inspectdb Introspects the database tables to standard output as... migrate Generate migrate changes file. upgrade Upgrade to specified version.
You need add aerich.models to your Tortoise-ORM config first. Example:
TORTOISE_ORM = { "connections": {"default": "mysql://root:123456@127.0.0.1:3306/test"}, "apps": { "models": { "models": ["tests.models", "aerich.models"], "default_connection": "default", }, }, }
> aerich init -h
Usage: aerich init [OPTIONS]
Init config file and generate root migrate location.
OOptions:
-t, --tortoise-orm TEXT Tortoise-ORM config module dict variable, like
settings.TORTOISE_ORM. [required]
--location TEXT Migrate store location. [default: ./migrations]
-s, --src_folder TEXT Folder of the source, relative to the project root.
-h, --help Show this message and exit.Initialize the config file and migrations location:
> aerich init -t tests.backends.mysql.TORTOISE_ORM
Success create migrate location ./migrations
Success generate config file aerich.ini> aerich init-db Success create app migrate location ./migrations/models Success generate schema for app "models"
If your Tortoise-ORM app is not the default models, you must specify the correct app via --app,
e.g. aerich --app other_models init-db.
> aerich migrate --name drop_column
Success migrate 1_202029051520102929_drop_column.sqlFormat of migrate filename is
{version_num}_{datetime}_{name|update}.sql.
If aerich guesses you are renaming a column, it will ask Rename {old_column} to {new_column} [True]. You can choose
True to rename column without column drop, or choose False to drop the column then create. Note that the latter may
lose data.
> aerich upgrade
Success upgrade 1_202029051520102929_drop_column.sqlNow your db is migrated to latest.
> aerich downgrade -h
Usage: aerich downgrade [OPTIONS]
Downgrade to specified version.
Options:
-v, --version INTEGER Specified version, default to last. [default: -1]
-d, --delete Delete version files at the same time. [default:
False]
--yes Confirm the action without prompting.
-h, --help Show this message and exit.> aerich downgrade
Success downgrade 1_202029051520102929_drop_column.sqlNow your db is rolled back to the specified version.
> aerich history 1_202029051520102929_drop_column.sql
> aerich heads
1_202029051520102929_drop_column.sqlCurrently inspectdb only supports MySQL.
Usage: aerich inspectdb [OPTIONS] Introspects the database tables to standard output as TortoiseORM model. Options: -t, --table TEXT Which tables to inspect. -h, --help Show this message and exit.
Inspect all tables and print to console:
aerich --app models inspectdb
Inspect a specified table in the default app and redirect to models.py:
aerich inspectdb -t user > models.pyNote that this command is limited and cannot infer some fields, such as IntEnumField, ForeignKeyField, and others.
tortoise_orm = { "connections": { "default": expand_db_url(db_url, True), "second": expand_db_url(db_url_second, True), }, "apps": { "models": {"models": ["tests.models", "aerich.models"], "default_connection": "default"}, "models_second": {"models": ["tests.models_second"], "default_connection": "second", }, }, }
You only need to specify aerich.models in one app, and must specify --app when running aerich migrate and so on.
In some cases, such as broken changes from upgrade of aerich, you can't run aerich migrate or aerich upgrade, you
can make the following steps:
- drop
aerichtable. - delete
migrations/{app}directory. - rerun
aerich init-db.
Note that these actions is safe, also you can do that to reset your migrations if your migration files is too many.
You can use aerich out of cli by use Command class.
from aerich import Command command = Command(tortoise_config=config, app='models') await command.migrate('test')
This project is licensed under the Apache-2.0 License.