SQLModel 教程：使用 Relationship 实现模型关联关系

SQLModel 教程：使用 Relationship 实现模型关联关系

【免费下载链接】sqlmodel SQL databases in Python, designed for simplicity, compatibility, and robustness. 项目地址: https://gitcode.com/gh_mirrors/sq/sqlmodel

理解 SQLModel 中的模型关联

在关系型数据库中，表与表之间的关联是非常常见的需求。SQLModel 作为 Python 的 ORM 工具，提供了简洁而强大的方式来处理模型之间的关系。本教程将深入讲解如何使用 SQLModel 的 Relationship 功能来建立和管理模型间的关联。

基础模型定义

首先，我们定义了两个基础模型：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")

关键点解析

1. Relationship 双向关联：通过 back_populates 参数，我们建立了双向关联。Team 的 heroes 属性和 Hero 的 team 属性相互关联。

2. 外键定义：Hero 模型中的 team_id 字段通过 foreign_key="team.id" 指定了外键关系。

3. 类型注解：使用 Python 的类型注解系统，明确指定了关联类型（List["Hero"] 和 Optional[Team]）。

数据库操作实践

创建数据库和表

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

这个函数会基于我们定义的模型自动创建数据库表结构，包括外键约束。

创建数据记录

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

1. 直接赋值：创建英雄时直接指定所属团队

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

2. 后期关联：先创建英雄，再指定团队

   hero_spider_boy.team = team_preventers
   

3. 批量关联：创建团队时直接指定成员列表

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

4. 追加成员：通过列表操作添加成员

   team_preventers.heroes.append(hero_tarantula)
   

查询关联数据

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)

这个查询展示了如何通过团队获取其所有英雄成员，得益于 Relationship 的定义，我们可以直接访问 team_preventers.heroes 来获取关联数据。

更新关联关系

def update_heroes():
    with Session(engine) as session:
        statement = select(Hero).where(Hero.name == "Spider-Boy")
        result = session.exec(statement)
        hero_spider_boy = result.one()

        hero_spider_boy.team = None
        session.add(hero_spider_boy)
        session.commit()

这段代码演示了如何解除英雄与团队的关联关系，只需将 team 属性设为 None 即可。

实际应用建议

1. 延迟加载：SQLModel 的关系是延迟加载的，只有在实际访问关联属性时才会执行查询。

2. 级联操作：在实际项目中，你可能需要配置级联删除等行为，可以通过 Relationship 的其他参数实现。

3. 性能考虑：对于大型数据集，直接访问关联属性可能导致 N+1 查询问题，可以考虑使用 join 加载策略。

4. 数据一致性：SQLModel 会自动维护双向关系的一致性，当你修改一端时，另一端会自动更新。

总结

通过本教程，我们学习了如何使用 SQLModel 的 Relationship 功能来建立和管理模型间的一对多关系。这种关系映射不仅简化了数据库操作，还保持了代码的清晰性和类型安全性。SQLModel 的关系功能设计既符合 Python 的简洁哲学，又提供了强大的数据库操作能力，是构建数据驱动应用的理想选择。

【免费下载链接】sqlmodel SQL databases in Python, designed for simplicity, compatibility, and robustness. 项目地址: https://gitcode.com/gh_mirrors/sq/sqlmodel