Aerich数据库迁移工具的使用

简介

Aerich是用于TortoiseORM的数据库迁移工具，通过这个工具可以根据模型类来对数据库做出改变。

安装

pip install aerich

使用

定义配置信息

#下面的配置信息写在了tests包的mysql.py文件中(具体写在哪里可以自己决定)
ORTOISE_ORM = {
		# 数据库连接信息
    "connections": {"default": "mysql://root:123456@127.0.0.1:3306/test"},
		# 指定有哪些应用
    "apps": {
        "models": {
						# 指明应用下存放模型类的位置，比如test.models就是在test包下的models文件中存放了模型类
						# 这里可以写自己模型类存放位置。
            "models": ["aerich.models"],  # aerich.models是必须写的，写了之后会去找到对应的模型类然后创建一个迁移记录表。
            "default_connection": "default",
        },
    },
}

初始化配置信息

aerich需要知道数据库相关的配置信息(就是上面定义的那个)才能对数据库进行操作。这里初始化的目的就是将配置信息的位置记录下来，方便后面能够使用。

执行命令来初始化配置信息:

# -t后面写配置信息的所在位置。例如这里的配置信息就写在了tests包中的mysql.py文件中，配置信息字典是TORTOISE_ORM
aerich init -t tests.mysql.TORTOISE_ORM

# 输出结果:
# Success create migrate location ./migrations
# Success write config to pyproject.toml

初始化完成后，会在执行命令的目录下生成一个pyproject.toml文件和一个migrations文件夹。migrations文件夹用于存放后面的迁移记录，pyproject.toml文件中会记录配置信息所在位置和迁移文件的存放位置等。

初始化数据库

aerich需要在数据库中记录每一次的迁移情况，初始化数据库的目的就是为了生成一个名为”aerich”的表用于记录迁移信息。

执行命令来初始化数据库(执行该命令前必须先初始化配置信息):

aerich init-db

追踪模型变化

当创建了模型类或者对模型类中的字段做出改变时，需要执行命令来追踪当前的模型类与上一次迁移记录有什么变化，根据变化来生成迁移文件。
注意: 执行下面的命令必须已经完成初始化配置信息和初始化数据库。
执行命令来追踪变化:

# 直接进行追踪
aerich migrate
# 进行追踪并指定生成的迁移文件的部分命名(具体效果可以上官网查看或者自己试验)
aerich migrate --name drop_column

执行改变

上面的migrate只是追踪模型类有什么变化，然后生成一个迁移文件，但这时候具体的改变还没有应用到数据库(注意和django中的migrate进行区分)。
注意: 执行下面的命令必须已经完成初始化配置信息和初始化数据库。
执行命令来将变化应用到数据库当中:

aerich upgrade

数据库表映射成模型类

上面提到的初始化 → 追踪变化 → 执行改变就是一般使用的流程了，但是有时数据库表是已经创建好了的，需要将其转为模型类，再通过ORM去操作数据库。aerich也有相对应的命令来帮助我们将数据库表映射成模型类(注意，映射命令也是有限制的，像外键这种就不能成功映射)。
注意: 执行下面的命令必须已经完成初始化配置信息和初始化数据库。

执行命令以映射:

# 映射所有的表并输出到控制台
aerich --app models inspectdb
# 指定一个表进行映射
aerich inspectdb -t user
# 映射所有表并将内容输出到文件当中(通常不会将映射内容直接输出到控制台)
aerich --app models inspectdb > models.py