SQLModel 关系属性教程：使用 back_populates 实现双向关系

最新推荐文章于 2025-06-02 09:08:00 发布

申子琪

最新推荐文章于 2025-06-02 09:08:00 发布

阅读量276

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00889/article/details/148376223

SQLModel 关系属性教程：使用 back_populates 实现双向关系

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

理解 SQLModel 中的双向关系

在数据库设计中，实体之间的关系是核心概念之一。SQLModel 作为 Python 的 ORM 工具，提供了简洁而强大的方式来处理这些关系。本教程将重点介绍如何使用 back_populates 参数实现模型间的双向关系。

模型定义

我们首先定义两个模型：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 字段：在两个模型中都定义了 Relationship 字段，这是建立关系的基础。
back_populates 参数：这个参数在两个模型的 Relationship 中相互引用对方的关系属性名，建立了双向关联。
外键定义：在 Hero 模型中，team_id 字段作为外键关联到 Team 表的主键。

双向关系的优势

使用 back_populates 实现的双向关系有以下优点：

自动同步：当一端的关系发生变化时，另一端会自动更新。
代码直观：可以通过 hero.team 或 team.heroes 两种方式访问关联数据。
减少冗余查询：ORM 会自动处理关联数据的加载，减少手动查询的需要。

实际操作示例

创建团队和英雄

team_preventers = Team(name="Preventers", headquarters="Sharp Tower")
hero_rusty_man = Hero(name="Rusty-Man", secret_name="Tommy Sharp", age=48, team=team_preventers)

这里我们创建了一个团队和一个英雄，并将英雄直接关联到团队。由于双向关系的存在，团队对象的 heroes 列表会自动包含这个英雄。

批量添加英雄到团队

hero_tarantula = Hero(name="Tarantula", secret_name="Natalia Roman-on", age=32)
team_preventers.heroes.append(hero_tarantula)

通过团队的 heroes 列表添加英雄，同样会自动设置英雄的 team 属性。

查询关联数据

statement = select(Team).where(Team.name == "Preventers")
team_preventers = session.exec(statement).one()
print("Preventers heroes:", team_preventers.heroes)

查询团队时，可以直接访问其关联的英雄列表。