Fix no module found error. (#188) (#189)

Fix: migrate doesn't use source_field in unique_together

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ["https://sponsor.long2ice.cn"]

.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: ci
+on:
+  push:
+    branches-ignore:
+      - master
+  pull_request:
+    branches-ignore:
+      - master
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:latest
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_PASSWORD: 123456
+          POSTGRES_USER: postgres
+        options: --health-cmd=pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+      - name: Start MySQL
+        run: sudo systemctl start mysql.service
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1.1.1
+        with:
+          virtualenvs-create: false
+      - name: CI
+        env:
+          MYSQL_PASS: root
+          MYSQL_HOST: 127.0.0.1
+          MYSQL_PORT: 3306
+          POSTGRES_PASS: 123456
+          POSTGRES_HOST: 127.0.0.1
+          POSTGRES_PORT: 5432
+        run: make ci

.github/workflows/pypi.yml

@@ -1,21 +1,22 @@
 name: pypi
-
 on:
   release:
     types:
       - created
-
 jobs:
-  build:
+  publish:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - uses: actions/setup-python@v2
         with:
           python-version: '3.x'
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1.1.1
+        with:
+          virtualenvs-create: false
       - name: Build dists
-        run: |
+        run: make build
-          python3 setup.py sdist
       - name: Pypi Publish
         uses: pypa/gh-action-pypi-publish@master
         with:

.gitignore

@@ -143,3 +143,7 @@ cython_debug/
 .idea
 migrations
 aerich.ini
+src
+.vscode
+.DS_Store
+.python-version

CHANGELOG.md

@@ -0,0 +1,185 @@
+# ChangeLog
+
+## 0.5
+
+### 0.5.7
+
+- Fix no module found error. (#188) (#189)
+
+### 0.5.6
+
+- Add `Command` class. (#148) (#141) (#123) (#106)
+- Fix: migrate doesn't use source_field in unique_together. (#181)
+
+### 0.5.5
+
+- Fix KeyError: 'src_folder' after upgrading aerich to 0.5.4. (#176)
+- Fix MySQL 5.X rename column.
+- Fix `db_constraint` when fk changed. (#179)
+
+### 0.5.4
+
+- Fix incorrect index creation order. (#151)
+- Not catch exception when import config. (#164)
+- Support `drop column` for sqlite. (#40)
+
+### 0.5.3
+
+- Fix postgre alter null. (#142)
+- Fix default function when migrate. (#147)
+
+### 0.5.2
+
+- Fix rename field on the field add. (#134)
+- Fix postgres field type change error. (#135)
+- Fix inspectdb for `FloatField`. (#138)
+- Support `rename table`. (#139)
+
+### 0.5.1
+
+- Fix tortoise connections not being closed properly. (#120)
+- Fix bug for field change. (#119)
+- Fix drop model in the downgrade. (#132)
+
+### 0.5.0
+
+- Refactor core code, now has no limitation for everything.
+
+## 0.4
+
+### 0.4.4
+
+- Fix unnecessary import. (#113)
+
+### 0.4.3
+
+- Replace migrations separator to sql standard comment.
+- Add `inspectdb` command.
+
+### 0.4.2
+
+- Use `pathlib` for path resolving. (#89)
+- Fix upgrade in new db. (#96)
+- Fix packaging error. (#92)
+
+### 0.4.1
+
+- Bug fix. (#91 #93)
+
+### 0.4.0
+
+- Use `.sql` instead of `.json` to store version file.
+- Add `rename` column support MySQL5.
+- Remove callable detection for defaults. (#87)
+- Fix `sqlite` stuck. (#90)
+
+## 0.3
+
+### 0.3.3
+
+- Fix encoding error. (#75)
+- Support multiple databases. (#68)
+- Compatible with models file in directory. (#70)
+
+### 0.3.2
+
+- Fix migrate to new database error. (#62)
+
+### 0.3.1
+
+- Fix first version error.
+- Fix init error. (#61)
+
+### 0.3.0
+
+- Refactoring migrate logic, and this version is not compatible with previous version.
+- Now there don't need `old_models.py` and it store in database.
+- Upgrade steps:
+    1. Upgrade aerich version.
+    2. Drop aerich table in database.
+    3. Delete `migrations/{app}` folder and rerun `aerich init-db`.
+    4. Update model and `aerich migrate` normally.
+
+## 0.2
+
+### 0.2.5
+
+- Fix windows support. (#46)
+- Support `db_constraint` in fk, m2m should manual define table with fk. (#52)
+
+### 0.2.4
+
+- Raise error with SQLite unsupported features.
+- Fix Postgres alter table. (#48)
+- Add `Rename` support.
+
+### 0.2.3
+
+- Fix tortoise ssl config.
+- PostgreSQL add/drop index/unique.
+
+### 0.2.2
+
+- Fix postgres drop fk.
+- Fix version sort.
+
+### 0.2.1
+
+- Fix bug in windows.
+- Enhance PostgreSQL support.
+
+### 0.2.0
+
+- Update model file find method.
+- Set `--safe` bool.
+
+## 0.1
+
+### 0.1.9
+
+- Fix default_connection when upgrade
+- Find default app instead of default.
+- Diff MySQL ddl.
+- Check tortoise config.
+
+### 0.1.8
+
+- Fix upgrade error when migrate.
+- Fix init db sql error.
+- Support change column.
+
+### 0.1.7
+
+- Exclude models.Aerich.
+- Add init record when init-db.
+- Fix version num str.
+
+### 0.1.6
+
+- update dependency_links
+
+### 0.1.5
+
+- Add sqlite and postgres support.
+- Fix dependency import.
+- Store versions in db.
+
+### 0.1.4
+
+- Fix transaction and fields import.
+- Make unique index worked.
+- Add cli --version.
+
+### 0.1.3
+
+- Support indexes and unique_together.
+
+### 0.1.2
+
+- Now aerich support m2m.
+- Add cli cmd init-db.
+- Change cli options.
+
+### 0.1.1
+
+- Now aerich is basic worked.

CHANGELOG.rst

@@ -1,25 +0,0 @@
-=========
-ChangeLog
-=========
-
-0.1
-===
-0.1.4
------
-- Fix transaction and fields import.
-- Make unique index worked.
-- Add cli --version.
-
-0.1.3
------
-- Support indexes and unique_together.
-
-0.1.2
------
-- Now aerich support m2m.
-- Add cli cmd init-db.
-- Change cli options.
-
-0.1.1
------
-- Now aerich is basic worked.

LICENSE

@@ -1,21 +1,201 @@
-The MIT License (MIT)
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Copyright (c) 2020 long2ice
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
+   1. Definitions.
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
+      "License" shall mean the terms and conditions for use, reproduction,
-all copies or substantial portions of the Software.
+      and distribution as defined by Sections 1 through 9 of this document.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+      "Licensor" shall mean the copyright owner or entity authorized by
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+      the copyright owner that is granting the License.
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+      "Legal Entity" shall mean the union of the acting entity and all
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+      other entities that control, are controlled by, or are under common
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+      control with that entity. For the purposes of this definition,
-THE SOFTWARE.
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 long2ice
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

MANIFEST.in

@@ -1,3 +0,0 @@
-include LICENSE
-include README.rst
-include requirements.txt

Makefile

@@ -1,55 +1,43 @@
-checkfiles = aerich/ tests/
+checkfiles = aerich/ tests/ conftest.py
 black_opts = -l 100 -t py38
 py_warn = PYTHONDEVMODE=1
-
+MYSQL_HOST ?= "127.0.0.1"
-help:
+MYSQL_PORT ?= 3306
-	@echo "Aerich development makefile"
+MYSQL_PASS ?= "123456"
-	@echo
+POSTGRES_HOST ?= "127.0.0.1"
-	@echo  "usage: make <target>"
+POSTGRES_PORT ?= 5432
-	@echo  "Targets:"
+POSTGRES_PASS ?= "123456"
-	@echo  "    up			Updates dev/test dependencies"
-	@echo  "    deps        Ensure dev/test dependencies are installed"
-	@echo  "    check		Checks that build is sane"
-	@echo  "    lint		Reports all linter violations"
-	@echo  "    test		Runs all tests"
-	@echo  "    style		Auto-formats the code"
-
-deps:
-	@which pip-sync > /dev/null || pip install -q pip-tools
-	@pip install -r requirements-dev.txt
 
 up:
-	CUSTOM_COMPILE_COMMAND="make up" pip-compile -o requirements-dev.txt -U
+	@poetry update
-	sed -i "s/^-e .*/-e ./" requirements.txt
+
+deps:
+	@poetry install -E asyncpg -E asyncmy -E aiomysql
 
 style: deps
-	isort -rc $(checkfiles)
+	isort -src $(checkfiles)
 	black $(black_opts) $(checkfiles)
 
 check: deps
-ifneq ($(shell which black),)
 	black --check $(black_opts) $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
-endif
 	flake8 $(checkfiles)
-	mypy $(checkfiles)
+	bandit -x tests -r $(checkfiles)
-	pylint -d C,W,R $(checkfiles)
-	bandit -r $(checkfiles)
-	python setup.py check -mrs
-
-lint: deps
-ifneq ($(shell which black),)
-	black --check $(black_opts) $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
-endif
-	flake8 $(checkfiles)
-	mypy $(checkfiles)
-	pylint $(checkfiles)
-	bandit -r $(checkfiles)
-	python setup.py check -mrs
 
 test: deps
-	$(py_warn) py.test
+	$(py_warn) TEST_DB=sqlite://:memory: py.test
 
-publish: deps
+test_sqlite:
-	rm -fR dist/
+	$(py_warn) TEST_DB=sqlite://:memory: py.test
-	python setup.py sdist
+
-	twine upload dist/*
+test_mysql:
+	$(py_warn) TEST_DB="mysql://root:$(MYSQL_PASS)@$(MYSQL_HOST):$(MYSQL_PORT)/test_\{\}" pytest -vv -s
+
+test_postgres:
+	$(py_warn) TEST_DB="postgres://postgres:$(POSTGRES_PASS)@$(POSTGRES_HOST):$(POSTGRES_PORT)/test_\{\}" pytest -vv -s
+
+testall: deps test_sqlite test_postgres test_mysql
+
+build: deps
+	@poetry build
+
+ci: check testall

README.md

@@ -0,0 +1,241 @@
+# Aerich
+
+[![image](https://img.shields.io/pypi/v/aerich.svg?style=flat)](https://pypi.python.org/pypi/aerich)
+[![image](https://img.shields.io/github/license/tortoise/aerich)](https://github.com/tortoise/aerich)
+[![image](https://github.com/tortoise/aerich/workflows/pypi/badge.svg)](https://github.com/tortoise/aerich/actions?query=workflow:pypi)
+[![image](https://github.com/tortoise/aerich/workflows/ci/badge.svg)](https://github.com/tortoise/aerich/actions?query=workflow:ci)
+
+## Introduction
+
+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.
+
+## Install
+
+Just install from pypi:
+
+```shell
+> pip install aerich
+```
+
+## Quick Start
+
+```shell
+> 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.
+```
+
+## 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.
+
+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:
+
+```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 the default `models`, you must specify the correct app via `--app`,
+e.g. `aerich --app other_models init-db`.
+
+### Update models and make migrate
+
+```shell
+> aerich migrate --name drop_column
+
+Success migrate 1_202029051520102929_drop_column.sql
+```
+
+Format 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.
+
+### Upgrade to latest version
+
+```shell
+> aerich upgrade
+
+Success upgrade 1_202029051520102929_drop_column.sql
+```
+
+Now your db is migrated to latest.
+
+### Downgrade to specified version
+
+```shell
+> 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.
+```
+
+```shell
+> aerich downgrade
+
+Success downgrade 1_202029051520102929_drop_column.sql
+```
+
+Now your db is rolled back to the specified version.
+
+### Show history
+
+```shell
+> aerich history
+
+1_202029051520102929_drop_column.sql
+```
+
+### Show heads to be migrated
+
+```shell
+> aerich heads
+
+1_202029051520102929_drop_column.sql
+```
+
+### Inspect db tables to TortoiseORM model
+
+Currently `inspectdb` only supports MySQL.
+
+```shell
+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:
+
+```shell
+aerich --app models inspectdb
+```
+
+Inspect a specified table in the default app and redirect to `models.py`:
+
+```shell
+aerich inspectdb -t user > models.py
+```
+
+Note that this command is limited and cannot infer some fields, such as `IntEnumField`, `ForeignKeyField`, and others.
+
+### Multiple databases
+
+```python
+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.
+
+## Restore `aerich` workflow
+
+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:
+
+1. drop `aerich` table.
+2. delete `migrations/{app}` directory.
+3. 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.
+
+## Use `aerich` in application
+
+You can use `aerich` out of cli by use `Command` class.
+
+```python
+from aerich import Command
+
+command = Command(tortoise_config=config, app='models')
+await command.init()
+await command.migrate('test')
+```
+
+## License
+
+This project is licensed under the
+[Apache-2.0](https://github.com/long2ice/aerich/blob/master/LICENSE) License.

README.rst

@@ -1,145 +0,0 @@
-======
-Aerich
-======
-
-.. image:: https://img.shields.io/pypi/v/aerich.svg?style=flat
-   :target: https://pypi.python.org/pypi/aerich
-.. image:: https://img.shields.io/github/license/long2ice/aerich
-   :target: https://github.com/long2ice/aerich
-.. image:: https://github.com/long2ice/aerich/workflows/pypi/badge.svg
-   :target: https://github.com/long2ice/aerich/actions?query=workflow:pypi
-
-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:
-
-.. code-block:: shell
-
-    $ pip install aerich
-
-Quick Start
-===========
-
-.. code-block:: 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
-=====
-
-Initialization
---------------
-
-.. code-block:: 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:
-
-.. code-block:: shell
-
-    $ aerich init -t tests.backends.mysql.TORTOISE_ORM
-
-    Success create migrate location ./migrations
-    Success generate config file aerich.ini
-
-Init db
--------
-
-.. code-block:: shell
-
-    $ aerich init-db
-
-    Success create app migrate location ./migrations/models
-    Success generate schema for app "models"
-
-Update models and make migrate
-------------------------------
-
-.. code-block:: shell
-
-    $ aerich migrate --name drop_column
-
-    Success migrate 1_202029051520102929_drop_column.json
-
-Format of migrate filename is ``{version}_{datetime}_{name|update}.json``
-
-Upgrade to latest version
--------------------------
-
-.. code-block:: shell
-
-    $ aerich upgrade
-
-    Success upgrade 1_202029051520102929_drop_column.json
-
-Now your db is migrated to latest.
-
-Downgrade to previous version
------------------------------
-
-.. code-block:: shell
-
-    $ aerich downgrade
-
-    Success downgrade 1_202029051520102929_drop_column.json
-
-Now your db rollback to previous version.
-
-Show history
-------------
-
-.. code-block:: shell
-
-    $ aerich history
-
-    1_202029051520102929_drop_column.json
-
-Show heads to be migrated
--------------------------
-
-.. code-block:: shell
-
-    $ aerich heads
-
-    1_202029051520102929_drop_column.json
-
-License
-=======
-This project is licensed under the `MIT <https://github.com/long2ice/aerich/blob/master/LICENSE>`_ License.

aerich/__init__.py

@@ -1 +1,138 @@
-__version__ = "0.1.4"
+import os
+from pathlib import Path
+from typing import List
+
+from tortoise import Tortoise, generate_schema_for_client
+from tortoise.exceptions import OperationalError
+from tortoise.transactions import in_transaction
+from tortoise.utils import get_schema_sql
+
+from aerich.exceptions import DowngradeError
+from aerich.inspectdb import InspectDb
+from aerich.migrate import Migrate
+from aerich.models import Aerich
+from aerich.utils import (
+    get_app_connection,
+    get_app_connection_name,
+    get_models_describe,
+    get_version_content_from_file,
+    write_version_file,
+)
+
+
+class Command:
+    def __init__(
+        self,
+        tortoise_config: dict,
+        app: str = "models",
+        location: str = "./migrations",
+    ):
+        self.tortoise_config = tortoise_config
+        self.app = app
+        self.location = location
+        Migrate.app = app
+
+    async def init(self):
+        await Migrate.init(self.tortoise_config, self.app, self.location)
+
+    async def upgrade(self):
+        migrated = []
+        for version_file in Migrate.get_all_version_files():
+            try:
+                exists = await Aerich.exists(version=version_file, app=self.app)
+            except OperationalError:
+                exists = False
+            if not exists:
+                async with in_transaction(
+                    get_app_connection_name(self.tortoise_config, self.app)
+                ) as conn:
+                    file_path = Path(Migrate.migrate_location, version_file)
+                    content = get_version_content_from_file(file_path)
+                    upgrade_query_list = content.get("upgrade")
+                    for upgrade_query in upgrade_query_list:
+                        await conn.execute_script(upgrade_query)
+                    await Aerich.create(
+                        version=version_file,
+                        app=self.app,
+                        content=get_models_describe(self.app),
+                    )
+                migrated.append(version_file)
+        return migrated
+
+    async def downgrade(self, version: int, delete: bool):
+        ret = []
+        if version == -1:
+            specified_version = await Migrate.get_last_version()
+        else:
+            specified_version = await Aerich.filter(
+                app=self.app, version__startswith=f"{version}_"
+            ).first()
+        if not specified_version:
+            raise DowngradeError("No specified version found")
+        if version == -1:
+            versions = [specified_version]
+        else:
+            versions = await Aerich.filter(app=self.app, pk__gte=specified_version.pk)
+        for version in versions:
+            file = version.version
+            async with in_transaction(
+                get_app_connection_name(self.tortoise_config, self.app)
+            ) as conn:
+                file_path = Path(Migrate.migrate_location, file)
+                content = get_version_content_from_file(file_path)
+                downgrade_query_list = content.get("downgrade")
+                if not downgrade_query_list:
+                    raise DowngradeError("No downgrade items found")
+                for downgrade_query in downgrade_query_list:
+                    await conn.execute_query(downgrade_query)
+                await version.delete()
+                if delete:
+                    os.unlink(file_path)
+                ret.append(file)
+        return ret
+
+    async def heads(self):
+        ret = []
+        versions = Migrate.get_all_version_files()
+        for version in versions:
+            if not await Aerich.exists(version=version, app=self.app):
+                ret.append(version)
+        return ret
+
+    async def history(self):
+        ret = []
+        versions = Migrate.get_all_version_files()
+        for version in versions:
+            ret.append(version)
+        return ret
+
+    async def inspectdb(self, tables: List[str]):
+        connection = get_app_connection(self.tortoise_config, self.app)
+        inspect = InspectDb(connection, tables)
+        await inspect.inspect()
+
+    async def migrate(self, name: str = "update"):
+        return await Migrate.migrate(name)
+
+    async def init_db(self, safe: bool):
+        location = self.location
+        app = self.app
+        dirname = Path(location, app)
+        dirname.mkdir(parents=True)
+
+        await Tortoise.init(config=self.tortoise_config)
+        connection = get_app_connection(self.tortoise_config, app)
+        await generate_schema_for_client(connection, safe)
+
+        schema = get_schema_sql(connection, safe)
+
+        version = await Migrate.generate_version()
+        await Aerich.create(
+            version=version,
+            app=app,
+            content=get_models_describe(app),
+        )
+        content = {
+            "upgrade": [schema],
+        }
+        write_version_file(Path(dirname, version), content)

aerich/cli.py

@@ -1,33 +1,53 @@
-import json
+import asyncio
 import os
-import sys
 from configparser import ConfigParser
-from enum import Enum
+from functools import wraps
-from . import __version__
+from pathlib import Path
-import asyncclick as click
+from typing import List
-from asyncclick import Context, UsageError
-from tortoise import ConfigurationError, Tortoise, generate_schema_for_client
-from tortoise.transactions import in_transaction
 
-from aerich.migrate import Migrate
+import click
-from aerich.utils import get_app_connection, get_app_connection_name, get_tortoise_config
+from click import Context, UsageError
+from tortoise import Tortoise
 
+from aerich.exceptions import DowngradeError
+from aerich.utils import add_src_path, get_tortoise_config
 
-class Color(str, Enum):
+from . import Command
-    green = "green"
+from .enums import Color
-    red = "red"
+from .version import __version__
-    yellow = "yellow"
-
 
 parser = ConfigParser()
 
+CONFIG_DEFAULT_VALUES = {
+    "src_folder": ".",
+}
+
+
+def coro(f):
+    @wraps(f)
+    def wrapper(*args, **kwargs):
+        loop = asyncio.get_event_loop()
+
+        # Close db connections at the end of all all but the cli group function
+        try:
+            loop.run_until_complete(f(*args, **kwargs))
+        finally:
+            if f.__name__ != "cli":
+                loop.run_until_complete(Tortoise.close_connections())
+
+    return wrapper
+
 
 @click.group(context_settings={"help_option_names": ["-h", "--help"]})
-@click.version_option(__version__)
+@click.version_option(__version__, "-V", "--version")
 @click.option(
-    "-c", "--config", default="aerich.ini", show_default=True, help="Config file.",
+    "-c",
+    "--config",
+    default="aerich.ini",
+    show_default=True,
+    help="Config file.",
 )
-@click.option("--app", default="models", show_default=True, help="Tortoise-ORM app name.")
+@click.option("--app", required=False, help="Tortoise-ORM app name.")
 @click.option(
     "-n",
     "--name",
@@ -36,107 +56,110 @@ parser = ConfigParser()
     help="Name of section in .ini file to use for aerich config.",
 )
 @click.pass_context
+@coro
 async def cli(ctx: Context, config, app, name):
     ctx.ensure_object(dict)
-    ctx.obj["config"] = config
+    ctx.obj["config_file"] = config
     ctx.obj["name"] = name
+
     invoked_subcommand = ctx.invoked_subcommand
     if invoked_subcommand != "init":
-        if not os.path.exists(config):
+        if not Path(config).exists():
             raise UsageError("You must exec init first", ctx=ctx)
         parser.read(config)
 
         location = parser[name]["location"]
         tortoise_orm = parser[name]["tortoise_orm"]
-
+        src_folder = parser[name].get("src_folder", CONFIG_DEFAULT_VALUES["src_folder"])
+        add_src_path(src_folder)
         tortoise_config = get_tortoise_config(ctx, tortoise_orm)
-
+        app = app or list(tortoise_config.get("apps").keys())[0]
-        ctx.obj["config"] = tortoise_config
+        command = Command(tortoise_config=tortoise_config, app=app, location=location)
-        ctx.obj["location"] = location
+        ctx.obj["command"] = command
-        ctx.obj["app"] = app
-
         if invoked_subcommand != "init-db":
-            try:
+            if not Path(location, app).exists():
-                await Migrate.init_with_old_models(tortoise_config, app, location)
+                raise UsageError("You must exec init-db first", ctx=ctx)
-            except ConfigurationError:
+            await command.init()
-                raise UsageError(ctx=ctx, message="You must exec ini-db first")
 
 
 @cli.command(help="Generate migrate changes file.")
 @click.option("--name", default="update", show_default=True, help="Migrate name.")
 @click.pass_context
+@coro
 async def migrate(ctx: Context, name):
-    config = ctx.obj["config"]
+    command = ctx.obj["command"]
-    location = ctx.obj["location"]
+    ret = await command.migrate(name)
-    app = ctx.obj["app"]
-
-    ret = Migrate.migrate(name)
     if not ret:
         return click.secho("No changes detected", fg=Color.yellow)
-    Migrate.write_old_models(config, app, location)
     click.secho(f"Success migrate {ret}", fg=Color.green)
 
 
-@cli.command(help="Upgrade to latest version.")
+@cli.command(help="Upgrade to specified version.")
 @click.pass_context
+@coro
 async def upgrade(ctx: Context):
-    app = ctx.obj["app"]
+    command = ctx.obj["command"]
-    config = ctx.obj["config"]
+    migrated = await command.upgrade()
-    available_versions = Migrate.get_all_version_files(is_all=False)
+    if not migrated:
-    if not available_versions:
+        click.secho("No upgrade items found", fg=Color.yellow)
-        return click.secho("No migrate items", fg=Color.yellow)
-    async with in_transaction(get_app_connection_name(config, app)) as conn:
-        for file in available_versions:
-            file_path = os.path.join(Migrate.migrate_location, file)
-            with open(file_path, "r") as f:
-                content = json.load(f)
-                upgrade_query_list = content.get("upgrade")
-                for upgrade_query in upgrade_query_list:
-                    await conn.execute_query(upgrade_query)
-
-            with open(file_path, "w") as f:
-                content["migrate"] = True
-                json.dump(content, f, indent=2, ensure_ascii=False)
-                click.secho(f"Success upgrade {file}", fg=Color.green)
-
-
-@cli.command(help="Downgrade to previous version.")
-@click.pass_context
-async def downgrade(ctx: Context):
-    app = ctx.obj["app"]
-    config = ctx.obj["config"]
-    available_versions = Migrate.get_all_version_files()
-    if not available_versions:
-        return click.secho("No migrate items", fg=Color.yellow)
-
-    async with in_transaction(get_app_connection_name(config, app)) as conn:
-        for file in reversed(available_versions):
-            file_path = os.path.join(Migrate.migrate_location, file)
-            with open(file_path, "r") as f:
-                content = json.load(f)
-                if content.get("migrate"):
-                    downgrade_query_list = content.get("downgrade")
-                    for downgrade_query in downgrade_query_list:
-                        await conn.execute_query(downgrade_query)
     else:
-                    continue
+        for version_file in migrated:
-            with open(file_path, "w") as f:
+            click.secho(f"Success upgrade {version_file}", fg=Color.green)
-                content["migrate"] = False
+
-                json.dump(content, f, indent=2, ensure_ascii=False)
+
-                return click.secho(f"Success downgrade {file}", fg=Color.green)
+@cli.command(help="Downgrade to specified version.")
+@click.option(
+    "-v",
+    "--version",
+    default=-1,
+    type=int,
+    show_default=True,
+    help="Specified version, default to last.",
+)
+@click.option(
+    "-d",
+    "--delete",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="Delete version files at the same time.",
+)
+@click.pass_context
+@click.confirmation_option(
+    prompt="Downgrade is dangerous, which maybe lose your data, are you sure?",
+)
+@coro
+async def downgrade(ctx: Context, version: int, delete: bool):
+    command = ctx.obj["command"]
+    try:
+        files = await command.downgrade(version, delete)
+    except DowngradeError as e:
+        return click.secho(str(e), fg=Color.yellow)
+    for file in files:
+        click.secho(f"Success downgrade {file}", fg=Color.green)
 
 
 @cli.command(help="Show current available heads in migrate location.")
 @click.pass_context
-def heads(ctx: Context):
+@coro
-    for version in Migrate.get_all_version_files(is_all=False):
+async def heads(ctx: Context):
+    command = ctx.obj["command"]
+    head_list = await command.heads()
+    if not head_list:
+        return click.secho("No available heads, try migrate first", fg=Color.green)
+    for version in head_list:
         click.secho(version, fg=Color.green)
 
 
 @cli.command(help="List all migrate items.")
 @click.pass_context
-def history(ctx):
+@coro
-    for version in Migrate.get_all_version_files():
+async def history(ctx: Context):
+    command = ctx.obj["command"]
+    versions = await command.history()
+    if not versions:
+        return click.secho("No history, try migrate", fg=Color.green)
+    for version in versions:
         click.secho(version, fg=Color.green)
 
 
@@ -148,59 +171,92 @@ def history(ctx):
     help="Tortoise-ORM config module dict variable, like settings.TORTOISE_ORM.",
 )
 @click.option(
-    "--location", default="./migrations", show_default=True, help="Migrate store location."
+    "--location",
+    default="./migrations",
+    show_default=True,
+    help="Migrate store location.",
+)
+@click.option(
+    "-s",
+    "--src_folder",
+    default=CONFIG_DEFAULT_VALUES["src_folder"],
+    show_default=False,
+    help="Folder of the source, relative to the project root.",
 )
 @click.pass_context
-async def init(
+@coro
-        ctx: Context, tortoise_orm, location,
+async def init(ctx: Context, tortoise_orm, location, src_folder):
-):
+    config_file = ctx.obj["config_file"]
-    config = ctx.obj["config"]
     name = ctx.obj["name"]
+    if Path(config_file).exists():
+        return click.secho("Configuration file already created", fg=Color.yellow)
+
+    if os.path.isabs(src_folder):
+        src_folder = os.path.relpath(os.getcwd(), src_folder)
+    # Add ./ so it's clear that this is relative path
+    if not src_folder.startswith("./"):
+        src_folder = "./" + src_folder
+
+    # check that we can find the configuration, if not we can fail before the config file gets created
+    add_src_path(src_folder)
+    get_tortoise_config(ctx, tortoise_orm)
 
     parser.add_section(name)
     parser.set(name, "tortoise_orm", tortoise_orm)
     parser.set(name, "location", location)
+    parser.set(name, "src_folder", src_folder)
 
-    with open(config, "w") as f:
+    with open(config_file, "w", encoding="utf-8") as f:
         parser.write(f)
 
-    if not os.path.isdir(location):
+    Path(location).mkdir(parents=True, exist_ok=True)
-        os.mkdir(location)
 
     click.secho(f"Success create migrate location {location}", fg=Color.green)
-    click.secho(f"Success generate config file {config}", fg=Color.green)
+    click.secho(f"Success generate config file {config_file}", fg=Color.green)
 
 
 @cli.command(help="Generate schema and generate app migrate location.")
 @click.option(
     "--safe",
-    is_flag=True,
+    type=bool,
     default=True,
     help="When set to true, creates the table only when it does not already exist.",
     show_default=True,
 )
 @click.pass_context
+@coro
 async def init_db(ctx: Context, safe):
-    config = ctx.obj["config"]
+    command = ctx.obj["command"]
-    location = ctx.obj["location"]
+    app = command.app
-    app = ctx.obj["app"]
+    dirname = Path(command.location, app)
-
+    try:
-    dirname = os.path.join(location, app)
+        await command.init_db(safe)
-    if not os.path.isdir(dirname):
-        os.mkdir(dirname)
         click.secho(f"Success create app migrate location {dirname}", fg=Color.green)
-    else:
+        click.secho(f'Success generate schema for app "{app}"', fg=Color.green)
-        return click.secho(f'Already inited app "{app}"', fg=Color.yellow)
+    except FileExistsError:
+        return click.secho(
+            f"Inited {app} already, or delete {dirname} and try again.", fg=Color.yellow
+        )
 
-    Migrate.write_old_models(config, app, location)
 
-    await Tortoise.init(config=config)
+@cli.command(help="Introspects the database tables to standard output as TortoiseORM model.")
-    connection = get_app_connection(config, app)
+@click.option(
-    await generate_schema_for_client(connection, safe)
+    "-t",
-
+    "--table",
-    return click.secho(f'Success generate schema for app "{app}"', fg=Color.green)
+    help="Which tables to inspect.",
+    multiple=True,
+    required=False,
+)
+@click.pass_context
+@coro
+async def inspectdb(ctx: Context, table: List[str]):
+    command = ctx.obj["command"]
+    await command.inspectdb(table)
 
 
 def main():
-    sys.path.insert(0, ".")
+    cli()
-    cli(_anyio_backend="asyncio")
+
+
+if __name__ == "__main__":
+    main()

aerich/ddl/__init__.py

@@ -1,23 +1,34 @@
+from enum import Enum
 from typing import List, Type
 
-from tortoise import BaseDBAsyncClient, ForeignKeyFieldInstance, ManyToManyFieldInstance, Model
+from tortoise import BaseDBAsyncClient, Model
 from tortoise.backends.base.schema_generator import BaseSchemaGenerator
-from tortoise.fields import Field, JSONField, TextField, UUIDField
+
+from aerich.utils import is_default_function
 
 
 class BaseDDL:
     schema_generator_cls: Type[BaseSchemaGenerator] = BaseSchemaGenerator
     DIALECT = "sql"
-    _DROP_TABLE_TEMPLATE = "DROP TABLE IF EXISTS {table_name}"
+    _DROP_TABLE_TEMPLATE = 'DROP TABLE IF EXISTS "{table_name}"'
-    _ADD_COLUMN_TEMPLATE = "ALTER TABLE {table_name} ADD {column}"
+    _ADD_COLUMN_TEMPLATE = 'ALTER TABLE "{table_name}" ADD {column}'
-    _DROP_COLUMN_TEMPLATE = "ALTER TABLE {table_name} DROP COLUMN {column_name}"
+    _DROP_COLUMN_TEMPLATE = 'ALTER TABLE "{table_name}" DROP COLUMN "{column_name}"'
-    _ADD_INDEX_TEMPLATE = (
+    _ALTER_DEFAULT_TEMPLATE = 'ALTER TABLE "{table_name}" ALTER COLUMN "{column}" {default}'
-        "ALTER TABLE {table_name} ADD {unique} INDEX {index_name} ({column_names})"
+    _RENAME_COLUMN_TEMPLATE = (
+        'ALTER TABLE "{table_name}" RENAME COLUMN "{old_column_name}" TO "{new_column_name}"'
     )
-    _DROP_INDEX_TEMPLATE = "ALTER TABLE {table_name} DROP INDEX {index_name}"
+    _ADD_INDEX_TEMPLATE = (
-    _ADD_FK_TEMPLATE = "ALTER TABLE {table_name} ADD CONSTRAINT `{fk_name}` FOREIGN KEY (`{db_column}`) REFERENCES `{table}` (`{field}`) ON DELETE {on_delete}"
+        'ALTER TABLE "{table_name}" ADD {unique}INDEX "{index_name}" ({column_names})'
-    _DROP_FK_TEMPLATE = "ALTER TABLE {table_name} DROP FOREIGN KEY {fk_name}"
+    )
-    _M2M_TABLE_TEMPLATE = "CREATE TABLE {table_name} ({backward_key} {backward_type} NOT NULL REFERENCES {backward_table} ({backward_field}) ON DELETE CASCADE,{forward_key} {forward_type} NOT NULL REFERENCES {forward_table} ({forward_field}) ON DELETE CASCADE){extra}{comment};"
+    _DROP_INDEX_TEMPLATE = 'ALTER TABLE "{table_name}" DROP INDEX "{index_name}"'
+    _ADD_FK_TEMPLATE = 'ALTER TABLE "{table_name}" ADD CONSTRAINT "{fk_name}" FOREIGN KEY ("{db_column}") REFERENCES "{table}" ("{field}") ON DELETE {on_delete}'
+    _DROP_FK_TEMPLATE = 'ALTER TABLE "{table_name}" DROP FOREIGN KEY "{fk_name}"'
+    _M2M_TABLE_TEMPLATE = 'CREATE TABLE "{table_name}" ("{backward_key}" {backward_type} NOT NULL REFERENCES "{backward_table}" ("{backward_field}") ON DELETE CASCADE,"{forward_key}" {forward_type} NOT NULL REFERENCES "{forward_table}" ("{forward_field}") ON DELETE {on_delete}){extra}{comment}'
+    _MODIFY_COLUMN_TEMPLATE = 'ALTER TABLE "{table_name}" MODIFY COLUMN {column}'
+    _CHANGE_COLUMN_TEMPLATE = (
+        'ALTER TABLE "{table_name}" CHANGE {old_column_name} {new_column_name} {new_column_type}'
+    )
+    _RENAME_TABLE_TEMPLATE = 'ALTER TABLE "{old_table_name}" RENAME TO "{new_table_name}"'
 
     def __init__(self, client: "BaseDBAsyncClient"):
         self.client = client
@@ -26,42 +37,58 @@ class BaseDDL:
     def create_table(self, model: "Type[Model]"):
         return self.schema_generator._get_table_sql(model, True)["table_creation_string"]
 
-    def drop_table(self, model: "Type[Model]"):
+    def drop_table(self, table_name: str):
-        return self._DROP_TABLE_TEMPLATE.format(table_name=model._meta.db_table)
+        return self._DROP_TABLE_TEMPLATE.format(table_name=table_name)
 
-    def create_m2m_table(self, model: "Type[Model]", field: ManyToManyFieldInstance):
+    def create_m2m(
+        self, model: "Type[Model]", field_describe: dict, reference_table_describe: dict
+    ):
+        through = field_describe.get("through")
+        description = field_describe.get("description")
+        reference_id = reference_table_describe.get("pk_field").get("db_column")
+        db_field_types = reference_table_describe.get("pk_field").get("db_field_types")
         return self._M2M_TABLE_TEMPLATE.format(
-            table_name=field.through,
+            table_name=through,
             backward_table=model._meta.db_table,
-            forward_table=field.related_model._meta.db_table,
+            forward_table=reference_table_describe.get("table"),
             backward_field=model._meta.db_pk_column,
-            forward_field=field.related_model._meta.db_pk_column,
+            forward_field=reference_id,
-            backward_key=field.backward_key,
+            backward_key=field_describe.get("backward_key"),
             backward_type=model._meta.pk.get_for_dialect(self.DIALECT, "SQL_TYPE"),
-            forward_key=field.forward_key,
+            forward_key=field_describe.get("forward_key"),
-            forward_type=field.related_model._meta.pk.get_for_dialect(self.DIALECT, "SQL_TYPE"),
+            forward_type=db_field_types.get(self.DIALECT) or db_field_types.get(""),
-            extra=self.schema_generator._table_generate_extra(table=field.through),
+            on_delete=field_describe.get("on_delete"),
+            extra=self.schema_generator._table_generate_extra(table=through),
             comment=self.schema_generator._table_comment_generator(
-                table=field.through, comment=field.description
+                table=through, comment=description
             )
-            if field.description
+            if description
             else "",
         )
 
-    def drop_m2m(self, field: ManyToManyFieldInstance):
+    def drop_m2m(self, table_name: str):
-        return self._DROP_TABLE_TEMPLATE.format(table_name=field.through)
+        return self._DROP_TABLE_TEMPLATE.format(table_name=table_name)
 
-    def add_column(self, model: "Type[Model]", field_object: Field):
+    def _get_default(self, model: "Type[Model]", field_describe: dict):
         db_table = model._meta.db_table
-        default = field_object.default
+        default = field_describe.get("default")
-        db_column = field_object.model_field_name
+        if isinstance(default, Enum):
-        auto_now_add = getattr(field_object, "auto_now_add", False)
+            default = default.value
-        auto_now = getattr(field_object, "auto_now", False)
+        db_column = field_describe.get("db_column")
+        auto_now_add = field_describe.get("auto_now_add", False)
+        auto_now = field_describe.get("auto_now", False)
         if default is not None or auto_now_add:
-            if callable(default) or isinstance(field_object, (UUIDField, TextField, JSONField)):
+            if (
+                field_describe.get("field_type")
+                in [
+                    "UUIDField",
+                    "TextField",
+                    "JSONField",
+                ]
+                or is_default_function(default)
+            ):
                 default = ""
             else:
-                default = field_object.to_db_value(default, model)
                 try:
                     default = self.schema_generator._column_default_generator(
                         db_table,
@@ -73,22 +100,32 @@ class BaseDDL:
                 except NotImplementedError:
                     default = ""
         else:
+            default = None
+        return default
+
+    def add_column(self, model: "Type[Model]", field_describe: dict, is_pk: bool = False):
+        db_table = model._meta.db_table
+        description = field_describe.get("description")
+        db_column = field_describe.get("db_column")
+        db_field_types = field_describe.get("db_field_types")
+        default = self._get_default(model, field_describe)
+        if default is None:
             default = ""
         return self._ADD_COLUMN_TEMPLATE.format(
             table_name=db_table,
             column=self.schema_generator._create_string(
-                db_column=field_object.model_field_name,
+                db_column=db_column,
-                field_type=field_object.get_for_dialect(self.DIALECT, "SQL_TYPE"),
+                field_type=db_field_types.get(self.DIALECT, db_field_types.get("")),
-                nullable="NOT NULL" if not field_object.null else "",
+                nullable="NOT NULL" if not field_describe.get("nullable") else "",
-                unique="UNIQUE" if field_object.unique else "",
+                unique="UNIQUE" if field_describe.get("unique") else "",
                 comment=self.schema_generator._column_comment_generator(
                     table=db_table,
-                    column=field_object.model_field_name,
+                    column=db_column,
-                    comment=field_object.description,
+                    comment=field_describe.get("description"),
                 )
-                if field_object.description
+                if description
                 else "",
-                is_primary_key=field_object.pk,
+                is_primary_key=is_pk,
                 default=default,
             ),
         )
@@ -98,9 +135,51 @@ class BaseDDL:
             table_name=model._meta.db_table, column_name=column_name
         )
 
+    def modify_column(self, model: "Type[Model]", field_describe: dict, is_pk: bool = False):
+        db_table = model._meta.db_table
+        db_field_types = field_describe.get("db_field_types")
+        default = self._get_default(model, field_describe)
+        if default is None:
+            default = ""
+        return self._MODIFY_COLUMN_TEMPLATE.format(
+            table_name=db_table,
+            column=self.schema_generator._create_string(
+                db_column=field_describe.get("db_column"),
+                field_type=db_field_types.get(self.DIALECT) or db_field_types.get(""),
+                nullable="NOT NULL" if not field_describe.get("nullable") else "",
+                unique="",
+                comment=self.schema_generator._column_comment_generator(
+                    table=db_table,
+                    column=field_describe.get("db_column"),
+                    comment=field_describe.get("description"),
+                )
+                if field_describe.get("description")
+                else "",
+                is_primary_key=is_pk,
+                default=default,
+            ),
+        )
+
+    def rename_column(self, model: "Type[Model]", old_column_name: str, new_column_name: str):
+        return self._RENAME_COLUMN_TEMPLATE.format(
+            table_name=model._meta.db_table,
+            old_column_name=old_column_name,
+            new_column_name=new_column_name,
+        )
+
+    def change_column(
+        self, model: "Type[Model]", old_column_name: str, new_column_name: str, new_column_type: str
+    ):
+        return self._CHANGE_COLUMN_TEMPLATE.format(
+            table_name=model._meta.db_table,
+            old_column_name=old_column_name,
+            new_column_name=new_column_name,
+            new_column_type=new_column_type,
+        )
+
     def add_index(self, model: "Type[Model]", field_names: List[str], unique=False):
         return self._ADD_INDEX_TEMPLATE.format(
-            unique="UNIQUE" if unique else "",
+            unique="UNIQUE " if unique else "",
             index_name=self.schema_generator._generate_index_name(
                 "idx" if not unique else "uid", model, field_names
             ),
@@ -116,39 +195,55 @@ class BaseDDL:
             table_name=model._meta.db_table,
         )
 
-    def add_fk(self, model: "Type[Model]", field: ForeignKeyFieldInstance):
+    def add_fk(self, model: "Type[Model]", field_describe: dict, reference_table_describe: dict):
         db_table = model._meta.db_table
-        to_field_name = field.to_field_instance.source_field
-        if not to_field_name:
-            to_field_name = field.to_field_instance.model_field_name
 
-        db_column = field.source_field or field.model_field_name + "_id"
+        db_column = field_describe.get("raw_field")
+        reference_id = reference_table_describe.get("pk_field").get("db_column")
         fk_name = self.schema_generator._generate_fk_name(
             from_table=db_table,
             from_field=db_column,
-            to_table=field.related_model._meta.db_table,
+            to_table=reference_table_describe.get("table"),
-            to_field=to_field_name,
+            to_field=reference_table_describe.get("pk_field").get("db_column"),
         )
         return self._ADD_FK_TEMPLATE.format(
             table_name=db_table,
             fk_name=fk_name,
             db_column=db_column,
-            table=field.related_model._meta.db_table,
+            table=reference_table_describe.get("table"),
-            field=to_field_name,
+            field=reference_id,
-            on_delete=field.on_delete,
+            on_delete=field_describe.get("on_delete"),
         )
 
-    def drop_fk(self, model: "Type[Model]", field: ForeignKeyFieldInstance):
+    def drop_fk(self, model: "Type[Model]", field_describe: dict, reference_table_describe: dict):
-        to_field_name = field.to_field_instance.source_field
-        if not to_field_name:
-            to_field_name = field.to_field_instance.model_field_name
         db_table = model._meta.db_table
         return self._DROP_FK_TEMPLATE.format(
             table_name=db_table,
             fk_name=self.schema_generator._generate_fk_name(
                 from_table=db_table,
-                from_field=field.source_field or field.model_field_name + "_id",
+                from_field=field_describe.get("raw_field"),
-                to_table=field.related_model._meta.db_table,
+                to_table=reference_table_describe.get("table"),
-                to_field=to_field_name,
+                to_field=reference_table_describe.get("pk_field").get("db_column"),
             ),
         )
+
+    def alter_column_default(self, model: "Type[Model]", field_describe: dict):
+        db_table = model._meta.db_table
+        default = self._get_default(model, field_describe)
+        return self._ALTER_DEFAULT_TEMPLATE.format(
+            table_name=db_table,
+            column=field_describe.get("db_column"),
+            default="SET" + default if default is not None else "DROP DEFAULT",
+        )
+
+    def alter_column_null(self, model: "Type[Model]", field_describe: dict):
+        return self.modify_column(model, field_describe)
+
+    def set_comment(self, model: "Type[Model]", field_describe: dict):
+        return self.modify_column(model, field_describe)
+
+    def rename_table(self, model: "Type[Model]", old_table_name: str, new_table_name: str):
+        db_table = model._meta.db_table
+        return self._RENAME_TABLE_TEMPLATE.format(
+            table_name=db_table, old_table_name=old_table_name, new_table_name=new_table_name
+        )

aerich/ddl/mysql/__init__.py

@@ -6,3 +6,22 @@ from aerich.ddl import BaseDDL
 class MysqlDDL(BaseDDL):
     schema_generator_cls = MySQLSchemaGenerator
     DIALECT = MySQLSchemaGenerator.DIALECT
+    _DROP_TABLE_TEMPLATE = "DROP TABLE IF EXISTS `{table_name}`"
+    _ADD_COLUMN_TEMPLATE = "ALTER TABLE `{table_name}` ADD {column}"
+    _ALTER_DEFAULT_TEMPLATE = "ALTER TABLE `{table_name}` ALTER COLUMN `{column}` {default}"
+    _CHANGE_COLUMN_TEMPLATE = (
+        "ALTER TABLE `{table_name}` CHANGE {old_column_name} {new_column_name} {new_column_type}"
+    )
+    _DROP_COLUMN_TEMPLATE = "ALTER TABLE `{table_name}` DROP COLUMN `{column_name}`"
+    _RENAME_COLUMN_TEMPLATE = (
+        "ALTER TABLE `{table_name}` RENAME COLUMN `{old_column_name}` TO `{new_column_name}`"
+    )
+    _ADD_INDEX_TEMPLATE = (
+        "ALTER TABLE `{table_name}` ADD {unique}INDEX `{index_name}` ({column_names})"
+    )
+    _DROP_INDEX_TEMPLATE = "ALTER TABLE `{table_name}` DROP INDEX `{index_name}`"
+    _ADD_FK_TEMPLATE = "ALTER TABLE `{table_name}` ADD CONSTRAINT `{fk_name}` FOREIGN KEY (`{db_column}`) REFERENCES `{table}` (`{field}`) ON DELETE {on_delete}"
+    _DROP_FK_TEMPLATE = "ALTER TABLE `{table_name}` DROP FOREIGN KEY `{fk_name}`"
+    _M2M_TABLE_TEMPLATE = "CREATE TABLE `{table_name}` (`{backward_key}` {backward_type} NOT NULL REFERENCES `{backward_table}` (`{backward_field}`) ON DELETE CASCADE,`{forward_key}` {forward_type} NOT NULL REFERENCES `{forward_table}` (`{forward_field}`) ON DELETE CASCADE){extra}{comment}"
+    _MODIFY_COLUMN_TEMPLATE = "ALTER TABLE `{table_name}` MODIFY COLUMN {column}"
+    _RENAME_TABLE_TEMPLATE = "ALTER TABLE `{old_table_name}` RENAME TO `{new_table_name}`"

aerich/ddl/postgres/__init__.py

@@ -0,0 +1,49 @@
+from typing import Type
+
+from tortoise import Model
+from tortoise.backends.asyncpg.schema_generator import AsyncpgSchemaGenerator
+
+from aerich.ddl import BaseDDL
+
+
+class PostgresDDL(BaseDDL):
+    schema_generator_cls = AsyncpgSchemaGenerator
+    DIALECT = AsyncpgSchemaGenerator.DIALECT
+    _ADD_INDEX_TEMPLATE = 'CREATE {unique}INDEX "{index_name}" ON "{table_name}" ({column_names})'
+    _DROP_INDEX_TEMPLATE = 'DROP INDEX "{index_name}"'
+    _ALTER_NULL_TEMPLATE = 'ALTER TABLE "{table_name}" ALTER COLUMN "{column}" {set_drop} NOT NULL'
+    _MODIFY_COLUMN_TEMPLATE = (
+        'ALTER TABLE "{table_name}" ALTER COLUMN "{column}" TYPE {datatype}{using}'
+    )
+    _SET_COMMENT_TEMPLATE = 'COMMENT ON COLUMN "{table_name}"."{column}" IS {comment}'
+    _DROP_FK_TEMPLATE = 'ALTER TABLE "{table_name}" DROP CONSTRAINT "{fk_name}"'
+
+    def alter_column_null(self, model: "Type[Model]", field_describe: dict):
+        db_table = model._meta.db_table
+        return self._ALTER_NULL_TEMPLATE.format(
+            table_name=db_table,
+            column=field_describe.get("db_column"),
+            set_drop="DROP" if field_describe.get("nullable") else "SET",
+        )
+
+    def modify_column(self, model: "Type[Model]", field_describe: dict, is_pk: bool = False):
+        db_table = model._meta.db_table
+        db_field_types = field_describe.get("db_field_types")
+        db_column = field_describe.get("db_column")
+        datatype = db_field_types.get(self.DIALECT) or db_field_types.get("")
+        return self._MODIFY_COLUMN_TEMPLATE.format(
+            table_name=db_table,
+            column=db_column,
+            datatype=datatype,
+            using=f' USING "{db_column}"::{datatype}',
+        )
+
+    def set_comment(self, model: "Type[Model]", field_describe: dict):
+        db_table = model._meta.db_table
+        return self._SET_COMMENT_TEMPLATE.format(
+            table_name=db_table,
+            column=field_describe.get("db_column") or field_describe.get("raw_field"),
+            comment="'{}'".format(field_describe.get("description"))
+            if field_describe.get("description")
+            else "NULL",
+        )

aerich/ddl/sqlite/__init__.py

@@ -0,0 +1,24 @@
+from typing import Type
+
+from tortoise import Model
+from tortoise.backends.sqlite.schema_generator import SqliteSchemaGenerator
+
+from aerich.ddl import BaseDDL
+from aerich.exceptions import NotSupportError
+
+
+class SqliteDDL(BaseDDL):
+    schema_generator_cls = SqliteSchemaGenerator
+    DIALECT = SqliteSchemaGenerator.DIALECT
+
+    def modify_column(self, model: "Type[Model]", field_object: dict, is_pk: bool = True):
+        raise NotSupportError("Modify column is unsupported in SQLite.")
+
+    def alter_column_default(self, model: "Type[Model]", field_describe: dict):
+        raise NotSupportError("Alter column default is unsupported in SQLite.")
+
+    def alter_column_null(self, model: "Type[Model]", field_describe: dict):
+        raise NotSupportError("Alter column null is unsupported in SQLite.")
+
+    def set_comment(self, model: "Type[Model]", field_describe: dict):
+        raise NotSupportError("Alter column comment is unsupported in SQLite.")

aerich/enums.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class Color(str, Enum):
+    green = "green"
+    red = "red"
+    yellow = "yellow"

aerich/exceptions.py

@@ -1,6 +1,10 @@
-class ConfigurationError(Exception):
+class NotSupportError(Exception):
     """
-    config error
+    raise when features not support
     """
 
-    pass
+
+class DowngradeError(Exception):
+    """
+    raise when downgrade error
+    """

aerich/inspectdb.py

@@ -0,0 +1,86 @@
+import sys
+from typing import List, Optional
+
+from ddlparse import DdlParse
+from tortoise import BaseDBAsyncClient
+
+
+class InspectDb:
+    _table_template = "class {table}(Model):\n"
+    _field_template_mapping = {
+        "INT": "    {field} = fields.IntField({pk}{unique}{comment})",
+        "SMALLINT": "    {field} = fields.IntField({pk}{unique}{comment})",
+        "TINYINT": "    {field} = fields.BooleanField({null}{default}{comment})",
+        "VARCHAR": "    {field} = fields.CharField({pk}{unique}{length}{null}{default}{comment})",
+        "LONGTEXT": "    {field} = fields.TextField({null}{default}{comment})",
+        "TEXT": "    {field} = fields.TextField({null}{default}{comment})",
+        "DATETIME": "    {field} = fields.DatetimeField({null}{default}{comment})",
+        "FLOAT": "    {field} = fields.FloatField({null}{default}{comment})",
+    }
+
+    def __init__(self, conn: BaseDBAsyncClient, tables: Optional[List[str]] = None):
+        self.conn = conn
+        self.tables = tables
+        self.DIALECT = conn.schema_generator.DIALECT
+
+    async def show_create_tables(self):
+        if self.DIALECT == "mysql":
+            if not self.tables:
+                sql_tables = f"SELECT table_name FROM information_schema.tables WHERE table_schema = '{self.conn.database}';"  # nosec: B608
+                ret = await self.conn.execute_query(sql_tables)
+                self.tables = map(lambda x: x["TABLE_NAME"], ret[1])
+            for table in self.tables:
+                sql_show_create_table = f"SHOW CREATE TABLE {table}"
+                ret = await self.conn.execute_query(sql_show_create_table)
+                yield ret[1][0]["Create Table"]
+        else:
+            raise NotImplementedError("Currently only support MySQL")
+
+    async def inspect(self):
+        ddl_list = self.show_create_tables()
+        result = "from tortoise import Model, fields\n\n\n"
+        tables = []
+        async for ddl in ddl_list:
+            parser = DdlParse(ddl, DdlParse.DATABASE.mysql)
+            table = parser.parse()
+            name = table.name.title()
+            columns = table.columns
+            fields = []
+            model = self._table_template.format(table=name)
+            for column_name, column in columns.items():
+                comment = default = length = unique = null = pk = ""
+                if column.primary_key:
+                    pk = "pk=True, "
+                if column.unique:
+                    unique = "unique=True, "
+                if column.data_type == "VARCHAR":
+                    length = f"max_length={column.length}, "
+                if not column.not_null:
+                    null = "null=True, "
+                if column.default is not None:
+                    if column.data_type == "TINYINT":
+                        default = f"default={'True' if column.default == '1' else 'False'}, "
+                    elif column.data_type == "DATETIME":
+                        if "CURRENT_TIMESTAMP" in column.default:
+                            if "ON UPDATE CURRENT_TIMESTAMP" in ddl:
+                                default = "auto_now_add=True, "
+                            else:
+                                default = "auto_now=True, "
+                    else:
+                        default = f"default={column.default}, "
+
+                if column.comment:
+                    comment = f"description='{column.comment}', "
+
+                field = self._field_template_mapping[column.data_type].format(
+                    field=column_name,
+                    pk=pk,
+                    unique=unique,
+                    length=length,
+                    null=null,
+                    default=default,
+                    comment=comment,
+                )
+                fields.append(field)
+            tables.append(model + "\n".join(fields))
+        sys.stdout.write(result + "\n\n\n".join(tables))

aerich/migrate.py

@@ -1,25 +1,21 @@
-import json
 import os
-import re
-from copy import deepcopy
 from datetime import datetime
-from typing import Dict, List, Type
+from pathlib import Path
+from typing import Dict, List, Optional, Tuple, Type
 
-from tortoise import (
+import click
-    BackwardFKRelation,
+from dictdiffer import diff
-    BackwardOneToOneRelation,
+from tortoise import BaseDBAsyncClient, Model, Tortoise
-    ForeignKeyFieldInstance,
+from tortoise.exceptions import OperationalError
-    ManyToManyFieldInstance,
-    Model,
-    Tortoise,
-)
-from tortoise.backends.mysql.schema_generator import MySQLSchemaGenerator
-from tortoise.fields import Field
 
 from aerich.ddl import BaseDDL
-from aerich.ddl.mysql import MysqlDDL
+from aerich.models import MAX_VERSION_LENGTH, Aerich
-from aerich.exceptions import ConfigurationError
+from aerich.utils import (
-from aerich.utils import get_app_connection
+    get_app_connection,
+    get_models_describe,
+    is_default_function,
+    write_version_file,
+)
 
 
 class Migrate:
@@ -29,94 +25,120 @@ class Migrate:
     _downgrade_fk_m2m_index_operators: List[str] = []
     _upgrade_m2m: List[str] = []
     _downgrade_m2m: List[str] = []
+    _aerich = Aerich.__name__
+    _rename_old = []
+    _rename_new = []
 
     ddl: BaseDDL
-    migrate_config: dict
+    _last_version_content: Optional[dict] = None
-    old_models = "old_models"
-    diff_app = "diff_models"
     app: str
     migrate_location: str
+    dialect: str
+    _db_version: Optional[str] = None
 
     @classmethod
-    def get_old_model_file(cls):
+    def get_all_version_files(cls) -> List[str]:
-        return cls.old_models + ".py"
+        return sorted(
+            filter(lambda x: x.endswith("sql"), os.listdir(cls.migrate_location)),
+            key=lambda x: int(x.split("_")[0]),
+        )
 
     @classmethod
-    def _get_all_migrate_files(cls):
+    def _get_model(cls, model: str) -> Type[Model]:
-        return sorted(filter(lambda x: x.endswith("json"), os.listdir(cls.migrate_location)))
+        return Tortoise.apps.get(cls.app).get(model)
 
     @classmethod
-    def _get_latest_version(cls) -> int:
+    async def get_last_version(cls) -> Optional[Aerich]:
-        ret = cls._get_all_migrate_files()
+        try:
-        if ret:
+            return await Aerich.filter(app=cls.app).first()
-            return int(ret[-1].split("_")[0])
+        except OperationalError:
-        return 0
+            pass
 
     @classmethod
-    def get_all_version_files(cls, is_all=True):
+    async def _get_db_version(cls, connection: BaseDBAsyncClient):
-        files = cls._get_all_migrate_files()
+        if cls.dialect == "mysql":
-        ret = []
+            sql = "select version() as version"
-        for file in files:
+            ret = await connection.execute_query(sql)
-            with open(os.path.join(cls.migrate_location, file), "r") as f:
+            cls._db_version = ret[1][0].get("version")
-                content = json.load(f)
-                if is_all or not content.get("migrate"):
-                    ret.append(file)
-        return ret
 
     @classmethod
-    async def init_with_old_models(cls, config: dict, app: str, location: str):
+    async def init(cls, config: dict, app: str, location: str):
-        migrate_config = cls._get_migrate_config(config, app, location)
+        await Tortoise.init(config=config)
-
+        last_version = await cls.get_last_version()
         cls.app = app
-        cls.migrate_config = migrate_config
+        cls.migrate_location = Path(location, app)
-        cls.migrate_location = os.path.join(location, app)
+        if last_version:
-
+            cls._last_version_content = last_version.content
-        await Tortoise.init(config=migrate_config)
 
         connection = get_app_connection(config, app)
-        if connection.schema_generator is MySQLSchemaGenerator:
+        cls.dialect = connection.schema_generator.DIALECT
+        if cls.dialect == "mysql":
+            from aerich.ddl.mysql import MysqlDDL
+
             cls.ddl = MysqlDDL(connection)
-        else:
+        elif cls.dialect == "sqlite":
-            raise NotImplementedError("Current only support MySQL")
+            from aerich.ddl.sqlite import SqliteDDL
+
+            cls.ddl = SqliteDDL(connection)
+        elif cls.dialect == "postgres":
+            from aerich.ddl.postgres import PostgresDDL
+
+            cls.ddl = PostgresDDL(connection)
+        await cls._get_db_version(connection)
 
     @classmethod
-    def _generate_diff_sql(cls, name):
+    async def _get_last_version_num(cls):
-        now = datetime.now().strftime("%Y%M%D%H%M%S").replace("/", "")
+        last_version = await cls.get_last_version()
-        filename = f"{cls._get_latest_version() + 1}_{now}_{name}.json"
+        if not last_version:
+            return None
+        version = last_version.version
+        return int(version.split("_", 1)[0])
+
+    @classmethod
+    async def generate_version(cls, name=None):
+        now = datetime.now().strftime("%Y%m%d%H%M%S").replace("/", "")
+        last_version_num = await cls._get_last_version_num()
+        if last_version_num is None:
+            return f"0_{now}_init.sql"
+        version = f"{last_version_num + 1}_{now}_{name}.sql"
+        if len(version) > MAX_VERSION_LENGTH:
+            raise ValueError(f"Version name exceeds maximum length ({MAX_VERSION_LENGTH})")
+        return version
+
+    @classmethod
+    async def _generate_diff_sql(cls, name):
+        version = await cls.generate_version(name)
+        # delete if same version exists
+        for version_file in cls.get_all_version_files():
+            if version_file.startswith(version.split("_")[0]):
+                os.unlink(Path(cls.migrate_location, version_file))
         content = {
-            "upgrade": cls.upgrade_operators,
+            "upgrade": list(dict.fromkeys(cls.upgrade_operators)),
-            "downgrade": cls.downgrade_operators,
+            "downgrade": list(dict.fromkeys(cls.downgrade_operators)),
-            "migrate": False,
         }
-        with open(os.path.join(cls.migrate_location, filename), "w") as f:
+        write_version_file(Path(cls.migrate_location, version), content)
-            json.dump(content, f, indent=2, ensure_ascii=False)
+        return version
-        return filename
 
     @classmethod
-    def migrate(cls, name):
+    async def migrate(cls, name) -> str:
         """
         diff old models and new models to generate diff content
         :param name:
         :return:
         """
-        if not cls.migrate_config:
+        new_version_content = get_models_describe(cls.app)
-            raise ConfigurationError("You must call init_with_old_models() first!")
+        cls.diff_models(cls._last_version_content, new_version_content)
-        apps = Tortoise.apps
+        cls.diff_models(new_version_content, cls._last_version_content, False)
-        diff_models = apps.get(cls.diff_app)
-        app_models = apps.get(cls.app)
-
-        cls._diff_models(diff_models, app_models)
-        cls._diff_models(app_models, diff_models, False)
 
         cls._merge_operators()
 
         if not cls.upgrade_operators:
-            return False
+            return ""
 
-        return cls._generate_diff_sql(name)
+        return await cls._generate_diff_sql(name)
 
     @classmethod
-    def _add_operator(cls, operator: str, upgrade=True, fk=False):
+    def _add_operator(cls, operator: str, upgrade=True, fk_m2m=False):
         """
         add operator,differentiate fk because fk is order limit
         :param operator:
@@ -125,70 +147,18 @@ class Migrate:
         :return:
         """
         if upgrade:
-            if fk:
+            if fk_m2m:
                 cls._upgrade_fk_m2m_index_operators.append(operator)
             else:
                 cls.upgrade_operators.append(operator)
         else:
-            if fk:
+            if fk_m2m:
                 cls._downgrade_fk_m2m_index_operators.append(operator)
             else:
                 cls.downgrade_operators.append(operator)
 
     @classmethod
-    def cp_models(
+    def diff_models(cls, old_models: Dict[str, dict], new_models: Dict[str, dict], upgrade=True):
-        cls, app: str, model_files: List[str], old_model_file,
-    ):
-        """
-        cp currents models to old_model_files
-        :param app:
-        :param model_files:
-        :param old_model_file:
-        :return:
-        """
-        pattern = rf"\(('|\")({app})(.\w+)('|\")"
-        for i, model_file in enumerate(model_files):
-            with open(model_file, "r") as f:
-                content = f.read()
-            ret = re.sub(pattern, rf"(\1{cls.diff_app}\3\4", content)
-            with open(old_model_file, "w" if i == 0 else "w+a") as f:
-                f.write(ret)
-
-    @classmethod
-    def _get_migrate_config(cls, config: dict, app: str, location: str):
-        """
-        generate tmp config with old models
-        :param config:
-        :param app:
-        :param location:
-        :return:
-        """
-        temp_config = deepcopy(config)
-        path = os.path.join(location, app, cls.old_models)
-        path = path.replace("/", ".").lstrip(".")
-        temp_config["apps"][cls.diff_app] = {"models": [path]}
-        return temp_config
-
-    @classmethod
-    def write_old_models(cls, config: dict, app: str, location: str):
-        """
-        write new models to old models
-        :param config:
-        :param app:
-        :param location:
-        :return:
-        """
-        old_model_files = []
-        models = config.get("apps").get(app).get("models")
-        for model in models:
-            old_model_files.append(model.replace(".", "/") + ".py")
-
-        cls.cp_models(app, old_model_files, os.path.join(location, app, cls.get_old_model_file()))
-
-    @classmethod
-    def _diff_models(
-        cls, old_models: Dict[str, Type[Model]], new_models: Dict[str, Type[Model]], upgrade=True
-    ):
         """
         diff models and add operators
         :param old_models:
@@ -196,177 +166,358 @@ class Migrate:
         :param upgrade:
         :return:
         """
-        for new_model_str, new_model in new_models.items():
+        _aerich = f"{cls.app}.{cls._aerich}"
+        old_models.pop(_aerich, None)
+        new_models.pop(_aerich, None)
+
+        for new_model_str, new_model_describe in new_models.items():
+            model = cls._get_model(new_model_describe.get("name").split(".")[1])
+
             if new_model_str not in old_models.keys():
-                cls._add_operator(cls.add_model(new_model), upgrade)
+                if upgrade:
+                    cls._add_operator(cls.add_model(model), upgrade)
                 else:
-                cls.diff_model(old_models.get(new_model_str), new_model, upgrade)
+                    # we can't find origin model when downgrade, so skip
+                    pass
+            else:
+                old_model_describe = old_models.get(new_model_str)
+                # rename table
+                new_table = new_model_describe.get("table")
+                old_table = old_model_describe.get("table")
+                if new_table != old_table:
+                    cls._add_operator(cls.rename_table(model, old_table, new_table), upgrade)
+                old_unique_together = set(
+                    map(lambda x: tuple(x), old_model_describe.get("unique_together"))
+                )
+                new_unique_together = set(
+                    map(lambda x: tuple(x), new_model_describe.get("unique_together"))
+                )
+
+                old_pk_field = old_model_describe.get("pk_field")
+                new_pk_field = new_model_describe.get("pk_field")
+                # pk field
+                changes = diff(old_pk_field, new_pk_field)
+                for action, option, change in changes:
+                    # current only support rename pk
+                    if action == "change" and option == "name":
+                        cls._add_operator(cls._rename_field(model, *change), upgrade)
+                # m2m fields
+                old_m2m_fields = old_model_describe.get("m2m_fields")
+                new_m2m_fields = new_model_describe.get("m2m_fields")
+                for action, option, change in diff(old_m2m_fields, new_m2m_fields):
+                    if change[0][0] == "db_constraint":
+                        continue
+                    table = change[0][1].get("through")
+                    if action == "add":
+                        add = False
+                        if upgrade and table not in cls._upgrade_m2m:
+                            cls._upgrade_m2m.append(table)
+                            add = True
+                        elif not upgrade and table not in cls._downgrade_m2m:
+                            cls._downgrade_m2m.append(table)
+                            add = True
+                        if add:
+                            cls._add_operator(
+                                cls.create_m2m(
+                                    model,
+                                    change[0][1],
+                                    new_models.get(change[0][1].get("model_name")),
+                                ),
+                                upgrade,
+                                fk_m2m=True,
+                            )
+                    elif action == "remove":
+                        add = False
+                        if upgrade and table not in cls._upgrade_m2m:
+                            cls._upgrade_m2m.append(table)
+                            add = True
+                        elif not upgrade and table not in cls._downgrade_m2m:
+                            cls._downgrade_m2m.append(table)
+                            add = True
+                        if add:
+                            cls._add_operator(cls.drop_m2m(table), upgrade, fk_m2m=True)
+                # add unique_together
+                for index in new_unique_together.difference(old_unique_together):
+                    cls._add_operator(cls._add_index(model, index, True), upgrade, True)
+                # remove unique_together
+                for index in old_unique_together.difference(new_unique_together):
+                    cls._add_operator(cls._drop_index(model, index, True), upgrade, True)
+
+                old_data_fields = old_model_describe.get("data_fields")
+                new_data_fields = new_model_describe.get("data_fields")
+
+                old_data_fields_name = list(map(lambda x: x.get("name"), old_data_fields))
+                new_data_fields_name = list(map(lambda x: x.get("name"), new_data_fields))
+
+                # add fields or rename fields
+                for new_data_field_name in set(new_data_fields_name).difference(
+                    set(old_data_fields_name)
+                ):
+                    new_data_field = next(
+                        filter(lambda x: x.get("name") == new_data_field_name, new_data_fields)
+                    )
+                    is_rename = False
+                    for old_data_field in old_data_fields:
+                        changes = list(diff(old_data_field, new_data_field))
+                        old_data_field_name = old_data_field.get("name")
+                        if len(changes) == 2:
+                            # rename field
+                            if (
+                                changes[0]
+                                == (
+                                    "change",
+                                    "name",
+                                    (old_data_field_name, new_data_field_name),
+                                )
+                                and changes[1]
+                                == (
+                                    "change",
+                                    "db_column",
+                                    (
+                                        old_data_field.get("db_column"),
+                                        new_data_field.get("db_column"),
+                                    ),
+                                )
+                                and old_data_field_name not in new_data_fields_name
+                            ):
+                                if upgrade:
+                                    is_rename = click.prompt(
+                                        f"Rename {old_data_field_name} to {new_data_field_name}?",
+                                        default=True,
+                                        type=bool,
+                                        show_choices=True,
+                                    )
+                                else:
+                                    is_rename = old_data_field_name in cls._rename_new
+                                if is_rename:
+                                    cls._rename_new.append(new_data_field_name)
+                                    cls._rename_old.append(old_data_field_name)
+                                    # only MySQL8+ has rename syntax
+                                    if (
+                                        cls.dialect == "mysql"
+                                        and cls._db_version
+                                        and cls._db_version.startswith("5.")
+                                    ):
+                                        cls._add_operator(
+                                            cls._change_field(
+                                                model, old_data_field, new_data_field
+                                            ),
+                                            upgrade,
+                                        )
+                                    else:
+                                        cls._add_operator(
+                                            cls._rename_field(model, *changes[1][2]),
+                                            upgrade,
+                                        )
+                    if not is_rename:
+                        cls._add_operator(
+                            cls._add_field(
+                                model,
+                                new_data_field,
+                            ),
+                            upgrade,
+                        )
+                # remove fields
+                for old_data_field_name in set(old_data_fields_name).difference(
+                    set(new_data_fields_name)
+                ):
+                    # don't remove field if is rename
+                    if (upgrade and old_data_field_name in cls._rename_old) or (
+                        not upgrade and old_data_field_name in cls._rename_new
+                    ):
+                        continue
+                    cls._add_operator(
+                        cls._remove_field(
+                            model,
+                            next(
+                                filter(
+                                    lambda x: x.get("name") == old_data_field_name, old_data_fields
+                                )
+                            ).get("db_column"),
+                        ),
+                        upgrade,
+                    )
+                old_fk_fields = old_model_describe.get("fk_fields")
+                new_fk_fields = new_model_describe.get("fk_fields")
+
+                old_fk_fields_name = list(map(lambda x: x.get("name"), old_fk_fields))
+                new_fk_fields_name = list(map(lambda x: x.get("name"), new_fk_fields))
+
+                # add fk
+                for new_fk_field_name in set(new_fk_fields_name).difference(
+                    set(old_fk_fields_name)
+                ):
+                    fk_field = next(
+                        filter(lambda x: x.get("name") == new_fk_field_name, new_fk_fields)
+                    )
+                    if fk_field.get("db_constraint"):
+                        cls._add_operator(
+                            cls._add_fk(
+                                model, fk_field, new_models.get(fk_field.get("python_type"))
+                            ),
+                            upgrade,
+                            fk_m2m=True,
+                        )
+                # drop fk
+                for old_fk_field_name in set(old_fk_fields_name).difference(
+                    set(new_fk_fields_name)
+                ):
+                    old_fk_field = next(
+                        filter(lambda x: x.get("name") == old_fk_field_name, old_fk_fields)
+                    )
+                    if old_fk_field.get("db_constraint"):
+                        cls._add_operator(
+                            cls._drop_fk(
+                                model, old_fk_field, old_models.get(old_fk_field.get("python_type"))
+                            ),
+                            upgrade,
+                            fk_m2m=True,
+                        )
+                # change fields
+                for field_name in set(new_data_fields_name).intersection(set(old_data_fields_name)):
+                    old_data_field = next(
+                        filter(lambda x: x.get("name") == field_name, old_data_fields)
+                    )
+                    new_data_field = next(
+                        filter(lambda x: x.get("name") == field_name, new_data_fields)
+                    )
+                    changes = diff(old_data_field, new_data_field)
+                    for change in changes:
+                        _, option, old_new = change
+                        if option == "indexed":
+                            # change index
+                            unique = new_data_field.get("unique")
+                            if old_new[0] is False and old_new[1] is True:
+                                cls._add_operator(
+                                    cls._add_index(model, (field_name,), unique), upgrade, True
+                                )
+                            else:
+                                cls._add_operator(
+                                    cls._drop_index(model, (field_name,), unique), upgrade, True
+                                )
+                        elif option == "db_field_types.":
+                            # continue since repeated with others
+                            continue
+                        elif option == "default":
+                            if not (
+                                is_default_function(old_new[0]) or is_default_function(old_new[1])
+                            ):
+                                # change column default
+                                cls._add_operator(
+                                    cls._alter_default(model, new_data_field), upgrade
+                                )
+                        elif option == "unique":
+                            # because indexed include it
+                            continue
+                        elif option == "nullable":
+                            # change nullable
+                            cls._add_operator(cls._alter_null(model, new_data_field), upgrade)
+                        else:
+                            # modify column
+                            cls._add_operator(
+                                cls._modify_field(model, new_data_field),
+                                upgrade,
+                            )
 
         for old_model in old_models:
             if old_model not in new_models.keys():
-                cls._add_operator(cls.remove_model(old_models.get(old_model)), upgrade)
+                cls._add_operator(cls.drop_model(old_models.get(old_model).get("table")), upgrade)
+
+    @classmethod
+    def rename_table(cls, model: Type[Model], old_table_name: str, new_table_name: str):
+        return cls.ddl.rename_table(model, old_table_name, new_table_name)
 
     @classmethod
     def add_model(cls, model: Type[Model]):
         return cls.ddl.create_table(model)
 
     @classmethod
-    def remove_model(cls, model: Type[Model]):
+    def drop_model(cls, table_name: str):
-        return cls.ddl.drop_table(model)
+        return cls.ddl.drop_table(table_name)
 
     @classmethod
-    def diff_model(cls, old_model: Type[Model], new_model: Type[Model], upgrade=True):
+    def create_m2m(cls, model: Type[Model], field_describe: dict, reference_table_describe: dict):
-        """
+        return cls.ddl.create_m2m(model, field_describe, reference_table_describe)
-        diff single model
-        :param old_model:
-        :param new_model:
-        :param upgrade:
-        :return:
-        """
-        old_indexes = old_model._meta.indexes
-        new_indexes = new_model._meta.indexes
-
-        old_unique_together = old_model._meta.unique_together
-        new_unique_together = new_model._meta.unique_together
-
-        old_fields_map = old_model._meta.fields_map
-        new_fields_map = new_model._meta.fields_map
-
-        old_keys = old_fields_map.keys()
-        new_keys = new_fields_map.keys()
-        for new_key in new_keys:
-            new_field = new_fields_map.get(new_key)
-            if cls._exclude_field(new_field, upgrade):
-                continue
-            if new_key not in old_keys:
-                cls._add_operator(
-                    cls._add_field(new_model, new_field),
-                    upgrade,
-                    isinstance(new_field, (ForeignKeyFieldInstance, ManyToManyFieldInstance)),
-                )
-            else:
-                old_field = old_fields_map.get(new_key)
-                if (old_field.index and not new_field.index) or (
-                    old_field.unique and not new_field.unique
-                ):
-                    cls._add_operator(
-                        cls._remove_index(
-                            old_model, [old_field.model_field_name], old_field.unique
-                        ),
-                        upgrade,
-                        isinstance(old_field, (ForeignKeyFieldInstance, ManyToManyFieldInstance)),
-                    )
-                elif (new_field.index and not old_field.index) or (
-                    new_field.unique and not old_field.unique
-                ):
-                    cls._add_operator(
-                        cls._add_index(new_model, [new_field.model_field_name], new_field.unique),
-                        upgrade,
-                        isinstance(new_field, (ForeignKeyFieldInstance, ManyToManyFieldInstance)),
-                    )
-
-        for old_key in old_keys:
-            field = old_fields_map.get(old_key)
-            if old_key not in new_keys and not cls._exclude_field(field, upgrade):
-                cls._add_operator(
-                    cls._remove_field(old_model, field),
-                    upgrade,
-                    isinstance(field, (ForeignKeyFieldInstance, ManyToManyFieldInstance)),
-                )
-
-        for new_index in new_indexes:
-            if new_index not in old_indexes:
-                cls._add_operator(cls._add_index(new_model, new_index,), upgrade)
-        for old_index in old_indexes:
-            if old_index not in new_indexes:
-                cls._add_operator(cls._remove_index(old_model, old_index), upgrade)
-
-        for new_unique in new_unique_together:
-            if new_unique not in old_unique_together:
-                cls._add_operator(cls._add_index(new_model, new_unique, unique=True), upgrade)
-
-        for old_unique in old_unique_together:
-            if old_unique not in new_unique_together:
-                cls._add_operator(cls._remove_index(old_model, old_unique, unique=True), upgrade)
 
     @classmethod
-    def _resolve_fk_fields_name(cls, model: Type[Model], fields_name: List[str]):
+    def drop_m2m(cls, table_name: str):
+        return cls.ddl.drop_m2m(table_name)
+
+    @classmethod
+    def _resolve_fk_fields_name(cls, model: Type[Model], fields_name: Tuple[str]):
         ret = []
         for field_name in fields_name:
-            if field_name in model._meta.fk_fields:
+            field = model._meta.fields_map[field_name]
+            if field.source_field:
+                ret.append(field.source_field)
+            elif field_name in model._meta.fk_fields:
                 ret.append(field_name + "_id")
             else:
                 ret.append(field_name)
         return ret
 
     @classmethod
-    def _remove_index(cls, model: Type[Model], fields_name: List[str], unique=False):
+    def _drop_index(cls, model: Type[Model], fields_name: Tuple[str], unique=False):
         fields_name = cls._resolve_fk_fields_name(model, fields_name)
         return cls.ddl.drop_index(model, fields_name, unique)
 
     @classmethod
-    def _add_index(cls, model: Type[Model], fields_name: List[str], unique=False):
+    def _add_index(cls, model: Type[Model], fields_name: Tuple[str], unique=False):
         fields_name = cls._resolve_fk_fields_name(model, fields_name)
         return cls.ddl.add_index(model, fields_name, unique)
 
     @classmethod
-    def _exclude_field(cls, field: Field, upgrade=False):
+    def _add_field(cls, model: Type[Model], field_describe: dict, is_pk: bool = False):
-        """
+        return cls.ddl.add_column(model, field_describe, is_pk)
-        exclude BackwardFKRelation and repeat m2m field
-        :param field:
-        :return:
-        """
-        if isinstance(field, ManyToManyFieldInstance):
-            through = field.through
-            if upgrade:
-                if through in cls._upgrade_m2m:
-                    return True
-                else:
-                    cls._upgrade_m2m.append(through)
-                    return False
-            else:
-                if through in cls._downgrade_m2m:
-                    return True
-                else:
-                    cls._downgrade_m2m.append(through)
-                    return False
-        return isinstance(field, (BackwardFKRelation, BackwardOneToOneRelation))
 
     @classmethod
-    def _add_field(cls, model: Type[Model], field: Field):
+    def _alter_default(cls, model: Type[Model], field_describe: dict):
-        if isinstance(field, ForeignKeyFieldInstance):
+        return cls.ddl.alter_column_default(model, field_describe)
-            return cls.ddl.add_fk(model, field)
-        if isinstance(field, ManyToManyFieldInstance):
-            return cls.ddl.create_m2m_table(model, field)
-        return cls.ddl.add_column(model, field)
 
     @classmethod
-    def _remove_field(cls, model: Type[Model], field: Field):
+    def _alter_null(cls, model: Type[Model], field_describe: dict):
-        if isinstance(field, ForeignKeyFieldInstance):
+        return cls.ddl.alter_column_null(model, field_describe)
-            return cls.ddl.drop_fk(model, field)
-        if isinstance(field, ManyToManyFieldInstance):
-            return cls.ddl.drop_m2m(field)
-        return cls.ddl.drop_column(model, field.model_field_name)
 
     @classmethod
-    def _add_fk(cls, model: Type[Model], field: ForeignKeyFieldInstance):
+    def _set_comment(cls, model: Type[Model], field_describe: dict):
+        return cls.ddl.set_comment(model, field_describe)
+
+    @classmethod
+    def _modify_field(cls, model: Type[Model], field_describe: dict):
+        return cls.ddl.modify_column(model, field_describe)
+
+    @classmethod
+    def _drop_fk(cls, model: Type[Model], field_describe: dict, reference_table_describe: dict):
+        return cls.ddl.drop_fk(model, field_describe, reference_table_describe)
+
+    @classmethod
+    def _remove_field(cls, model: Type[Model], column_name: str):
+        return cls.ddl.drop_column(model, column_name)
+
+    @classmethod
+    def _rename_field(cls, model: Type[Model], old_field_name: str, new_field_name: str):
+        return cls.ddl.rename_column(model, old_field_name, new_field_name)
+
+    @classmethod
+    def _change_field(cls, model: Type[Model], old_field_describe: dict, new_field_describe: dict):
+        db_field_types = new_field_describe.get("db_field_types")
+        return cls.ddl.change_column(
+            model,
+            old_field_describe.get("db_column"),
+            new_field_describe.get("db_column"),
+            db_field_types.get(cls.dialect) or db_field_types.get(""),
+        )
+
+    @classmethod
+    def _add_fk(cls, model: Type[Model], field_describe: dict, reference_table_describe: dict):
         """
         add fk
         :param model:
-        :param field:
+        :param field_describe:
+        :param reference_table_describe:
         :return:
         """
-        return cls.ddl.add_fk(model, field)
+        return cls.ddl.add_fk(model, field_describe, reference_table_describe)
-
-    @classmethod
-    def _remove_fk(cls, model: Type[Model], field: ForeignKeyFieldInstance):
-        """
-        drop fk
-        :param model:
-        :param field:
-        :return:
-        """
-        return cls.ddl.drop_fk(model, field)
 
     @classmethod
     def _merge_operators(cls):

aerich/models.py

@@ -0,0 +1,12 @@
+from tortoise import Model, fields
+
+MAX_VERSION_LENGTH = 255
+
+
+class Aerich(Model):
+    version = fields.CharField(max_length=MAX_VERSION_LENGTH)
+    app = fields.CharField(max_length=20)
+    content = fields.JSONField()
+
+    class Meta:
+        ordering = ["-id"]

aerich/utils.py

@@ -1,20 +1,47 @@
 import importlib
+import os
+import re
+import sys
+from pathlib import Path
+from typing import Dict, Union
 
-from asyncclick import BadOptionUsage, Context
+from click import BadOptionUsage, ClickException, Context
-from tortoise import Tortoise
+from tortoise import BaseDBAsyncClient, Tortoise
 
 
-def get_app_connection_name(config, app):
+def add_src_path(path: str) -> str:
+    """
+    add a folder to the paths so we can import from there
+    :param path: path to add
+    :return: absolute path
+    """
+    if not os.path.isabs(path):
+        # use the absolute path, otherwise some other things (e.g. __file__) won't work properly
+        path = os.path.abspath(path)
+    if not os.path.isdir(path):
+        raise ClickException(f"Specified source folder does not exist: {path}")
+    if path not in sys.path:
+        sys.path.insert(0, path)
+    return path
+
+
+def get_app_connection_name(config, app_name: str) -> str:
     """
     get connection name
     :param config:
-    :param app:
+    :param app_name:
     :return:
     """
-    return config.get("apps").get(app).get("default_connection")
+    app = config.get("apps").get(app_name)
+    if app:
+        return app.get("default_connection", "default")
+    raise BadOptionUsage(
+        option_name="--app",
+        message=f'Can\'t get app named "{app_name}"',
+    )
 
 
-def get_app_connection(config, app):
+def get_app_connection(config, app) -> BaseDBAsyncClient:
     """
     get connection name
     :param config:
@@ -34,12 +61,11 @@ def get_tortoise_config(ctx: Context, tortoise_orm: str) -> dict:
     splits = tortoise_orm.split(".")
     config_path = ".".join(splits[:-1])
     tortoise_config = splits[-1]
+
     try:
         config_module = importlib.import_module(config_path)
-    except (ModuleNotFoundError, AttributeError):
+    except ModuleNotFoundError as e:
-        raise BadOptionUsage(
+        raise ClickException(f"Error while importing configuration module: {e}") from None
-            ctx=ctx, message=f'No config named "{config_path}"', option_name="--config"
-        )
 
     config = getattr(config_module, tortoise_config, None)
     if not config:
@@ -49,3 +75,74 @@ def get_tortoise_config(ctx: Context, tortoise_orm: str) -> dict:
             ctx=ctx,
         )
     return config
+
+
+_UPGRADE = "-- upgrade --\n"
+_DOWNGRADE = "-- downgrade --\n"
+
+
+def get_version_content_from_file(version_file: Union[str, Path]) -> Dict:
+    """
+    get version content
+    :param version_file:
+    :return:
+    """
+    with open(version_file, "r", encoding="utf-8") as f:
+        content = f.read()
+        first = content.index(_UPGRADE)
+        try:
+            second = content.index(_DOWNGRADE)
+        except ValueError:
+            second = len(content) - 1
+        upgrade_content = content[first + len(_UPGRADE) : second].strip()  # noqa:E203
+        downgrade_content = content[second + len(_DOWNGRADE) :].strip()  # noqa:E203
+        ret = {
+            "upgrade": list(filter(lambda x: x or False, upgrade_content.split(";\n"))),
+            "downgrade": list(filter(lambda x: x or False, downgrade_content.split(";\n"))),
+        }
+        return ret
+
+
+def write_version_file(version_file: Path, content: Dict):
+    """
+    write version file
+    :param version_file:
+    :param content:
+    :return:
+    """
+    with open(version_file, "w", encoding="utf-8") as f:
+        f.write(_UPGRADE)
+        upgrade = content.get("upgrade")
+        if len(upgrade) > 1:
+            f.write(";\n".join(upgrade))
+            if not upgrade[-1].endswith(";"):
+                f.write(";\n")
+        else:
+            f.write(f"{upgrade[0]}")
+            if not upgrade[0].endswith(";"):
+                f.write(";")
+            f.write("\n")
+        downgrade = content.get("downgrade")
+        if downgrade:
+            f.write(_DOWNGRADE)
+            if len(downgrade) > 1:
+                f.write(";\n".join(downgrade) + ";\n")
+            else:
+                f.write(f"{downgrade[0]};\n")
+
+
+def get_models_describe(app: str) -> Dict:
+    """
+    get app models describe
+    :param app:
+    :return:
+    """
+    ret = {}
+    for model in Tortoise.apps.get(app).values():
+        describe = model.describe()
+        ret[describe.get("name")] = describe
+    return ret
+
+
+def is_default_function(string: str):
+    return re.match(r"^<function.+>$", str(string or ""))

aerich/version.py

@@ -0,0 +1 @@
+__version__ = "0.5.7"

conftest.py

@@ -0,0 +1,65 @@
+import asyncio
+import os
+
+import pytest
+from tortoise import Tortoise, expand_db_url, generate_schema_for_client
+from tortoise.backends.asyncpg.schema_generator import AsyncpgSchemaGenerator
+from tortoise.backends.mysql.schema_generator import MySQLSchemaGenerator
+from tortoise.backends.sqlite.schema_generator import SqliteSchemaGenerator
+
+from aerich.ddl.mysql import MysqlDDL
+from aerich.ddl.postgres import PostgresDDL
+from aerich.ddl.sqlite import SqliteDDL
+from aerich.migrate import Migrate
+
+db_url = os.getenv("TEST_DB", "sqlite://:memory:")
+db_url_second = os.getenv("TEST_DB_SECOND", "sqlite://:memory:")
+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"},
+    },
+}
+
+
+@pytest.fixture(scope="function", autouse=True)
+def reset_migrate():
+    Migrate.upgrade_operators = []
+    Migrate.downgrade_operators = []
+    Migrate._upgrade_fk_m2m_index_operators = []
+    Migrate._downgrade_fk_m2m_index_operators = []
+    Migrate._upgrade_m2m = []
+    Migrate._downgrade_m2m = []
+
+
+@pytest.fixture(scope="session")
+def event_loop():
+    policy = asyncio.get_event_loop_policy()
+    res = policy.new_event_loop()
+    asyncio.set_event_loop(res)
+    res._close = res.close
+    res.close = lambda: None
+
+    yield res
+
+    res._close()
+
+
+@pytest.fixture(scope="session", autouse=True)
+async def initialize_tests(event_loop, request):
+    await Tortoise.init(config=tortoise_orm, _create_db=True)
+    await generate_schema_for_client(Tortoise.get_connection("default"), safe=True)
+
+    client = Tortoise.get_connection("default")
+    if client.schema_generator is MySQLSchemaGenerator:
+        Migrate.ddl = MysqlDDL(client)
+    elif client.schema_generator is SqliteSchemaGenerator:
+        Migrate.ddl = SqliteDDL(client)
+    elif client.schema_generator is AsyncpgSchemaGenerator:
+        Migrate.ddl = PostgresDDL(client)
+    Migrate.dialect = Migrate.ddl.DIALECT
+    request.addfinalizer(lambda: event_loop.run_until_complete(Tortoise._drop_databases()))

pyproject.toml

@@ -1,27 +1,48 @@
 [tool.poetry]
 name = "aerich"
-version = "0.1.1"
+version = "0.5.7"
 description = "A database migrations tool for Tortoise ORM."
 authors = ["long2ice <long2ice@gmail.com>"]
+license = "Apache-2.0"
+readme = "README.md"
+homepage = "https://github.com/tortoise/aerich"
+repository = "https://github.com/tortoise/aerich.git"
+documentation = "https://github.com/tortoise/aerich"
+keywords = ["migrate", "Tortoise-ORM", "mysql"]
+packages = [
+    { include = "aerich" }
+]
+include = ["CHANGELOG.md", "LICENSE", "README.md"]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.7"
-tortoise-orm = {git = "https://github.com/tortoise/tortoise-orm.git", branch = "develop"}
+tortoise-orm = "*"
-aiomysql = "*"
+click = "*"
-asyncclick = "*"
+pydantic = "*"
+aiomysql = { version = "*", optional = true }
+asyncpg = { version = "*", optional = true }
+ddlparse = "*"
+dictdiffer = "*"
 
 [tool.poetry.dev-dependencies]
-taskipy = "*"
-asynctest = "*"
 flake8 = "*"
 isort = "*"
-black = "^19.10b0"
+black = "*"
+pytest = "*"
+pytest-xdist = "*"
+pytest-asyncio = "*"
+bandit = "*"
+pytest-mock = "*"
+cryptography = "*"
 
-[tool.taskipy.tasks]
+[tool.poetry.extras]
-export = "poetry export -f requirements.txt --without-hashes > requirements.txt"
+asyncmy = ["asyncmy"]
-export-dev = "poetry export -f requirements.txt --dev --without-hashes > requirements-dev.txt"
+asyncpg = ["asyncpg"]
+aiomysql = ["aiomysql"]
 
 [build-system]
 requires = ["poetry>=0.12"]
 build-backend = "poetry.masonry.api"
 
+[tool.poetry.scripts]
+aerich = "aerich.cli:main"

requirements-dev.txt

@@ -1,31 +0,0 @@
-aiomysql==0.0.20
-aiosqlite==0.13.0
-anyio==1.3.0
-appdirs==1.4.4
-async-generator==1.10
-asyncclick==7.0.9
-asynctest==0.13.0
-attrs==19.3.0
-black==19.10b0
-cffi==1.14.0
-ciso8601==2.1.3; sys_platform != "win32" and implementation_name == "cpython"
-click==7.1.2
-cryptography==2.9.2
-flake8==3.8.1
-iso8601==0.1.12; sys_platform == "win32" or implementation_name != "cpython"
-isort==4.3.21
-mccabe==0.6.1
-pathspec==0.8.0
-pycodestyle==2.6.0
-pycparser==2.20
-pyflakes==2.2.0
-pymysql==0.9.2
-pypika==0.37.6
-regex==2020.5.14
-six==1.14.0
-sniffio==1.1.0
-taskipy==1.2.1
-toml==0.10.1
--e git+https://github.com/tortoise/tortoise-orm.git@95c384a4742ee5980f8e4ae934bfdb0d8137bb40#egg=tortoise-orm
-typed-ast==1.4.1
-typing-extensions==3.7.4.2

requirements.txt

@@ -1,15 +0,0 @@
-aiomysql==0.0.20
-aiosqlite==0.13.0
-anyio==1.3.0
-async-generator==1.10
-asyncclick==7.0.9
-cffi==1.14.0
-ciso8601==2.1.3; sys_platform != "win32" and implementation_name == "cpython"
-cryptography==2.9.2
-iso8601==0.1.12; sys_platform == "win32" or implementation_name != "cpython"
-pycparser==2.20
-pymysql==0.9.2
-pypika==0.37.6
-six==1.14.0
-sniffio==1.1.0
-typing-extensions==3.7.4.2

setup.cfg

@@ -1,18 +1,2 @@
 [flake8]
-max-line-length = 100
+ignore = E501,W503
-exclude =
-ignore = E501,W503,DAR101,DAR201,DAR402
-
-[darglint]
-docstring_style=sphinx
-
-[isort]
-not_skip=__init__.py
-multi_line_output=3
-include_trailing_comma=True
-force_grid_wrap=0
-use_parentheses=True
-line_length=100
-
-
-

setup.py

@@ -1,44 +0,0 @@
-import os
-import re
-from setuptools import find_packages, setup
-
-
-def version():
-    ver_str_line = open('aerich/__init__.py', 'rt').read()
-    mob = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", ver_str_line, re.M)
-    if not mob:
-        raise RuntimeError("Unable to find version string")
-    return mob.group(1)
-
-
-with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as f:
-    long_description = f.read()
-
-
-def requirements():
-    return open('requirements.txt', 'rt').read().splitlines()
-
-
-setup(
-    name='aerich',
-    version=version(),
-    description='A database migrations tool for Tortoise-ORM.',
-    author='long2ice',
-    long_description_content_type='text/x-rst',
-    long_description=long_description,
-    author_email='long2ice@gmail.com',
-    url='https://github.com/long2ice/aerich',
-    license='MIT License',
-    packages=find_packages(include=['aerich*']),
-    include_package_data=True,
-    zip_safe=True,
-    entry_points={
-        'console_scripts': ['aerich = aerich.cli:main'],
-    },
-    platforms='any',
-    keywords=(
-        'migrate Tortoise-ORM mysql'
-    ),
-    dependency_links=['https://github.com/tortoise/tortoise-orm.git@branch#egg=tortoise-orm'],
-    install_requires=requirements(),
-)

tests/backends/mysql/__init__.py

@@ -1,19 +0,0 @@
-from asynctest import TestCase
-from tortoise import Tortoise
-
-from aerich.ddl.mysql import MysqlDDL
-
-TORTOISE_ORM = {
-    "connections": {"default": "mysql://root:123456@127.0.0.1:3306/test",},
-    "apps": {"models": {"models": ["tests.models"], "default_connection": "default",},},
-}
-
-
-class DBTestCase(TestCase):
-    async def setUp(self) -> None:
-        await Tortoise.init(config=TORTOISE_ORM)
-        self.client = Tortoise.get_connection("default")
-        self.ddl = MysqlDDL(self.client)
-
-    async def tearDown(self) -> None:
-        await Tortoise.close_connections()

tests/backends/mysql/test_ddl.py

@@ -1,55 +0,0 @@
-from tests.backends.mysql import DBTestCase
-from tests.models import Category
-
-
-class TestDDL(DBTestCase):
-    def test_create_table(self):
-        ret = self.ddl.create_table(Category)
-        self.assertEqual(
-            ret,
-            """CREATE TABLE IF NOT EXISTS `category` (
-    `id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT,
-    `slug` VARCHAR(200) NOT NULL,
-    `name` VARCHAR(200) NOT NULL,
-    `created_at` DATETIME(6) NOT NULL  DEFAULT CURRENT_TIMESTAMP(6),
-    `user_id` INT NOT NULL COMMENT 'User',
-    CONSTRAINT `fk_category_user_e2e3874c` FOREIGN KEY (`user_id`) REFERENCES `user` (`id`) ON DELETE CASCADE
-) CHARACTER SET utf8mb4;""",
-        )
-
-    def test_drop_table(self):
-        ret = self.ddl.drop_table(Category)
-        self.assertEqual(ret, "DROP TABLE category IF EXISTS")
-
-    def test_add_column(self):
-        ret = self.ddl.add_column(Category, Category._meta.fields_map.get("name"))
-        self.assertEqual(ret, "ALTER TABLE category ADD `name` VARCHAR(200) NOT NULL")
-
-    def test_drop_column(self):
-        ret = self.ddl.drop_column(Category, "name")
-        self.assertEqual(ret, "ALTER TABLE category DROP COLUMN name")
-
-    def test_add_index(self):
-        ret = self.ddl.add_index(Category, ["name"])
-        self.assertEqual(ret, "ALTER TABLE category ADD  INDEX idx_category_name_8b0cb9 (`name`)")
-        ret = self.ddl.add_index(Category, ["name"], True)
-        self.assertEqual(
-            ret, "ALTER TABLE category ADD UNIQUE INDEX uid_category_name_8b0cb9 (`name`)"
-        )
-
-    def test_drop_index(self):
-        ret = self.ddl.drop_index(Category, ["name"])
-        self.assertEqual(ret, "ALTER TABLE category DROP INDEX idx_category_name_8b0cb9")
-        ret = self.ddl.drop_index(Category, ["name"], True)
-        self.assertEqual(ret, "ALTER TABLE category DROP INDEX uid_category_name_8b0cb9")
-
-    def test_add_fk(self):
-        ret = self.ddl.add_fk(Category, Category._meta.fields_map.get("user"))
-        self.assertEqual(
-            ret,
-            "ALTER TABLE category ADD CONSTRAINT `fk_category_user_366ffa6f` FOREIGN KEY (`user`) REFERENCES `user` (`id`) ON DELETE CASCADE",
-        )
-
-    def test_drop_fk(self):
-        ret = self.ddl.drop_fk(Category, Category._meta.fields_map.get("user"))
-        self.assertEqual(ret, "ALTER TABLE category DROP FOREIGN KEY fk_category_user_366ffa6f")

tests/backends/mysql/test_migrate.py

@@ -1,17 +0,0 @@
-from asynctest import TestCase
-from tortoise import Tortoise
-
-from aerich.migrate import Migrate
-from tests.backends.mysql import TORTOISE_ORM
-
-
-class TestMigrate(TestCase):
-    async def setUp(self) -> None:
-        await Migrate.init_with_old_models(TORTOISE_ORM, "models", "./migrations")
-
-    async def test_migrate(self):
-        Migrate.diff_model(
-            Tortoise.apps.get("models").get("Category"),
-            Tortoise.apps.get("diff_models").get("Category"),
-        )
-        print(Migrate.upgrade_operators)

tests/models.py

@@ -1,4 +1,5 @@
 import datetime
+import uuid
 from enum import IntEnum
 
 from tortoise import Model, fields
@@ -23,47 +24,56 @@ class Status(IntEnum):
 
 class User(Model):
     username = fields.CharField(max_length=20, unique=True)
-    password = fields.CharField(max_length=200)
+    password = fields.CharField(max_length=100)
     last_login = fields.DatetimeField(description="Last Login", default=datetime.datetime.now)
     is_active = fields.BooleanField(default=True, description="Is Active")
     is_superuser = fields.BooleanField(default=False, description="Is SuperUser")
-    avatar = fields.CharField(max_length=200, default="")
     intro = fields.TextField(default="")
 
-    def __str__(self):
+
-        return f"{self.pk}#{self.username}"
+class Email(Model):
+    email_id = fields.IntField(pk=True)
+    email = fields.CharField(max_length=200, index=True)
+    is_primary = fields.BooleanField(default=False)
+    address = fields.CharField(max_length=200)
+    users = fields.ManyToManyField("models.User")
+
+
+def default_name():
+    return uuid.uuid4()
 
 
 class Category(Model):
-    slug = fields.CharField(max_length=200)
+    slug = fields.CharField(max_length=100)
-    name = fields.CharField(max_length=200)
+    name = fields.CharField(max_length=200, null=True, default=default_name)
     user = fields.ForeignKeyField("models.User", description="User")
     created_at = fields.DatetimeField(auto_now_add=True)
 
-    def __str__(self):
-        return f"{self.pk}#{self.name}"
-
 
 class Product(Model):
     categories = fields.ManyToManyField("models.Category")
     name = fields.CharField(max_length=50)
-    view_num = fields.IntField(description="View Num")
+    view_num = fields.IntField(description="View Num", default=0)
     sort = fields.IntField()
     is_reviewed = fields.BooleanField(description="Is Reviewed")
-    type = fields.IntEnumField(ProductType, description="Product Type")
+    type = fields.IntEnumField(
-    image = fields.CharField(max_length=200)
+        ProductType, description="Product Type", source_field="type_db_alias"
+    )
+    pic = fields.CharField(max_length=200)
     body = fields.TextField()
     created_at = fields.DatetimeField(auto_now_add=True)
 
-    def __str__(self):
+    class Meta:
-        return f"{self.pk}#{self.name}"
+        unique_together = (("name", "type"),)
 
 
 class Config(Model):
     label = fields.CharField(max_length=200)
     key = fields.CharField(max_length=20)
     value = fields.JSONField()
-    status: Status = fields.IntEnumField(Status, default=Status.on)
+    status: Status = fields.IntEnumField(Status)
+    user = fields.ForeignKeyField("models.User", description="User")
 
-    def __str__(self):
+
-        return f"{self.pk}#{self.label}"
+class NewModel(Model):
+    name = fields.CharField(max_length=50)

tests/models_second.py

@@ -0,0 +1,65 @@
+import datetime
+from enum import IntEnum
+
+from tortoise import Model, fields
+
+
+class ProductType(IntEnum):
+    article = 1
+    page = 2
+
+
+class PermissionAction(IntEnum):
+    create = 1
+    delete = 2
+    update = 3
+    read = 4
+
+
+class Status(IntEnum):
+    on = 1
+    off = 0
+
+
+class User(Model):
+    username = fields.CharField(max_length=20, unique=True)
+    password = fields.CharField(max_length=200)
+    last_login = fields.DatetimeField(description="Last Login", default=datetime.datetime.now)
+    is_active = fields.BooleanField(default=True, description="Is Active")
+    is_superuser = fields.BooleanField(default=False, description="Is SuperUser")
+    avatar = fields.CharField(max_length=200, default="")
+    intro = fields.TextField(default="")
+
+
+class Email(Model):
+    email = fields.CharField(max_length=200)
+    is_primary = fields.BooleanField(default=False)
+    user = fields.ForeignKeyField("models_second.User", db_constraint=False)
+
+
+class Category(Model):
+    slug = fields.CharField(max_length=200)
+    name = fields.CharField(max_length=200)
+    user = fields.ForeignKeyField("models_second.User", description="User")
+    created_at = fields.DatetimeField(auto_now_add=True)
+
+
+class Product(Model):
+    categories = fields.ManyToManyField("models_second.Category")
+    name = fields.CharField(max_length=50)
+    view_num = fields.IntField(description="View Num")
+    sort = fields.IntField()
+    is_reviewed = fields.BooleanField(description="Is Reviewed")
+    type = fields.IntEnumField(
+        ProductType, description="Product Type", source_field="type_db_alias"
+    )
+    image = fields.CharField(max_length=200)
+    body = fields.TextField()
+    created_at = fields.DatetimeField(auto_now_add=True)
+
+
+class Config(Model):
+    label = fields.CharField(max_length=200)
+    key = fields.CharField(max_length=20)
+    value = fields.JSONField()
+    status: Status = fields.IntEnumField(Status, default=Status.on)

tests/old_models.py

@@ -0,0 +1,68 @@
+import datetime
+from enum import IntEnum
+
+from tortoise import Model, fields
+
+
+class ProductType(IntEnum):
+    article = 1
+    page = 2
+
+
+class PermissionAction(IntEnum):
+    create = 1
+    delete = 2
+    update = 3
+    read = 4
+
+
+class Status(IntEnum):
+    on = 1
+    off = 0
+
+
+class User(Model):
+    username = fields.CharField(max_length=20)
+    password = fields.CharField(max_length=200)
+    last_login = fields.DatetimeField(description="Last Login", default=datetime.datetime.now)
+    is_active = fields.BooleanField(default=True, description="Is Active")
+    is_superuser = fields.BooleanField(default=False, description="Is SuperUser")
+    avatar = fields.CharField(max_length=200, default="")
+    intro = fields.TextField(default="")
+
+
+class Email(Model):
+    email = fields.CharField(max_length=200)
+    is_primary = fields.BooleanField(default=False)
+    user = fields.ForeignKeyField("models.User", db_constraint=False)
+
+
+class Category(Model):
+    slug = fields.CharField(max_length=200)
+    name = fields.CharField(max_length=200)
+    user = fields.ForeignKeyField("models.User", description="User")
+    created_at = fields.DatetimeField(auto_now_add=True)
+
+
+class Product(Model):
+    categories = fields.ManyToManyField("models.Category")
+    name = fields.CharField(max_length=50)
+    view_num = fields.IntField(description="View Num")
+    sort = fields.IntField()
+    is_reviewed = fields.BooleanField(description="Is Reviewed")
+    type = fields.IntEnumField(
+        ProductType, description="Product Type", source_field="type_db_alias"
+    )
+    image = fields.CharField(max_length=200)
+    body = fields.TextField()
+    created_at = fields.DatetimeField(auto_now_add=True)
+
+
+class Config(Model):
+    label = fields.CharField(max_length=200)
+    key = fields.CharField(max_length=20)
+    value = fields.JSONField()
+    status: Status = fields.IntEnumField(Status, default=Status.on)
+
+    class Meta:
+        table = "configs"

tests/test_ddl.py

@@ -0,0 +1,208 @@
+from aerich.ddl.mysql import MysqlDDL
+from aerich.ddl.postgres import PostgresDDL
+from aerich.ddl.sqlite import SqliteDDL
+from aerich.migrate import Migrate
+from tests.models import Category, Product, User
+
+
+def test_create_table():
+    ret = Migrate.ddl.create_table(Category)
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert (
+            ret
+            == """CREATE TABLE IF NOT EXISTS `category` (
+    `id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT,
+    `slug` VARCHAR(100) NOT NULL,
+    `name` VARCHAR(200),
+    `created_at` DATETIME(6) NOT NULL  DEFAULT CURRENT_TIMESTAMP(6),
+    `user_id` INT NOT NULL COMMENT 'User',
+    CONSTRAINT `fk_category_user_e2e3874c` FOREIGN KEY (`user_id`) REFERENCES `user` (`id`) ON DELETE CASCADE
+) CHARACTER SET utf8mb4;"""
+        )
+
+    elif isinstance(Migrate.ddl, SqliteDDL):
+        assert (
+            ret
+            == """CREATE TABLE IF NOT EXISTS "category" (
+    "id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+    "slug" VARCHAR(100) NOT NULL,
+    "name" VARCHAR(200),
+    "created_at" TIMESTAMP NOT NULL  DEFAULT CURRENT_TIMESTAMP,
+    "user_id" INT NOT NULL REFERENCES "user" ("id") ON DELETE CASCADE /* User */
+);"""
+        )
+
+    elif isinstance(Migrate.ddl, PostgresDDL):
+        assert (
+            ret
+            == """CREATE TABLE IF NOT EXISTS "category" (
+    "id" SERIAL NOT NULL PRIMARY KEY,
+    "slug" VARCHAR(100) NOT NULL,
+    "name" VARCHAR(200),
+    "created_at" TIMESTAMPTZ NOT NULL  DEFAULT CURRENT_TIMESTAMP,
+    "user_id" INT NOT NULL REFERENCES "user" ("id") ON DELETE CASCADE
+);
+COMMENT ON COLUMN "category"."user_id" IS 'User';"""
+        )
+
+
+def test_drop_table():
+    ret = Migrate.ddl.drop_table(Category._meta.db_table)
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert ret == "DROP TABLE IF EXISTS `category`"
+    else:
+        assert ret == 'DROP TABLE IF EXISTS "category"'
+
+
+def test_add_column():
+    ret = Migrate.ddl.add_column(Category, Category._meta.fields_map.get("name").describe(False))
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert ret == "ALTER TABLE `category` ADD `name` VARCHAR(200)"
+    else:
+        assert ret == 'ALTER TABLE "category" ADD "name" VARCHAR(200)'
+
+
+def test_modify_column():
+    if isinstance(Migrate.ddl, SqliteDDL):
+        return
+
+    ret0 = Migrate.ddl.modify_column(
+        Category, Category._meta.fields_map.get("name").describe(False)
+    )
+    ret1 = Migrate.ddl.modify_column(User, User._meta.fields_map.get("is_active").describe(False))
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert ret0 == "ALTER TABLE `category` MODIFY COLUMN `name` VARCHAR(200)"
+    elif isinstance(Migrate.ddl, PostgresDDL):
+        assert (
+            ret0
+            == 'ALTER TABLE "category" ALTER COLUMN "name" TYPE VARCHAR(200) USING "name"::VARCHAR(200)'
+        )
+
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert (
+            ret1
+            == "ALTER TABLE `user` MODIFY COLUMN `is_active` BOOL NOT NULL  COMMENT 'Is Active' DEFAULT 1"
+        )
+    elif isinstance(Migrate.ddl, PostgresDDL):
+        assert (
+            ret1 == 'ALTER TABLE "user" ALTER COLUMN "is_active" TYPE BOOL USING "is_active"::BOOL'
+        )
+
+
+def test_alter_column_default():
+    if isinstance(Migrate.ddl, SqliteDDL):
+        return
+    ret = Migrate.ddl.alter_column_default(User, User._meta.fields_map.get("intro").describe(False))
+    if isinstance(Migrate.ddl, PostgresDDL):
+        assert ret == 'ALTER TABLE "user" ALTER COLUMN "intro" SET DEFAULT \'\''
+    elif isinstance(Migrate.ddl, MysqlDDL):
+        assert ret == "ALTER TABLE `user` ALTER COLUMN `intro` SET DEFAULT ''"
+
+    ret = Migrate.ddl.alter_column_default(
+        Category, Category._meta.fields_map.get("created_at").describe(False)
+    )
+    if isinstance(Migrate.ddl, PostgresDDL):
+        assert (
+            ret == 'ALTER TABLE "category" ALTER COLUMN "created_at" SET DEFAULT CURRENT_TIMESTAMP'
+        )
+    elif isinstance(Migrate.ddl, MysqlDDL):
+        assert (
+            ret
+            == "ALTER TABLE `category` ALTER COLUMN `created_at` SET DEFAULT CURRENT_TIMESTAMP(6)"
+        )
+
+    ret = Migrate.ddl.alter_column_default(
+        Product, Product._meta.fields_map.get("view_num").describe(False)
+    )
+    if isinstance(Migrate.ddl, PostgresDDL):
+        assert ret == 'ALTER TABLE "product" ALTER COLUMN "view_num" SET DEFAULT 0'
+    elif isinstance(Migrate.ddl, MysqlDDL):
+        assert ret == "ALTER TABLE `product` ALTER COLUMN `view_num` SET DEFAULT 0"
+
+
+def test_alter_column_null():
+    if isinstance(Migrate.ddl, (SqliteDDL, MysqlDDL)):
+        return
+    ret = Migrate.ddl.alter_column_null(
+        Category, Category._meta.fields_map.get("name").describe(False)
+    )
+    if isinstance(Migrate.ddl, PostgresDDL):
+        assert ret == 'ALTER TABLE "category" ALTER COLUMN "name" DROP NOT NULL'
+
+
+def test_set_comment():
+    if isinstance(Migrate.ddl, (SqliteDDL, MysqlDDL)):
+        return
+    ret = Migrate.ddl.set_comment(Category, Category._meta.fields_map.get("name").describe(False))
+    assert ret == 'COMMENT ON COLUMN "category"."name" IS NULL'
+
+    ret = Migrate.ddl.set_comment(Category, Category._meta.fields_map.get("user").describe(False))
+    assert ret == 'COMMENT ON COLUMN "category"."user_id" IS \'User\''
+
+
+def test_drop_column():
+    ret = Migrate.ddl.drop_column(Category, "name")
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert ret == "ALTER TABLE `category` DROP COLUMN `name`"
+    elif isinstance(Migrate.ddl, PostgresDDL):
+        assert ret == 'ALTER TABLE "category" DROP COLUMN "name"'
+
+
+def test_add_index():
+    index = Migrate.ddl.add_index(Category, ["name"])
+    index_u = Migrate.ddl.add_index(Category, ["name"], True)
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert index == "ALTER TABLE `category` ADD INDEX `idx_category_name_8b0cb9` (`name`)"
+        assert (
+            index_u == "ALTER TABLE `category` ADD UNIQUE INDEX `uid_category_name_8b0cb9` (`name`)"
+        )
+    elif isinstance(Migrate.ddl, PostgresDDL):
+        assert index == 'CREATE INDEX "idx_category_name_8b0cb9" ON "category" ("name")'
+        assert index_u == 'CREATE UNIQUE INDEX "uid_category_name_8b0cb9" ON "category" ("name")'
+    else:
+        assert index == 'ALTER TABLE "category" ADD INDEX "idx_category_name_8b0cb9" ("name")'
+        assert (
+            index_u == 'ALTER TABLE "category" ADD UNIQUE INDEX "uid_category_name_8b0cb9" ("name")'
+        )
+
+
+def test_drop_index():
+    ret = Migrate.ddl.drop_index(Category, ["name"])
+    ret_u = Migrate.ddl.drop_index(Category, ["name"], True)
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert ret == "ALTER TABLE `category` DROP INDEX `idx_category_name_8b0cb9`"
+        assert ret_u == "ALTER TABLE `category` DROP INDEX `uid_category_name_8b0cb9`"
+    elif isinstance(Migrate.ddl, PostgresDDL):
+        assert ret == 'DROP INDEX "idx_category_name_8b0cb9"'
+        assert ret_u == 'DROP INDEX "uid_category_name_8b0cb9"'
+    else:
+        assert ret == 'ALTER TABLE "category" DROP INDEX "idx_category_name_8b0cb9"'
+        assert ret_u == 'ALTER TABLE "category" DROP INDEX "uid_category_name_8b0cb9"'
+
+
+def test_add_fk():
+    ret = Migrate.ddl.add_fk(
+        Category, Category._meta.fields_map.get("user").describe(False), User.describe(False)
+    )
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert (
+            ret
+            == "ALTER TABLE `category` ADD CONSTRAINT `fk_category_user_e2e3874c` FOREIGN KEY (`user_id`) REFERENCES `user` (`id`) ON DELETE CASCADE"
+        )
+    else:
+        assert (
+            ret
+            == 'ALTER TABLE "category" ADD CONSTRAINT "fk_category_user_e2e3874c" FOREIGN KEY ("user_id") REFERENCES "user" ("id") ON DELETE CASCADE'
+        )
+
+
+def test_drop_fk():
+    ret = Migrate.ddl.drop_fk(
+        Category, Category._meta.fields_map.get("user").describe(False), User.describe(False)
+    )
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert ret == "ALTER TABLE `category` DROP FOREIGN KEY `fk_category_user_e2e3874c`"
+    elif isinstance(Migrate.ddl, PostgresDDL):
+        assert ret == 'ALTER TABLE "category" DROP CONSTRAINT "fk_category_user_e2e3874c"'
+    else:
+        assert ret == 'ALTER TABLE "category" DROP FOREIGN KEY "fk_category_user_e2e3874c"'

tests/test_migrate.py

@@ -0,0 +1,899 @@
+import pytest
+from pytest_mock import MockerFixture
+
+from aerich.ddl.mysql import MysqlDDL
+from aerich.ddl.postgres import PostgresDDL
+from aerich.ddl.sqlite import SqliteDDL
+from aerich.exceptions import NotSupportError
+from aerich.migrate import Migrate
+from aerich.utils import get_models_describe
+
+old_models_describe = {
+    "models.Category": {
+        "name": "models.Category",
+        "app": "models",
+        "table": "category",
+        "abstract": False,
+        "description": None,
+        "docstring": None,
+        "unique_together": [],
+        "pk_field": {
+            "name": "id",
+            "field_type": "IntField",
+            "db_column": "id",
+            "python_type": "int",
+            "generated": True,
+            "nullable": False,
+            "unique": True,
+            "indexed": True,
+            "default": None,
+            "description": None,
+            "docstring": None,
+            "constraints": {"ge": 1, "le": 2147483647},
+            "db_field_types": {"": "INT"},
+        },
+        "data_fields": [
+            {
+                "name": "slug",
+                "field_type": "CharField",
+                "db_column": "slug",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 200},
+                "db_field_types": {"": "VARCHAR(200)"},
+            },
+            {
+                "name": "name",
+                "field_type": "CharField",
+                "db_column": "name",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 200},
+                "db_field_types": {"": "VARCHAR(200)"},
+            },
+            {
+                "name": "created_at",
+                "field_type": "DatetimeField",
+                "db_column": "created_at",
+                "python_type": "datetime.datetime",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"readOnly": True},
+                "db_field_types": {
+                    "": "TIMESTAMP",
+                    "mysql": "DATETIME(6)",
+                    "postgres": "TIMESTAMPTZ",
+                },
+                "auto_now_add": True,
+                "auto_now": False,
+            },
+            {
+                "name": "user_id",
+                "field_type": "IntField",
+                "db_column": "user_id",
+                "python_type": "int",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": "User",
+                "docstring": None,
+                "constraints": {"ge": 1, "le": 2147483647},
+                "db_field_types": {"": "INT"},
+            },
+        ],
+        "fk_fields": [
+            {
+                "name": "user",
+                "field_type": "ForeignKeyFieldInstance",
+                "python_type": "models.User",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": "User",
+                "docstring": None,
+                "constraints": {},
+                "raw_field": "user_id",
+                "on_delete": "CASCADE",
+            }
+        ],
+        "backward_fk_fields": [],
+        "o2o_fields": [],
+        "backward_o2o_fields": [],
+        "m2m_fields": [
+            {
+                "name": "products",
+                "field_type": "ManyToManyFieldInstance",
+                "python_type": "models.Product",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+                "model_name": "models.Product",
+                "related_name": "categories",
+                "forward_key": "product_id",
+                "backward_key": "category_id",
+                "through": "product_category",
+                "on_delete": "CASCADE",
+                "_generated": True,
+            }
+        ],
+    },
+    "models.Config": {
+        "name": "models.Config",
+        "app": "models",
+        "table": "configs",
+        "abstract": False,
+        "description": None,
+        "docstring": None,
+        "unique_together": [],
+        "pk_field": {
+            "name": "id",
+            "field_type": "IntField",
+            "db_column": "id",
+            "python_type": "int",
+            "generated": True,
+            "nullable": False,
+            "unique": True,
+            "indexed": True,
+            "default": None,
+            "description": None,
+            "docstring": None,
+            "constraints": {"ge": 1, "le": 2147483647},
+            "db_field_types": {"": "INT"},
+        },
+        "data_fields": [
+            {
+                "name": "label",
+                "field_type": "CharField",
+                "db_column": "label",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 200},
+                "db_field_types": {"": "VARCHAR(200)"},
+            },
+            {
+                "name": "key",
+                "field_type": "CharField",
+                "db_column": "key",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 20},
+                "db_field_types": {"": "VARCHAR(20)"},
+            },
+            {
+                "name": "value",
+                "field_type": "JSONField",
+                "db_column": "value",
+                "python_type": "Union[dict, list]",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {"": "TEXT", "postgres": "JSONB"},
+            },
+            {
+                "name": "status",
+                "field_type": "IntEnumFieldInstance",
+                "db_column": "status",
+                "python_type": "int",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": 1,
+                "description": "on: 1\noff: 0",
+                "docstring": None,
+                "constraints": {"ge": -32768, "le": 32767},
+                "db_field_types": {"": "SMALLINT"},
+            },
+        ],
+        "fk_fields": [],
+        "backward_fk_fields": [],
+        "o2o_fields": [],
+        "backward_o2o_fields": [],
+        "m2m_fields": [],
+    },
+    "models.Email": {
+        "name": "models.Email",
+        "app": "models",
+        "table": "email",
+        "abstract": False,
+        "description": None,
+        "docstring": None,
+        "unique_together": [],
+        "pk_field": {
+            "name": "id",
+            "field_type": "IntField",
+            "db_column": "id",
+            "python_type": "int",
+            "generated": True,
+            "nullable": False,
+            "unique": True,
+            "indexed": True,
+            "default": None,
+            "description": None,
+            "docstring": None,
+            "constraints": {"ge": 1, "le": 2147483647},
+            "db_field_types": {"": "INT"},
+        },
+        "data_fields": [
+            {
+                "name": "email",
+                "field_type": "CharField",
+                "db_column": "email",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 200},
+                "db_field_types": {"": "VARCHAR(200)"},
+            },
+            {
+                "name": "is_primary",
+                "field_type": "BooleanField",
+                "db_column": "is_primary",
+                "python_type": "bool",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": False,
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {"": "BOOL", "sqlite": "INT"},
+            },
+            {
+                "name": "user_id",
+                "field_type": "IntField",
+                "db_column": "user_id",
+                "python_type": "int",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"ge": 1, "le": 2147483647},
+                "db_field_types": {"": "INT"},
+            },
+        ],
+        "fk_fields": [
+            {
+                "name": "user",
+                "field_type": "ForeignKeyFieldInstance",
+                "python_type": "models.User",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+                "raw_field": "user_id",
+                "on_delete": "CASCADE",
+            }
+        ],
+        "backward_fk_fields": [],
+        "o2o_fields": [],
+        "backward_o2o_fields": [],
+        "m2m_fields": [],
+    },
+    "models.Product": {
+        "name": "models.Product",
+        "app": "models",
+        "table": "product",
+        "abstract": False,
+        "description": None,
+        "docstring": None,
+        "unique_together": [],
+        "pk_field": {
+            "name": "id",
+            "field_type": "IntField",
+            "db_column": "id",
+            "python_type": "int",
+            "generated": True,
+            "nullable": False,
+            "unique": True,
+            "indexed": True,
+            "default": None,
+            "description": None,
+            "docstring": None,
+            "constraints": {"ge": 1, "le": 2147483647},
+            "db_field_types": {"": "INT"},
+        },
+        "data_fields": [
+            {
+                "name": "name",
+                "field_type": "CharField",
+                "db_column": "name",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 50},
+                "db_field_types": {"": "VARCHAR(50)"},
+            },
+            {
+                "name": "view_num",
+                "field_type": "IntField",
+                "db_column": "view_num",
+                "python_type": "int",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": "View Num",
+                "docstring": None,
+                "constraints": {"ge": -2147483648, "le": 2147483647},
+                "db_field_types": {"": "INT"},
+            },
+            {
+                "name": "sort",
+                "field_type": "IntField",
+                "db_column": "sort",
+                "python_type": "int",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"ge": -2147483648, "le": 2147483647},
+                "db_field_types": {"": "INT"},
+            },
+            {
+                "name": "is_reviewed",
+                "field_type": "BooleanField",
+                "db_column": "is_reviewed",
+                "python_type": "bool",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": "Is Reviewed",
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {"": "BOOL", "sqlite": "INT"},
+            },
+            {
+                "name": "type",
+                "field_type": "IntEnumFieldInstance",
+                "db_column": "type_db_alias",
+                "python_type": "int",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": "Product Type",
+                "docstring": None,
+                "constraints": {"ge": -32768, "le": 32767},
+                "db_field_types": {"": "SMALLINT"},
+            },
+            {
+                "name": "image",
+                "field_type": "CharField",
+                "db_column": "image",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 200},
+                "db_field_types": {"": "VARCHAR(200)"},
+            },
+            {
+                "name": "body",
+                "field_type": "TextField",
+                "db_column": "body",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {"": "TEXT", "mysql": "LONGTEXT"},
+            },
+            {
+                "name": "created_at",
+                "field_type": "DatetimeField",
+                "db_column": "created_at",
+                "python_type": "datetime.datetime",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"readOnly": True},
+                "db_field_types": {
+                    "": "TIMESTAMP",
+                    "mysql": "DATETIME(6)",
+                    "postgres": "TIMESTAMPTZ",
+                },
+                "auto_now_add": True,
+                "auto_now": False,
+            },
+        ],
+        "fk_fields": [],
+        "backward_fk_fields": [],
+        "o2o_fields": [],
+        "backward_o2o_fields": [],
+        "m2m_fields": [
+            {
+                "name": "categories",
+                "field_type": "ManyToManyFieldInstance",
+                "python_type": "models.Category",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+                "model_name": "models.Category",
+                "related_name": "products",
+                "forward_key": "category_id",
+                "backward_key": "product_id",
+                "through": "product_category",
+                "on_delete": "CASCADE",
+                "_generated": False,
+            }
+        ],
+    },
+    "models.User": {
+        "name": "models.User",
+        "app": "models",
+        "table": "user",
+        "abstract": False,
+        "description": None,
+        "docstring": None,
+        "unique_together": [],
+        "pk_field": {
+            "name": "id",
+            "field_type": "IntField",
+            "db_column": "id",
+            "python_type": "int",
+            "generated": True,
+            "nullable": False,
+            "unique": True,
+            "indexed": True,
+            "default": None,
+            "description": None,
+            "docstring": None,
+            "constraints": {"ge": 1, "le": 2147483647},
+            "db_field_types": {"": "INT"},
+        },
+        "data_fields": [
+            {
+                "name": "username",
+                "field_type": "CharField",
+                "db_column": "username",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 20},
+                "db_field_types": {"": "VARCHAR(20)"},
+            },
+            {
+                "name": "password",
+                "field_type": "CharField",
+                "db_column": "password",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 200},
+                "db_field_types": {"": "VARCHAR(200)"},
+            },
+            {
+                "name": "last_login",
+                "field_type": "DatetimeField",
+                "db_column": "last_login",
+                "python_type": "datetime.datetime",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": "<function None.now>",
+                "description": "Last Login",
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {
+                    "": "TIMESTAMP",
+                    "mysql": "DATETIME(6)",
+                    "postgres": "TIMESTAMPTZ",
+                },
+                "auto_now_add": False,
+                "auto_now": False,
+            },
+            {
+                "name": "is_active",
+                "field_type": "BooleanField",
+                "db_column": "is_active",
+                "python_type": "bool",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": True,
+                "description": "Is Active",
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {"": "BOOL", "sqlite": "INT"},
+            },
+            {
+                "name": "is_superuser",
+                "field_type": "BooleanField",
+                "db_column": "is_superuser",
+                "python_type": "bool",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": False,
+                "description": "Is SuperUser",
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {"": "BOOL", "sqlite": "INT"},
+            },
+            {
+                "name": "avatar",
+                "field_type": "CharField",
+                "db_column": "avatar",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": "",
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 200},
+                "db_field_types": {"": "VARCHAR(200)"},
+            },
+            {
+                "name": "intro",
+                "field_type": "TextField",
+                "db_column": "intro",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": "",
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {"": "TEXT", "mysql": "LONGTEXT"},
+            },
+        ],
+        "fk_fields": [],
+        "backward_fk_fields": [
+            {
+                "name": "categorys",
+                "field_type": "BackwardFKRelation",
+                "python_type": "models.Category",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": "User",
+                "docstring": None,
+                "constraints": {},
+            },
+            {
+                "name": "emails",
+                "field_type": "BackwardFKRelation",
+                "python_type": "models.Email",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+            },
+        ],
+        "o2o_fields": [],
+        "backward_o2o_fields": [],
+        "m2m_fields": [],
+    },
+    "models.Aerich": {
+        "name": "models.Aerich",
+        "app": "models",
+        "table": "aerich",
+        "abstract": False,
+        "description": None,
+        "docstring": None,
+        "unique_together": [],
+        "pk_field": {
+            "name": "id",
+            "field_type": "IntField",
+            "db_column": "id",
+            "python_type": "int",
+            "generated": True,
+            "nullable": False,
+            "unique": True,
+            "indexed": True,
+            "default": None,
+            "description": None,
+            "docstring": None,
+            "constraints": {"ge": 1, "le": 2147483647},
+            "db_field_types": {"": "INT"},
+        },
+        "data_fields": [
+            {
+                "name": "version",
+                "field_type": "CharField",
+                "db_column": "version",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 255},
+                "db_field_types": {"": "VARCHAR(255)"},
+            },
+            {
+                "name": "app",
+                "field_type": "CharField",
+                "db_column": "app",
+                "python_type": "str",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {"max_length": 20},
+                "db_field_types": {"": "VARCHAR(20)"},
+            },
+            {
+                "name": "content",
+                "field_type": "JSONField",
+                "db_column": "content",
+                "python_type": "Union[dict, list]",
+                "generated": False,
+                "nullable": False,
+                "unique": False,
+                "indexed": False,
+                "default": None,
+                "description": None,
+                "docstring": None,
+                "constraints": {},
+                "db_field_types": {"": "TEXT", "postgres": "JSONB"},
+            },
+        ],
+        "fk_fields": [],
+        "backward_fk_fields": [],
+        "o2o_fields": [],
+        "backward_o2o_fields": [],
+        "m2m_fields": [],
+    },
+}
+
+
+def test_migrate(mocker: MockerFixture):
+    """
+    models.py diff with old_models.py
+    - change email pk: id -> email_id
+    - add field: Email.address
+    - add fk: Config.user
+    - drop fk: Email.user
+    - drop field: User.avatar
+    - add index: Email.email
+    - add many to many: Email.users
+    - remove unique: User.username
+    - change column: length User.password
+    - add unique_together: (name,type) of Product
+    - alter default: Config.status
+    - rename column: Product.image -> Product.pic
+    """
+    mocker.patch("click.prompt", side_effect=(True,))
+
+    models_describe = get_models_describe("models")
+    Migrate.app = "models"
+    if isinstance(Migrate.ddl, SqliteDDL):
+        with pytest.raises(NotSupportError):
+            Migrate.diff_models(old_models_describe, models_describe)
+            Migrate.diff_models(models_describe, old_models_describe, False)
+    else:
+        Migrate.diff_models(old_models_describe, models_describe)
+        Migrate.diff_models(models_describe, old_models_describe, False)
+    Migrate._merge_operators()
+    if isinstance(Migrate.ddl, MysqlDDL):
+        assert sorted(Migrate.upgrade_operators) == sorted(
+            [
+                "ALTER TABLE `category` MODIFY COLUMN `name` VARCHAR(200)",
+                "ALTER TABLE `category` MODIFY COLUMN `slug` VARCHAR(100) NOT NULL",
+                "ALTER TABLE `config` ADD `user_id` INT NOT NULL  COMMENT 'User'",
+                "ALTER TABLE `config` ADD CONSTRAINT `fk_config_user_17daa970` FOREIGN KEY (`user_id`) REFERENCES `user` (`id`) ON DELETE CASCADE",
+                "ALTER TABLE `config` ALTER COLUMN `status` DROP DEFAULT",
+                "ALTER TABLE `email` ADD `address` VARCHAR(200) NOT NULL",
+                "ALTER TABLE `email` DROP COLUMN `user_id`",
+                "ALTER TABLE `configs` RENAME TO `config`",
+                "ALTER TABLE `product` RENAME COLUMN `image` TO `pic`",
+                "ALTER TABLE `email` RENAME COLUMN `id` TO `email_id`",
+                "ALTER TABLE `email` ADD INDEX `idx_email_email_4a1a33` (`email`)",
+                "ALTER TABLE `product` ADD UNIQUE INDEX `uid_product_name_869427` (`name`, `type_db_alias`)",
+                "ALTER TABLE `product` ALTER COLUMN `view_num` SET DEFAULT 0",
+                "ALTER TABLE `user` DROP COLUMN `avatar`",
+                "ALTER TABLE `user` MODIFY COLUMN `password` VARCHAR(100) NOT NULL",
+                "CREATE TABLE IF NOT EXISTS `newmodel` (\n    `id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT,\n    `name` VARCHAR(50) NOT NULL\n) CHARACTER SET utf8mb4;",
+                "ALTER TABLE `user` ADD UNIQUE INDEX `uid_user_usernam_9987ab` (`username`)",
+                "CREATE TABLE `email_user` (`email_id` INT NOT NULL REFERENCES `email` (`email_id`) ON DELETE CASCADE,`user_id` INT NOT NULL REFERENCES `user` (`id`) ON DELETE CASCADE) CHARACTER SET utf8mb4",
+            ]
+        )
+
+        assert sorted(Migrate.downgrade_operators) == sorted(
+            [
+                "ALTER TABLE `category` MODIFY COLUMN `name` VARCHAR(200) NOT NULL",
+                "ALTER TABLE `category` MODIFY COLUMN `slug` VARCHAR(200) NOT NULL",
+                "ALTER TABLE `config` DROP COLUMN `user_id`",
+                "ALTER TABLE `config` DROP FOREIGN KEY `fk_config_user_17daa970`",
+                "ALTER TABLE `config` ALTER COLUMN `status` SET DEFAULT 1",
+                "ALTER TABLE `email` ADD `user_id` INT NOT NULL",
+                "ALTER TABLE `email` DROP COLUMN `address`",
+                "ALTER TABLE `config` RENAME TO `configs`",
+                "ALTER TABLE `product` RENAME COLUMN `pic` TO `image`",
+                "ALTER TABLE `email` RENAME COLUMN `email_id` TO `id`",
+                "ALTER TABLE `email` DROP INDEX `idx_email_email_4a1a33`",
+                "ALTER TABLE `product` DROP INDEX `uid_product_name_869427`",
+                "ALTER TABLE `product` ALTER COLUMN `view_num` DROP DEFAULT",
+                "ALTER TABLE `user` ADD `avatar` VARCHAR(200) NOT NULL  DEFAULT ''",
+                "ALTER TABLE `user` DROP INDEX `idx_user_usernam_9987ab`",
+                "ALTER TABLE `user` MODIFY COLUMN `password` VARCHAR(200) NOT NULL",
+                "DROP TABLE IF EXISTS `email_user`",
+                "DROP TABLE IF EXISTS `newmodel`",
+            ]
+        )
+
+    elif isinstance(Migrate.ddl, PostgresDDL):
+        assert sorted(Migrate.upgrade_operators) == sorted(
+            [
+                'ALTER TABLE "category" ALTER COLUMN "name" DROP NOT NULL',
+                'ALTER TABLE "category" ALTER COLUMN "slug" TYPE VARCHAR(100) USING "slug"::VARCHAR(100)',
+                'ALTER TABLE "config" ADD "user_id" INT NOT NULL',
+                'ALTER TABLE "config" ADD CONSTRAINT "fk_config_user_17daa970" FOREIGN KEY ("user_id") REFERENCES "user" ("id") ON DELETE CASCADE',
+                'ALTER TABLE "config" ALTER COLUMN "status" DROP DEFAULT',
+                'ALTER TABLE "configs" RENAME TO "config"',
+                'ALTER TABLE "email" ADD "address" VARCHAR(200) NOT NULL',
+                'ALTER TABLE "email" DROP COLUMN "user_id"',
+                'ALTER TABLE "email" RENAME COLUMN "id" TO "email_id"',
+                'ALTER TABLE "product" ALTER COLUMN "view_num" SET DEFAULT 0',
+                'ALTER TABLE "product" RENAME COLUMN "image" TO "pic"',
+                'ALTER TABLE "user" ALTER COLUMN "password" TYPE VARCHAR(100) USING "password"::VARCHAR(100)',
+                'ALTER TABLE "user" DROP COLUMN "avatar"',
+                'CREATE INDEX "idx_email_email_4a1a33" ON "email" ("email")',
+                'CREATE TABLE "email_user" ("email_id" INT NOT NULL REFERENCES "email" ("email_id") ON DELETE CASCADE,"user_id" INT NOT NULL REFERENCES "user" ("id") ON DELETE CASCADE)',
+                'CREATE TABLE IF NOT EXISTS "newmodel" (\n    "id" SERIAL NOT NULL PRIMARY KEY,\n    "name" VARCHAR(50) NOT NULL\n);\nCOMMENT ON COLUMN "config"."user_id" IS \'User\';',
+                'CREATE UNIQUE INDEX "uid_product_name_869427" ON "product" ("name", "type_db_alias")',
+                'CREATE UNIQUE INDEX "uid_user_usernam_9987ab" ON "user" ("username")',
+            ]
+        )
+        assert sorted(Migrate.downgrade_operators) == sorted(
+            [
+                'ALTER TABLE "category" ALTER COLUMN "name" SET NOT NULL',
+                'ALTER TABLE "category" ALTER COLUMN "slug" TYPE VARCHAR(200) USING "slug"::VARCHAR(200)',
+                'ALTER TABLE "config" ALTER COLUMN "status" SET DEFAULT 1',
+                'ALTER TABLE "config" DROP COLUMN "user_id"',
+                'ALTER TABLE "config" DROP CONSTRAINT "fk_config_user_17daa970"',
+                'ALTER TABLE "config" RENAME TO "configs"',
+                'ALTER TABLE "email" ADD "user_id" INT NOT NULL',
+                'ALTER TABLE "email" DROP COLUMN "address"',
+                'ALTER TABLE "email" RENAME COLUMN "email_id" TO "id"',
+                'ALTER TABLE "product" ALTER COLUMN "view_num" DROP DEFAULT',
+                'ALTER TABLE "product" RENAME COLUMN "pic" TO "image"',
+                'ALTER TABLE "user" ADD "avatar" VARCHAR(200) NOT NULL  DEFAULT \'\'',
+                'ALTER TABLE "user" ALTER COLUMN "password" TYPE VARCHAR(200) USING "password"::VARCHAR(200)',
+                'DROP INDEX "idx_email_email_4a1a33"',
+                'DROP INDEX "idx_user_usernam_9987ab"',
+                'DROP INDEX "uid_product_name_869427"',
+                'DROP TABLE IF EXISTS "email_user"',
+                'DROP TABLE IF EXISTS "newmodel"',
+            ]
+        )
+    elif isinstance(Migrate.ddl, SqliteDDL):
+        assert Migrate.upgrade_operators == []
+
+        assert Migrate.downgrade_operators == []
+
+
+def test_sort_all_version_files(mocker):
+    mocker.patch(
+        "os.listdir",
+        return_value=[
+            "1_datetime_update.sql",
+            "11_datetime_update.sql",
+            "10_datetime_update.sql",
+            "2_datetime_update.sql",
+        ],
+    )
+
+    Migrate.migrate_location = "."
+
+    assert Migrate.get_all_version_files() == [
+        "1_datetime_update.sql",
+        "2_datetime_update.sql",
+        "10_datetime_update.sql",
+        "11_datetime_update.sql",
+    ]

tests/test_utils.py

@@ -1,6 +0,0 @@
-from unittest import TestCase
-
-
-class TestUtils(TestCase):
-    def test_get_app_connection(self):
-        pass

tox.ini

@@ -1,11 +0,0 @@
-[tox]
-envlist = py{37,38,39}
-skip_missing_interpreters = True
-
-[testenv]
-whitelist_externals=
-    make
-commands=
-    make ci
-deps =
-    -r requirements-dev.txt