pub/aerich
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve English grammar / clarity in README.md

Browse Source
This commit is contained in:
John Miller 2021-02-21 19:40:53 -08:00
parent be41a1332a
commit de8500b9a1
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -7,8 +7,8 @@
## Introduction ## Introduction
Aerich is a database migrations tool for Tortoise-ORM, which like alembic for SQLAlchemy, or Django ORM with it\'s own Aerich is a database migrations tool for Tortoise-ORM, which is like alembic for SQLAlchemy, or like Django ORM with
migrations solution. it\'s own migrations solution.
~~**Important: You can only use absolutely import in your `models.py` to make `aerich` work.**~~ ~~**Important: You can only use absolutely import in your `models.py` to make `aerich` work.**~~
@ -49,7 +49,7 @@ Commands:
## Usage ## Usage
You need add `aerich.models` to your `Tortoise-ORM` config first, example: You need add `aerich.models` to your `Tortoise-ORM` config first. Example:
```python ```python
TORTOISE_ORM = { TORTOISE_ORM = {
@ -79,7 +79,7 @@ Options:
-h, --help Show this message and exit. -h, --help Show this message and exit.
``` ```
Init config file and location: Initialize the config file and migrations location:
```shell ```shell
> aerich init -t tests.backends.mysql.TORTOISE_ORM > aerich init -t tests.backends.mysql.TORTOISE_ORM
@ -97,8 +97,8 @@ Success create app migrate location ./migrations/models
Success generate schema for app "models" Success generate schema for app "models"
``` ```
If your Tortoise-ORM app is not default `models`, you must specify If your Tortoise-ORM app is not the default `models`, you must specify the correct app via `--app`, e.g. `aerich
`--app` like `aerich --app other_models init-db`. --app other_models init-db`.
### Update models and make migrate ### Update models and make migrate
@ -111,9 +111,9 @@ Success migrate 1_202029051520102929_drop_column.sql
Format of migrate filename is Format of migrate filename is
`{version_num}_{datetime}_{name|update}.sql`. `{version_num}_{datetime}_{name|update}.sql`.
And if `aerich` guess you are renaming a column, it will ask `Rename {old_column} to {new_column} [True]`, you can If `aerich` guesses you are renaming a column, it will ask `Rename {old_column} to {new_column} [True]`. You can choose
choice `True` to rename column without column drop, or choice `False` to drop column then create, note that the after `True` to rename column without column drop, or choose `False` to drop the column then create. Note that the latter may
maybe lose data. lose data.
### Upgrade to latest version ### Upgrade to latest version
@ -149,7 +149,7 @@ Options:
Success downgrade 1_202029051520102929_drop_column.sql Success downgrade 1_202029051520102929_drop_column.sql
``` ```
Now your db rollback to specified version. Now your db is rolled back to the specified version.
### Show history ### Show history
@ -169,7 +169,7 @@ Now your db rollback to specified version.
### Inspect db tables to TortoiseORM model ### Inspect db tables to TortoiseORM model
Currently, only support MySQL. Currently `inspectdb` only supports MySQL.
```shell ```shell
Usage: aerich inspectdb [OPTIONS] Usage: aerich inspectdb [OPTIONS]
@ -187,14 +187,14 @@ Inspect all tables and print to console:
aerich --app models inspectdb aerich --app models inspectdb
``` ```
Inspect a specified table in default app and redirect to `models.py`: Inspect a specified table in the default app and redirect to `models.py`:
```shell ```shell
aerich inspectdb -t user > models.py aerich inspectdb -t user > models.py
``` ```
Note that this command is restricted, which is not supported in some solutions, such as `IntEnumField` Note that this command is limited and cannot infer some fields, such as `IntEnumField`, `ForeignKeyField`, and
and `ForeignKeyField` and so on. others.
### Multiple databases ### Multiple databases
@ -211,7 +211,7 @@ tortoise_orm = {
} }
``` ```
You need only specify `aerich.models` in one app, and must specify `--app` when run `aerich migrate` and so on. You only need to specify `aerich.models` in one app, and must specify `--app` when running `aerich migrate` and so on.
## Support this project ## Support this project