aerich迁徙tortoise-orm数据库教程

aerich迁徙tortoise-orm数据库教程
目次
1.介绍
2.问题
3.tortoise-orm 自身函数迁徙数据库
4.aerich命令迁徙tortoise-orm数据库表
5.aerich代码迁徙tortoise-orm数据库表
6. 留意事项（总结）

---

1.介绍

        tortoise-orm是异步orm，语法类似django-orm，非常简单方便；一般配合fastapi利用。
        tortoise-orm自身有generate_schemas函数用于数据库表创建
        但实际项目开辟中利用较少，多用aerich来迁徙model->数据库表
2.问题

        aerich 0.8.0和0.8.1 版本 cmd执行命令 存在问题，aerich init-db  upgrade等命令执行后 无法退出。
        缘故原由：0.7.2以上版本，默认一直连接数据库(config里面有数据库连接路径)，命令端无法退出连接，因此在代码程序中接纳aerich Command执行命令，须要lifespan中Tortoise.close_connections
https://fastapi.tiangolo.com/zh/advanced/events/?h=lifespan#lifespan

        aerich 0.7.2版本 没有问题
3.tortoise-orm 自身函数迁徙数据库

        建议看官网代码(点击查看)，直接上代码，必须2个py文件（model单独1个py文件，main 1个文件），这样才不会报错
        Tortoise.init(db_url="sqlite://db.sqlite3", modules={"models": ["test"]})中 `models`可以改成任意名字，然后model表中外键、多对多须要改成对应名字.表名【models改成model，那么models.Clas须要改成model.Clas】，test为model表py模块（既可以是py文件也但是文件夹）

1. # test.py
3. from tortoise import fields, models, Tortoise
4. from enum import IntEnum
6. class AbstractModel(models.Model):
7.     id = fields.UUIDField(primary_key=True, unique=True, db_index=True)
8.     createdAt = fields.DatetimeField(auto_now_add=True, null=True)
9.     updatedAt = fields.DatetimeField(auto_now=True, null=True)
10.     class Meta:
11.         abstract = True
13. class Gender(IntEnum):
14.     MAN = 0
15.     WOMAN = 1
17. class Student(AbstractModel):
18.     name = fields.CharField(max_length=100, db_index=True, description="姓名")
19.     gender = fields.IntEnumField(Gender, description="性别")
20.     age = fields.IntField(description="年龄")
21.     clas = fields.ForeignKeyField("models.Clas", related_name="students", description="班级外键")
24. class Clas(AbstractModel):
25.     name = fields.CharField(max_length=200, db_index=True, description="班级名称")
26.    

复制代码

1. # main.py
3. from tortoise import Tortoise, run_async
4. from test import Student, Clas
6. async def run():
7.     await Tortoise.init(db_url="sqlite://db.sqlite3", modules={"models": ["test"]})
8.     await Tortoise.generate_schemas()
9.     clas1 = await Clas.create(name="一年级一班1")
10.     stu = await Student.create(name="gyl", gender=1, age=30, clas=clas1)
11.     print(await Student.all().values())
12.     s = await Student.first().values()
13.     print(s['id'])
14.     print(s.keys())
17. if __name__=="__main__":
18.     run_async(run())

复制代码

4.aerich命令迁徙tortoise-orm数据库表

        利用版本为0.7.2，参考aerich官网(点击查看)命令，对于TORTOISE_ORM参数官网(点击查看)
        aerich命令
        aerich init -t config.TORTOISE_ORM     一般执行1次
        aerich init-db     一般执行1次
        aerich migrate     修改表就执行
        aerich upgrade (aerich downgrade)
TORTOISE_ORM配置参数

1. # 一般需要将 connections中的key 改成default 对应default_connection
2. '''
3. 注意：TORTOISE_ORM中
4.         "apps": {
5.             "modelApp": {
6.                 "models": ["models", "aerich.models"],  # models里面有__init__.py就不需要再.了
7.                 "default_connection": "default" # 对应connections里面的
8.             }
9.         },
10.         
11.         `modelApp`(key) 是定义表外键、多对多时 “{app}.{table_name}”中的app, 若modelApp重命名, 则外键里面的app也改成对应的名字 clas = fields.ForeignKeyField("modelApp.Clas", related_name="students")
12.         `[]`里面的`models`是指的py模块路径(相对路径) 对于多级嵌套的的models文件夹 建议设置添加__init__.py导入所有表, 外键等就可以 modelApp."表名" 然后初始化创建表时 自动跟踪模块下面的所有table
13. '''
15. TORTOISE_ORM: dict = {
16.     "connections": {
17.         # SQLite configuration
18.         # "sqlite": {
19.         #     "engine": "tortoise.backends.sqlite",
20.         #     "credentials": {"file_path": f"{具体路径}/db.sqlite3"},  # Path to SQLite database file
21.         # },
22.         # MySQL/MariaDB configuration
23.         # Install with: tortoise-orm[asyncmy]
24.         # "mysql": {
25.         #     "engine": "tortoise.backends.mysql",
26.         #     "credentials": {
27.         #         "host": "localhost",  # Database host address
28.         #         "port": 3306,  # Database port
29.         #         "user": "yourusername",  # Database username
30.         #         "password": "yourpassword",  # Database password
31.         #         "database": "yourdatabase",  # Database name
32.         #     },
33.         # },
34.         # PostgreSQL configuration
35.         # Install with: tortoise-orm[asyncpg]
36.         # "postgres": {
37.         #     "engine": "tortoise.backends.asyncpg",
38.         #     "credentials": {
39.         #         "host": "localhost",  # Database host address
40.         #         "port": 5432,  # Database port
41.         #         "user": "yourusername",  # Database username
42.         #         "password": "yourpassword",  # Database password
43.         #         "database": "yourdatabase",  # Database name
44.         #     },
45.         # },
46.         # MSSQL/Oracle configuration
47.         # Install with: tortoise-orm[asyncodbc]
48.         # "oracle": {
49.         #     "engine": "tortoise.backends.asyncodbc",
50.         #     "credentials": {
51.         #         "host": "localhost",  # Database host address
52.         #         "port": 1433,  # Database port
53.         #         "user": "yourusername",  # Database username
54.         #         "password": "yourpassword",  # Database password
55.         #         "database": "yourdatabase",  # Database name
56.         #     },
57.         # },
58.         # SQLServer configuration
59.         # Install with: tortoise-orm[asyncodbc]
60.         # "sqlserver": {
61.         #     "engine": "tortoise.backends.asyncodbc",
62.         #     "credentials": {
63.         #         "host": "localhost",  # Database host address
64.         #         "port": 1433,  # Database port
65.         #         "user": "yourusername",  # Database username
66.         #         "password": "yourpassword",  # Database password
67.         #         "database": "yourdatabase",  # Database name
68.         #     },
69.         # },
70.     },
71.     'apps': {
72.         'models': {
73.             'models': ['models', 'aerich.models'], # []中的models为 表 模块(models.py或者models文件夹模块 需要有__init__.py导入表)
74.             # If no default_connection specified, defaults to 'default'
75.             'default_connection': 'default',
76.         }
77.     }
78. }

复制代码

5.aerich代码迁徙tortoise-orm数据库表

        版本利用0.8.1
        代码迁徙，确保tortoise关闭连接，这样就不会出现代码执行后 无法退出的现象

1. from aerich import Command
2. from config import settings
3. from tortoise import Tortoise
4. async def init_db():
5.     # settings.TORTOISE_ORM参考第4节
6.     command = Command(tortoise_config=settings.TORTOISE_ORM)
7.     # try:
8.     #     await command.init_db(safe=True)
9.     # except FileExistsError:
10.     #     pass
12.     await command.init()  # 对应aerich init -t
13.     try:
14.         await command.init_db(safe=True)  # 对应aerich init-db
15.     except FileExistsError:
16.         pass
17.     try:
18.         await command.migrate()  # 对应aerich migrate
19.     except AttributeError:
20.         pass
22.     await command.upgrade(run_in_transaction=True)  # 对应aerich upgrade
24. async def lifespan():
25.     await init_db()
26.     await Tortoise.close_connections()  # 执行完成后 关闭Tortoise连接，即关闭数据库连接，像sqlite shm wal文件才会消失，不可直接删除，否则数据库没有数据
28. import asyncio
29. asyncio.run(lifespan())

复制代码

6. 留意事项（总结）

        [1] 若接纳aerich cmd端命令执行数据库创建、迁徙，那么代码中推荐接纳from tortoise.contrib.fastapi import register_tortoise，register_tortoise中generate_schemas调用的tortoise本身的函数迁徙(不推荐生产利用，没有迁徙记载)；
        [2] 若接纳aerich Command 代码程序，那么须要Fastapi中的lifespan，执行关闭数据库连接；
        [3] 现在个人接纳[1]的aerich cmd命令端执行迁徙，然后register_tortoise注册；[1]和[2]不要同时利用，背面可利用[2]




免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

继续阅读请点击广告