FastAPI - Tortoise ORM 数据库基础操作

文章目录

      • 1. 安装 Tortoise ORM
      • 2. 定义模型
      • 3. 初始化数据库连接
      • 4. 数据库操作
        • 4.1 创建数据
        • 4.2 查询数据
        • 4.3 更新数据
        • 4.4 删除数据
      • 5. 使用 Pydantic 模型
      • 6. 关闭数据库连接
      • 7. fields类相关操作
        • 1. `fields.IntField`
        • 2. `fields.BigIntField`
        • 3. `fields.SmallIntField`
        • 4. `fields.CharField`
        • 5. `fields.TextField`
        • 6. `fields.BooleanField`
        • 7. `fields.FloatField`
        • 8. `fields.DecimalField`
        • 9. `fields.DatetimeField`
        • 10. `fields.DateField`
        • 11. `fields.TimeField`
        • 12. `fields.JSONField`
        • 13. `fields.BinaryField`
        • 14. `fields.ForeignKeyField`
        • 15. `fields.ManyToManyField`
        • 16. `fields.OneToOneField`
        • 其他字段
      • 8. ORM(对象关系映射)数据迁移
        • 1. 初始化迁移环境
        • 2. 创建迁移文件
        • 3. 应用迁移
        • 4. 查看迁移状态
        • 5. 回滚迁移
        • 6. 生成模型
        • 7. 清除迁移历史


Tortoise ORM 是一个异步的 ORM 框架,使用 Python 的类和对象来操作数据库,不需要编写 SQL 语句。


1. 安装 Tortoise ORM

首先,确保已经安装 Tortoise ORM。如果还没有安装,可以使用 pip 来安装:

pip install tortoise-orm

2. 定义模型

使用 Tortoise ORM, 需要定义模型类来表示数据库中的表。模型类继承自 tortoise.models.Model

from tortoise import fields, models
from tortoise.contrib.pydantic import pydantic_model_creatorclass Tournament(models.Model):id = fields.IntField(pk=True)name = fields.CharField(max_length=255)created_at = fields.DatetimeField(auto_now_add=True)class Meta:table = 'tournaments'  # 自定义表名# 创建 Pydantic 模型
Tournament_Pydantic = pydantic_model_creator(Tournament, name="Tournament")

3. 初始化数据库连接

在使用 Tortoise ORM 之前,需要初始化数据库连接。

from tortoise import Tortoise, run_asyncasync def init_db():# 这里使用 SQLite 数据库作为示例await Tortoise.init(db_url='sqlite://db.sqlite3',modules={'models': ['your_app']}  # 你的模型所在的模块)# 生成数据库表结构await Tortoise.generate_schemas()# 运行初始化函数
run_async(init_db())

4. 数据库操作

定义好模型和数据库连接后,可以进行各种数据库操作。

4.1 创建数据
async def create_tournament():tournament = await Tournament.create(name='New Tournament')print(f'Created tournament with id: {tournament.id}')run_async(create_tournament())
4.2 查询数据
async def get_tournaments():tournaments = await Tournament.all()for tournament in tournaments:print(f'Tournament: {tournament.name}')run_async(get_tournaments())
4.3 更新数据
async def update_tournament(tournament_id: int, new_name: str):await Tournament.filter(id=tournament_id).update(name=new_name)print(f'Updated tournament with id: {tournament_id}')run_async(update_tournament(1, 'Updated Tournament'))
4.4 删除数据
async def delete_tournament(tournament_id: int):await Tournament.filter(id=tournament_id).delete()print(f'Deleted tournament with id: {tournament_id}')run_async(delete_tournament(1))

5. 使用 Pydantic 模型

Tortoise ORM 提供了 pydantic_model_creator 函数,可以自动生成 Pydantic 模型。

# 创建 Pydantic 模型
Tournament_Pydantic = pydantic_model_creator(Tournament, name="Tournament")# 使用 Pydantic 模型
tournament_data = Tournament_Pydantic.from_orm(tournament)
print(tournament_data.json())

6. 关闭数据库连接

在应用结束时,确保关闭数据库连接。

from tortoise import Tortoise# 关闭数据库连接
@app.on_event("shutdown")
async def close_orm():await Tortoise.close_connections()

7. fields类相关操作

在 Tortoise ORM 中,fields 是模型中用于定义数据库表字段的类。这些字段类定义了数据库表中每个字段的类型、约束和其他属性。以下是 Tortoise ORM 中一些常用的 fields 类:

1. fields.IntField

用于定义整数字段。

from tortoise import fieldsclass MyModel(Model):id = fields.IntField(pk=True)
2. fields.BigIntField

用于定义大整数字段。

from tortoise import fieldsclass MyModel(Model):id = fields.BigIntField(pk=True)
3. fields.SmallIntField

用于定义小整数字段。

from tortoise import fieldsclass MyModel(Model):id = fields.SmallIntField(pk=True)
4. fields.CharField

用于定义字符字段,通常用于存储短文本。

from tortoise import fieldsclass MyModel(Model):name = fields.CharField(max_length=255)
5. fields.TextField

用于定义文本字段,通常用于存储长文本。

from tortoise import fieldsclass MyModel(Model):description = fields.TextField()
6. fields.BooleanField

用于定义布尔字段。

from tortoise import fieldsclass MyModel(Model):is_active = fields.BooleanField()
7. fields.FloatField

用于定义浮点数字段。

from tortoise import fieldsclass MyModel(Model):price = fields.FloatField()
8. fields.DecimalField

用于定义精确小数字段。

from tortoise import fieldsclass MyModel(Model):balance = fields.DecimalField(max_digits=10, decimal_places=2)
9. fields.DatetimeField

用于定义日期时间字段。

from tortoise import fieldsclass MyModel(Model):created_at = fields.DatetimeField(auto_now_add=True)
10. fields.DateField

用于定义日期字段。

from tortoise import fieldsclass MyModel(Model):birth_date = fields.DateField()
11. fields.TimeField

用于定义时间字段。

from tortoise import fieldsclass MyModel(Model):start_time = fields.TimeField()
12. fields.JSONField

用于定义 JSON 字段,可以存储复杂的数据结构。

from tortoise import fieldsclass MyModel(Model):data = fields.JSONField()
13. fields.BinaryField

用于定义二进制字段,可以存储二进制数据。

from tortoise import fieldsclass MyModel(Model):image = fields.BinaryField()
14. fields.ForeignKeyField

用于定义外键字段,用于建立模型之间的关系。

from tortoise import fieldsclass MyModel(Model):user = fields.ForeignKeyField('models.User')
15. fields.ManyToManyField

用于定义多对多字段,用于建立模型之间的多对多关系。

from tortoise import fieldsclass MyModel(Model):tags = fields.ManyToManyField('models.Tag')
16. fields.OneToOneField

用于定义一对一字段,用于建立模型之间的关系。

from tortoise import fieldsclass MyModel(Model):profile = fields.OneToOneField('models.Profile')
其他字段

Tortoise ORM 还提供了其他一些字段,如 fields.UUIDFieldfields.IPAddressFieldfields.EmailField 等,用于处理特定类型的数据。

在定义模型字段时,可以设置各种属性,如 nulldefaultpkuniqueindex 等,以控制字段的行为和约束。


8. ORM(对象关系映射)数据迁移

ORM(对象关系映射)数据迁移是管理数据库模式更改的过程。在使用 ORM 时,通常会使用 ORM 提供的迁移工具来处理数据库模式的变更,而不是直接编写 SQL 语句。以下是一些常见的 ORM 迁移命令:

1. 初始化迁移环境

在开始使用迁移之前,需要初始化迁移环境, 涉及到设置数据库连接和配置迁移目录。

# 使用 Tortoise ORM 的迁移工具
tortoise-orm init-db
2. 创建迁移文件

一旦迁移环境设置好,可以创建迁移文件来描述你的数据库模式更改。

# 创建一个新的迁移文件
tortoise-orm makemigrations

这将生成一个新的迁移文件,其中包含了对数据库模式的更改。

3. 应用迁移

创建迁移文件后,可以应用这些迁移来更新数据库模式。

# 应用所有未应用的迁移
tortoise-orm migrate
4. 查看迁移状态

如果查看当前的迁移状态,可以使用以下命令:

# 查看当前的迁移状态
tortoise-orm showmigrations
5. 回滚迁移

如果需要回滚迁移,可以使用命令:

# 回滚最近的一次迁移
tortoise-orm migrate --revision=-1
6. 生成模型

如果需要根据数据库生成模型,可以使用命令:

# 生成模型
tortoise-orm inspectdb
7. 清除迁移历史

如果清除迁移历史,可以使用命令:

# 清除迁移历史
tortoise-orm reset

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/836937.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【LAMMPS学习】八、基础知识(6.3)使用 LAMMPS GUI

8. 基础知识 此部分描述了如何使用 LAMMPS 为用户和开发人员执行各种任务。术语表页面还列出了 MD 术语,以及相应 LAMMPS 手册页的链接。 LAMMPS 源代码分发的 examples 目录中包含的示例输入脚本以及示例脚本页面上突出显示的示例输入脚本还展示了如何设置和运行各种模拟。 …

西门子博途WINCC动画之旋转运动

概述 本例将介绍在西门子 TIA Portal HMI 中旋转运动动画的一种实现方法。本例以风机、搅拌器和传送带为例,按下启动按钮开始转动,按下停止按钮停止转动。 第1步: 添加 PLC 设备。​博途TIA/WINCC社区VX群 ​博途TIA/WINCC社区VX群 选择西…

PyQt5中的QGraphicsView()

文章目录 1. 简介2. 一个简单的示例2. 加载一幅图片3. 常用方法示例 1. 简介 QGraphicsView是PyQt5中用于显示图形场景的小部件,它提供了许多常用的方法来控制视图的行为和属性。下面是一些常用的QGraphicsView方法: setScene(scene): 设置要显示的场景…

从零开始写 Docker(十四)---重构:实现容器间 rootfs 隔离

本文为从零开始写 Docker 系列第十四篇,实现容器间的 rootfs 隔离,使得多个容器间互不影响。 完整代码见:https://github.com/lixd/mydocker 欢迎 Star 推荐阅读以下文章对 docker 基本实现有一个大致认识: 核心原理:…

SpringCloud 集成 RocketMQ 及配置解析

文章目录 前言一、SpringCloud 集成 RocketMQ1. pom 依赖2. yml 配置3. 操作实体4. 生产消息4.1. 自动发送消息4.2. 手动发送消息 5. 消费消息 二、配置解析1. spring.cloud.stream.function.definition 前言 定义 Spring Cloud Stream 是一个用来为微服务应用构建消息驱动能力…

spacy微调BERT-NER模型

数据准备 加载数据集 from tqdm.notebook import tqdm import osdataset [] with open(train_file, r) as file:for line in tqdm(file.readlines()):data json.loads(line.strip())dataset.append(data)你可以按照 CLUENER 的格式准备训练数据, 例如&#xff1…

(done) Beam search

参考视频1:https://www.bilibili.com/video/BV1Gs421N7S1/?spm_id_from333.337.search-card.all.click&vd_source7a1a0bc74158c6993c7355c5490fc600 (beam search 视频) 参考博客1:https://jasonhhao.github.io/2020/06/19/…

在word中创建宏来多级列表的编号不显示的bug

出现问题的示意图如下,可以看出标题前面1.1消失了 第一步:选择开发工具 第二步: 第三步:选择当前文件(创建宏后,方便查找) 第四步: 第五步:打卡VB 第七步&#xf…

ONVIF系列一:ONVIF介绍

感谢博主OceanStar的学习笔记,ONVIF系列二和系列三中安装操作过程及代码实现参考了这位博主的博客。 ONVIF系列: ONVIF系列一:ONVIF介绍 ONVIF系列二:Ubuntu安装gSOAP、生成ONVIF代码框架 ONVIF系列三:ONVIF客户端实现…

机器人开发项目实现过程

比赛项目实现过程 第一步:设置远程桌面连接 登录机器人系统,设置网络,参考远程桌面连接20230525.mp4 外接显示器、鼠标和键盘 登录系统 账户:robuster 密码:123456 建议,手机开热点,机器人…

消费新纪元:探索消费增值的财富之旅

你是否曾对日常消费感到一丝无奈,觉得钱一旦花出去就如同流水般逝去,再也无法追回?现在,让我为你揭示一种革命性的消费观念——消费增值,它不仅能满足你的物质需求,还能让你的资金像滚雪球般持续增长&#…

鸿蒙ArkUI开发:常用布局【弹性布局方向图】

弹性布局方向图 Flex({ direction: FlexDirection.Row }) FlexDirection.Row(默认值):主轴为水平方向,子组件从起始端沿着水平方向开始排布FlexDirection.RowReverse:主轴为水平方向,子组件从终点端沿着F…

关于我个人的编码规范(C/C++)

文章目录 前言一、文件结构1. 版权和版本声明(不是必须,但是我建议看看)2. 头文件结构3. 源文件结构 二、排版(以 K&R 风格为主)1. 缩进与左花括号的位置2. 空行的插入3. 该分行就分行4. 花括号5. 长语句分段6. 空…

vscode 实现本地服务器部署小结

在查阅 MDN 网站的时候,偶然发现的原来 vscode 也可以实现本地化服务器部署,来模拟服务器的运行。 安装插件 在VSCode的插件市场搜索并安装以下插件: – Live Server(用于开启本地服务器) – Debugger for Chrome&a…

【WB】微博爬虫案例_无头浏览器采集_selenium/playwright/requests方式采集

人立晚风月照中 独散步长廊 月浸在池塘 欢欣充满了心上 静听乐悠扬 越觉乐洋洋 夜鸟高枝齐和唱 月照彩云上 熏风轻掠 如入山荫心向往 🎵 苏妙玲《彩云追月》 import timeimport requests from playwright._impl._errors import TimeoutError f…

算法设计与分析(超详解!) 第三节 贪婪算法

1.贪心算法基础 1.贪心算法的基本思想 贪心算法是从问题的某一个初始解出发,向给定的目标推进。但它与普通递推求解过程不同的是,其推动的每一步不是依据某一固定的递推式,而是做一个当时看似最佳的贪心选择,不断地将问题实例归…

【C++】string类的使用④(字符串操作String operations || 常量成员Member constants)

🔥个人主页: Forcible Bug Maker 🔥专栏: STL || C 目录 前言🔥字符串操作(String operations)c_strdataget_allocatorcopyfindrfindfind_first_offind_last_offind_first_not_offind_last_not…

11、FreeRTOS 队列、队列集,邮箱的使用

文章目录 一、队列的特性1.1 队列常规操作1.2 传输数据的两种方法1.3 队列的阻塞访问 二 队列函数2.1创建2.2 复位2.3 删除2.4 写队列2.5 读队列2.6 查询2.7 覆盖/偷看 三、示例3.1示例 队列的基本使用3.2 示例: 分辨数据源3.3 示例: 传输大块数据3.4 : 邮箱(Mailbox) 四、队列…

白盒测试:覆盖测试及测试用例设计

白盒测试:覆盖测试及测试用例设计 一、实验目的 1、掌握白盒测试的概念。 2、掌握逻辑覆盖法。 二、实验任务 某工资计算程序功能如下:若雇员月工作小时超过40小时,则超过部分按原小时工资的1.5倍的加班工资来计算。若雇员月工作小时超过…

ansible -playbook运维工具、语法、数据结构、命令用法、触发器、角色

目录 配置文件 基本语法规则: YAML支持的数据结构 playbook核心元素 ansible-playbook用法: 触发器 特点: 角色: 习题: 配置文件 playbook配置文件使用yaml语法,YAML 是一门标记性语言,专门用来写配…