SQLAlchemy中的邻接表模式实现树形结构-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00264/article/details/148577495

SQLAlchemy中的邻接表模式实现树形结构

sqlalchemy THIS IS NOT THE OFFICIAL REPO - PLEASE SUBMIT PRs ETC AT: http://github.com/sqlalchemy/sqlalchemy 项目地址: https://gitcode.com/gh_mirrors/sql/sqlalchemy

本文将深入探讨如何使用SQLAlchemy的ORM功能实现邻接表模式的树形结构存储。邻接表是一种常见的设计模式，用于在关系型数据库中表示树形或层级数据。

邻接表模式简介

邻接表模式通过在表中添加一个指向父节点的外键列来表示树形结构。每个节点记录都包含一个指向其父节点的引用（除了根节点）。这种模式简单直观，适合大多数树形结构的存储需求。

模型定义

在SQLAlchemy中，我们首先定义一个基础模型类Base，它继承自DeclarativeBase，这是SQLAlchemy 2.0风格声明式模型的基础类。

class Base(DeclarativeBase):
    pass

接下来定义树节点模型TreeNode，它同时继承自MappedAsDataclass和Base：

class TreeNode(MappedAsDataclass, Base):
    __tablename__ = "tree"
    
    id: Mapped[int] = mapped_column(primary_key=True, init=False)
    parent_id: Mapped[Optional[int]] = mapped_column(
        ForeignKey("tree.id"), init=False
    )
    name: Mapped[str]
    
    children: Mapped[Dict[str, TreeNode]] = relationship(
        cascade="all, delete-orphan",
        back_populates="parent",
        collection_class=attribute_keyed_dict("name"),
        init=False,
        repr=False,
    )
    
    parent: Mapped[Optional[TreeNode]] = relationship(
        back_populates="children", remote_side=id, default=None
    )

关键字段解析

id：主键字段，自动生成
parent_id：外键字段，指向同一表中的父节点id
name：节点名称
children：子节点集合，使用字典形式存储，键为子节点名称
parent：父节点引用

关系配置详解

children关系配置了几个重要参数：

cascade="all, delete-orphan"：设置级联操作，当父节点被删除时自动删除子节点
back_populates="parent"：双向关系配置
collection_class=attribute_keyed_dict("name")：使用节点名称作为字典键来组织子节点
init=False：不在构造函数中初始化此字段

parent关系配置了remote_side=id，表明这是自引用关系。

实用方法

模型定义了一个dump()方法，用于以缩进格式打印树形结构：

def dump(self, _indent: int = 0) -> str:
    return (
        "   " * _indent
        + repr(self)
        + "\n"
        + "".join([c.dump(_indent + 1) for c in self.children.values()])
    )

这个方法递归遍历所有子节点，生成格式化的树形表示。

实际操作示例

示例代码展示了如何创建、修改和查询树形结构：

创建树结构：

node = TreeNode("rootnode")
TreeNode("node1", parent=node)
TreeNode("node3", parent=node)

添加子节点：

node2 = TreeNode("node2")
TreeNode("subnode1", parent=node2)
node.children["node2"] = node2

删除节点：
```
del node.children["node1"]
```

查询树结构：

node = session.scalars(
    select(TreeNode)
    .options(selectinload(TreeNode.children, recursion_depth=4))
    .filter(TreeNode.name == "rootnode")
).one()