SQLModel 关系属性教程：使用 back_populates 实现双向关联-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00731/article/details/148376221

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

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

前言

在数据库设计中，表与表之间的关系是非常重要的一部分。SQLModel 作为 Python 的 ORM 工具，提供了简洁而强大的方式来处理表之间的关系。本教程将详细介绍如何使用 SQLModel 的关系属性功能，特别是如何通过 Relationship 和 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 字段：在 Team 模型中定义了 heroes 字段，类型为 List["Hero"]，表示一个团队可以有多个英雄。
外键字段：在 Hero 模型中定义了 team_id 作为外键，指向 Team 表的 id 字段。
双向关联：通过 back_populates 参数，我们建立了双向关联关系。Team.heroes 和 Hero.team 这两个关系属性相互关联，修改一方会自动反映到另一方。

数据库操作示例

创建数据库和表

def create_db_and_tables():
    SQLModel.metadata.create_all(engine)

创建英雄和团队

def create_heroes():
    with Session(engine) as session:
        # 创建团队
        team_preventers = Team(name="Preventers", headquarters="Sharp Tower")
        team_z_force = Team(name="Z-Force", headquarters="Sister Margaret's Bar")

        # 创建英雄并关联团队
        hero_deadpond = Hero(
            name="Deadpond", secret_name="Dive Wilson", team=team_z_force
        )
        hero_rusty_man = Hero(
            name="Rusty-Man", secret_name="Tommy Sharp", age=48, team=team_preventers
        )
        
        # 提交到数据库
        session.add(hero_deadpond)
        session.add(hero_rusty_man)
        session.commit()

查询操作

def select_heroes():
    with Session(engine) as session:
        # 查询特定团队
        statement = select(Team).where(Team.name == "Preventers")
        result = session.exec(statement)
        team_preventers = result.one()

        # 通过关系属性访问团队成员
        print("Preventers heroes:", team_preventers.heroes)

更新操作

def update_heroes():
    with Session(engine) as session:
        # 查询英雄
        hero_spider_boy = session.exec(
            select(Hero).where(Hero.name == "Spider-Boy")
        ).one()

        # 移除团队关联
        hero_spider_boy.team = None
        session.add(hero_spider_boy)
        session.commit()

关系操作的高级用法

从团队端添加英雄

# 创建新英雄
hero_tarantula = Hero(name="Tarantula", secret_name="Natalia Roman-on", age=32)

# 通过团队的关系属性添加英雄
team_preventers.heroes.append(hero_tarantula)
session.add(team_preventers)
session.commit()

批量添加英雄

# 创建多个英雄
hero_black_lion = Hero(name="Black Lion", secret_name="Trevor Challa", age=35)
hero_sure_e = Hero(name="Princess Sure-E", secret_name="Sure-E")

# 创建团队时直接关联英雄
team_wakaland = Team(
    name="Wakaland",
    headquarters="Wakaland Capital City",
    heroes=[hero_black_lion, hero_sure_e],
)
session.add(team_wakaland)
session.commit()