179 lines
4.2 KiB
Markdown
179 lines
4.2 KiB
Markdown
# Aerich
|
|
|
|
[](https://pypi.python.org/pypi/aerich)
|
|
[](https://github.com/long2ice/aerich)
|
|
[](https://github.com/long2ice/aerich/actions?query=workflow:pypi)
|
|
[](https://github.com/long2ice/aerich/actions?query=workflow:test)
|
|
|
|
<a href="https://tracking.gitads.io/?repo=aerich"><img src="https://images.gitads.io/aerich" alt="GitAds"/></a>
|
|
|
|
## Introduction
|
|
|
|
Tortoise-ORM is the best asyncio ORM now, but it lacks a database
|
|
migrations tool like alembic for SQLAlchemy, or Django ORM with it\'s
|
|
own migrations tool.
|
|
|
|
This project aim to be a best migrations tool for Tortoise-ORM and which
|
|
written by one of contributors of Tortoise-ORM.
|
|
|
|
## Install
|
|
|
|
Just install from pypi:
|
|
|
|
```shell
|
|
> pip install aerich
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```shell
|
|
$ aerich -h
|
|
|
|
Usage: aerich [OPTIONS] COMMAND [ARGS]...
|
|
|
|
Options:
|
|
-c, --config TEXT Config file. [default: aerich.ini]
|
|
--app TEXT Tortoise-ORM app name. [default: models]
|
|
-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 previous 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.
|
|
migrate Generate migrate changes file.
|
|
upgrade Upgrade to latest version.
|
|
```
|
|
|
|
## Usage
|
|
|
|
You need add `aerich.models` to your `Tortoise-ORM` config first,
|
|
example:
|
|
|
|
```python
|
|
TORTOISE_ORM = {
|
|
"connections": {"default": "mysql://root:123456@127.0.0.1:3306/test"},
|
|
"apps": {
|
|
"models": {
|
|
"models": ["tests.models", "aerich.models"],
|
|
"default_connection": "default",
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
### Initialization
|
|
|
|
```shell
|
|
$ aerich init -h
|
|
|
|
Usage: aerich init [OPTIONS]
|
|
|
|
Init config file and generate root migrate location.
|
|
|
|
Options:
|
|
-t, --tortoise-orm TEXT Tortoise-ORM config module dict variable, like settings.TORTOISE_ORM.
|
|
[required]
|
|
--location TEXT Migrate store location. [default: ./migrations]
|
|
-h, --help Show this message and exit.
|
|
```
|
|
|
|
Init config file and location:
|
|
|
|
```shell
|
|
$ aerich init -t tests.backends.mysql.TORTOISE_ORM
|
|
|
|
Success create migrate location ./migrations
|
|
Success generate config file aerich.ini
|
|
```
|
|
|
|
### Init db
|
|
|
|
```shell
|
|
$ aerich init-db
|
|
|
|
Success create app migrate location ./migrations/models
|
|
Success generate schema for app "models"
|
|
```
|
|
|
|
If your Tortoise-ORM app is not default `models`, you must specify
|
|
`--app` like `aerich --app other_models init-db`.
|
|
|
|
### Update models and make migrate
|
|
|
|
```shell
|
|
$ aerich migrate --name drop_column
|
|
|
|
Success migrate 1_202029051520102929_drop_column.json
|
|
```
|
|
|
|
Format of migrate filename is
|
|
`{version_num}_{datetime}_{name|update}.json`
|
|
|
|
### Upgrade to latest version
|
|
|
|
```shell
|
|
$ aerich upgrade
|
|
|
|
Success upgrade 1_202029051520102929_drop_column.json
|
|
```
|
|
|
|
Now your db is migrated to latest.
|
|
|
|
### Downgrade to previous version
|
|
|
|
```shell
|
|
$ aerich downgrade
|
|
|
|
Success downgrade 1_202029051520102929_drop_column.json
|
|
```
|
|
|
|
Now your db rollback to previous version.
|
|
|
|
### Show history
|
|
|
|
```shell
|
|
$ aerich history
|
|
|
|
1_202029051520102929_drop_column.json
|
|
```
|
|
|
|
### Show heads to be migrated
|
|
|
|
```shell
|
|
$ aerich heads
|
|
|
|
1_202029051520102929_drop_column.json
|
|
```
|
|
|
|
## Limitations
|
|
|
|
- Not support `rename column` now.
|
|
- `Sqlite` and `Postgres` may not work as expected because I don\'t
|
|
use those in my work.
|
|
|
|
## Support this project
|
|
|
|
- Just give a star!
|
|
- Donation.
|
|
|
|
### AliPay
|
|
|
|
<img width="200" src="https://github.com/long2ice/aerich/raw/dev/images/alipay.jpeg"/>
|
|
|
|
### WeChat Pay
|
|
|
|
<img width="200" src="https://github.com/long2ice/aerich/raw/dev/images/wechatpay.jpeg"/>
|
|
|
|
### PayPal
|
|
|
|
Donate money by [paypal](https://www.paypal.me/long2ice) to my account long2ice.
|
|
|
|
## License
|
|
|
|
This project is licensed under the
|
|
[Apache-2.0](https://github.com/long2ice/aerich/blob/master/LICENSE) License.
|