SQLModel 关系属性教程：创建与更新模型关系-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00919/article/details/148376227

SQLModel 关系属性教程：创建与更新模型关系

sqlmodel SQL databases in Python, designed for simplicity, compatibility, and robustness. 项目地址: https://gitcode.com/gh_mirrors/sq/sqlmodel

理解 SQLModel 的关系模型

SQLModel 是一个强大的 Python ORM 工具，它结合了 SQLAlchemy 和 Pydantic 的优点。在处理数据库关系时，SQLModel 提供了简洁而强大的方式来定义和管理模型之间的关系。

本教程将重点讲解如何使用 SQLModel 创建和更新模型之间的关系。我们将通过一个超级英雄团队的示例来演示这些概念。

模型定义

首先，我们定义了两个主要模型：Team（团队）和Hero（英雄）。

class Team(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str = Field(index=True)
    headquarters: str

    heroes: List["Hero"] = Relationship(back_populates="team")

class Hero(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str = Field(index=True)
    secret_name: str
    age: Optional[int] = Field(default=None, index=True)

    team_id: Optional[int] = Field(default=None, foreign_key="team.id")
    team: Optional[Team] = Relationship(back_populates="heroes")

关键点解析

双向关系：通过Relationship和back_populates参数，我们建立了Team和Hero之间的双向关系。
- 一个团队可以有多个英雄（一对多关系）
- 一个英雄可以属于一个团队
外键约束：Hero模型中的team_id字段通过foreign_key参数指向Team表的id字段，建立了数据库层面的外键关系。
可选关系：team和team_id都被定义为Optional，表示英雄可以不属于任何团队。

创建关系

在create_heroes函数中，我们演示了多种创建关系的方式：

方式1：通过属性直接赋值

hero_deadpond = Hero(name="Deadpond", secret_name="Dive Wilson", team=team_z_force)

这是最直观的方式，直接在创建英雄实例时指定其所属团队。

方式2：后期添加关系

hero_spider_boy.team = team_preventers
session.add(hero_spider_boy)

这种方式适用于先创建英雄实例，之后再将其分配到团队的情况。

方式3：通过团队添加英雄

team_preventers.heroes.append(hero_tarantula)

这种方式从团队的角度出发，将英雄添加到团队的英雄列表中。

方式4：创建团队时指定英雄

team_wakaland = Team(
    name="Wakaland",
    headquarters="Wakaland Capital City",
    heroes=[hero_black_lion, hero_sure_e],
)

这种方式在创建团队时就指定了其成员英雄。

数据库操作流程

创建会话：使用with Session(engine) as session:创建数据库会话
添加对象：使用session.add()将对象添加到会话
提交更改：使用session.commit()将更改持久化到数据库
刷新对象：使用session.refresh()从数据库重新加载对象的最新状态

最佳实践建议

一致性维护：当使用双向关系时，SQLModel 会自动维护关系的一致性。例如，当你将一个英雄添加到团队的英雄列表中，该英雄的team属性也会自动更新。
批量操作：当需要添加多个对象时，可以先创建所有对象，然后一次性提交，这比多次提交更高效。
刷新策略：在复杂的操作链中，适时刷新对象可以确保你总是使用最新的数据状态。
可选关系处理：对于可选关系，始终考虑None值的情况，避免空指针异常。