Tortoise ORM 和 Aerich 使用文档参考表

Tortoise ORM 和 Aerich 使用文档参考表

安装

操作	命令	说明
安装 Tortoise ORM	pip install tortoise-orm	安装 Tortoise ORM 库
安装 Aerich	pip install aerich	安装 Aerich 迁移工具

初始化配置

操作	命令	说明
初始化 Aerich 配置	aerich init -t your_settings_path_.TORTOISE_ORM	只需使用一次，初始化配置文件

数据库初始化

操作	命令	说明
初始化数据库	aerich init-db	一般情况下只需在第一次使用，初始化数据库表结构

数据迁移操作

操作	命令	说明
数据迁移	aerich migrate [--name]	执行数据迁移操作
	aerich migrate --name add_column	示例：标记本次迁移操作为 add_column

模型版本管理

操作	命令	说明
升级模型版本	aerich upgrade	更新数据模型版本
降级模型版本	aerich downgrade	回退数据模型版本
查看迁移历史	aerich history	查看历史迁移记录

Tortoise ORM 查询参数详细说明

方法	描述	示例查询
get()	根据主键获取单条数据。如果数据不存在，将返回 None。	Model.get(id=1)
all()	查询所有数据，返回所有数据集（QuerySet 对象）。如果不加任何条件，它会返回表中的所有记录。	Model.all()
filter()	根据条件查询数据，返回满足条件的数据集（QuerySet 对象）。可以使用 all() 方法获取所有的查询结果，或者使用 first() 方法获取第一个结果。	Model.filter(name='John')
exclude()	排除满足条件的数据，返回不满足条件的数据集。	Model.exclude(name='John')
count()	统计满足条件的数据数量。	Model.filter(name='John').count()
order_by()	按照指定字段排序查询结果。	Model.all().order_by('name')

查询条件

运算符	描述	示例查询
__range	查询在指定范围之间。	Model.filter(age__range=(20, 30))
__isnull	是否为空（IS NULL）。	Model.filter(field__isnull=True)
__regex	正则表达式匹配（REGEXP 或 LIKE，取决于数据库）。	Model.filter(name__regex=r'John.*')
__iregex	不区分大小写的正则表达式匹配（IREGEXP 或 ILIKE，取决于数据库）。	Model.filter(name__iregex=r'john.*')
=	精确匹配。	Model.filter(name='John')
__not	不等于。	Model.filter(name__not='John')
__gt	大于。	Model.filter(age__gt=30)
__gte	大于或等于。	Model.filter(age__gte=30)
__lt	小于。	Model.filter(age__lt=30)
__lte	小于或等于。	Model.filter(age__lte=30)
__in	成员运算符，用于查询在指定列表中的值。	Model.filter(id__in=[1, 2, 3])
__nin	成员运算符，用于查询不在指定列表中的值。	Model.filter(id__nin=[1, 2, 3])
__icontains	模糊查询，包含指定字符串，不区分大小写。	Model.filter(name__icontains='john')
__istartswith	模糊查询，字符串以指定值开头，不区分大小写。	Model.filter(name__istartswith='john')
__iendswith	模糊查询，字符串以指定值结尾，不区分大小写。	Model.filter(name__iendswith='john')

Trotoise ORM 修改数据

一对多查询、多对多查询

一对多查询

查询所有学生的姓名

方法	描述
await Student.all().values("name")	获取所有学生的姓名

查询特定学生信息

方法	描述
await Student.get(name="张三")	获取姓名为"张三"的学生对象

属性	描述
students.sno	学号，2001
students.name	姓名，张三
students.clazzs_id	班级编号（外键），1
await students.clazzs.values("name")	查询班级名称，{‘name’: ‘计算机科学与技术’}

多对多查询

查询学生课程信息

方法	描述
await Student.all().values("name", "clazzs__name")	获取所有学生的姓名和班级名称
await Student.get(name="张三")	获取姓名为"张三"的学生对象
await students.courses.all()	张三学生所有的课程（一对多）
await students.courses.all().values("name")	张三学生所有的课程的名称（一对多）
await students.courses.all().values("name", "teacher__name")	张三学生所有的课程的名称和教师名称
await Student.all().values("name", "clazzs__name", "courses__name")	多个学生的所有课程对应的所有教师（多对多）

分页查询

方法	描述
await Student.all().limit(5)	获取前5个学生
await Student.all().offset(5).limit(5)	跳过前5个学生，再获取5个学生
await Student.filter(age__gt=20).limit(10)	获取年龄大于20的前10个学生
await Student.filter(age__gt=20).filter(name__contains="Hans")	获取年龄大于20且姓名包含"Hans"的学生

Tortoise ORM 数据修改

方法	描述
Student.filter(id=1).update(name="张三")	根据学生ID修改学生姓名为"张三"
students = await Student.all()	获取所有学生
for student in students: student.name += "Aa"	批量更新学生姓名，在每个姓名后面添加字符"Aa"

Trotoise ORM 新增数据

方法	描述
await Student.create(name="张不四", pwd=123456, sno=2007, clazzs_id=2)	新增一条学生数据
await Student.bulk_create([Student(name="批量新增名称"+str(i), pwd=123456, sno=2007+i, clazzs_id=2) for i in range(3)])	批量新增多条学生数据

方法	描述
await Student.create(...)	新增一条学生数据
await Student.bulk_create([...])	bulk_create() 方法是 Tortoise ORM 中用于批量新增数据的函数。该方法可以一次性将多个数据对象批量插入到数据库中，从而提高数据插入的效率。

示例：批量新增学生数据

create_student_object_list = await Student.bulk_create([
    Student(name="批量新增名称"+str(i), pwd=123456, sno=2007+i, clazzs_id=2) for i in range(3)
])

在这段代码中，我们首先创建了一个包含多个学生对象的列表，每个学生对象具有不同的属性。然后我们调用 bulk_create() 方法，传递包含学生对象的列表作为参数。Tortoise ORM 会将列表中的每个学生对象批量插入到数据库中。

通过使用 bulk_create() 方法，可以减少与数据库的交互次数，提高数据插入的效率，特别是在需要批量插入大量数据时尤为有用。