Release: 1.4.25 | Release Date: September 22, 2021

SQLAlchemy 1.4 Documentation

相邻列表关系

这个 邻接列表 模式是一种常见的关系模式,通过该模式,表包含对其自身的外键引用,换言之,是 自指关系 。这是在平面表格中表示分层数据的最常见方式。其他方法包括 嵌套集 ,有时称为“修改的预购”,以及 物化路径 。尽管在评估SQL查询内的流畅性时,修改的预排序很有吸引力,但由于并发性、降低复杂性的原因,邻接列表模型可能是最适合大多数分层存储需求的模式,而且与可以将子树完全加载到应用程序空间的应用程序相比,修改的预排序几乎没有什么优势。

参见

本节详细介绍自引用关系的单表版本。有关使用第二个表作为关联表的自引用关系,请参阅一节 自指多对多关系

在本例中,我们将使用一个名为 Node ,表示树结构:

class Node(Base):
    __tablename__ = 'node'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('node.id'))
    data = Column(String(50))
    children = relationship("Node")

使用此结构,可以创建如下图表:

root --+---> child1
       +---> child2 --+--> subchild1
       |              +--> subchild2
       +---> child3

将用以下数据表示:

id       parent_id     data
---      -------       ----
1        NULL          root
2        1             child1
3        1             child2
4        3             subchild1
5        3             subchild2
6        1             child3

这个 relationship() 此处的配置与“正常”的一对多关系的工作方式相同,但默认情况下,“方向”(即关系是一对多还是多对一)假定为一对多。为了建立多对一的关系,一个额外的指令被添加为 relationship.remote_side ,这是一个 Column 或收集 Column 指示应被视为“远程”的对象:

class Node(Base):
    __tablename__ = 'node'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('node.id'))
    data = Column(String(50))
    parent = relationship("Node", remote_side=[id])

在上面的地方, id 列应用为 relationship.remote_sideparent relationship() 从而建立 parent_id 作为“局部”的一方,这种关系表现为多对一。

和往常一样,使用 backref() 功能:

class Node(Base):
    __tablename__ = 'node'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('node.id'))
    data = Column(String(50))
    children = relationship("Node",
                backref=backref('parent', remote_side=[id])
            )

在sqlAlchemy中有几个例子说明了自引用策略;这些例子包括 邻接表XML持久化 .

复合邻接表

邻接列表关系的子类别是连接条件的“本地”和“远程”端都存在特定列的罕见情况。一个例子是 Folder 类;使用组合主键 account_id 列引用自身,以指示子文件夹与父文件夹在同一帐户内;而 folder_id 引用该帐户中的特定文件夹:

class Folder(Base):
    __tablename__ = 'folder'
    __table_args__ = (
      ForeignKeyConstraint(
          ['account_id', 'parent_id'],
          ['folder.account_id', 'folder.folder_id']),
    )

    account_id = Column(Integer, primary_key=True)
    folder_id = Column(Integer, primary_key=True)
    parent_id = Column(Integer)
    name = Column(String)

    parent_folder = relationship("Folder",
                        backref="child_folders",
                        remote_side=[account_id, folder_id]
                  )

以上,我们通过 account_id 进入 relationship.remote_side 名单。 relationship() 认识到 account_id 这里的列位于两侧,并将“远程”列与 folder_id 列,它识别出在“远程”端唯一存在的列。

自引用查询策略

自引用结构的查询与任何其他查询一样工作::

# get all nodes named 'child2'
session.query(Node).filter(Node.data=='child2')

但是,当尝试沿着外键从树的一个级别连接到下一个级别时,需要格外小心。在SQL中,从表到自身的联接要求表达式的至少一侧具有“别名”,以便可以明确地引用它。

回忆起 使用别名 在ORM教程中, aliased() 构造通常用于提供ORM实体的“别名”。从加入 Node 就其本身而言,使用这种技术的情况如下:

from sqlalchemy.orm import aliased

nodealias = aliased(Node)
session.query(Node).filter(Node.data=='subchild1').\
                join(Node.parent.of_type(nodealias)).\
                filter(nodealias.data=="child2").\
                all()
SELECT node.id AS node_id, node.parent_id AS node_parent_id, node.data AS node_data FROM node JOIN node AS node_1 ON node.parent_id = node_1.id WHERE node.data = ? AND node_1.data = ? ['subchild1', 'child2']

例如使用 aliased() 要跨任意长的自引用节点链连接,请参见 XML持久化 .

配置自引用预加载

在常规查询操作期间,使用从父表到子表的联接或outerjoin,可以从单个SQL语句或所有直接子集合的第二个语句填充父集合及其直接子集合或引用,从而实现对关系的预加载。当连接到相关项时,sqlAlchemy的joined和subquery eached loading在所有情况下都使用别名表,因此与自引用连接兼容。但是,要使用带有自引用关系的热切加载,需要告诉sqlAlchemy它应该连接和/或查询多少层深度;否则,热切加载根本不会发生。此深度设置通过配置 relationships.join_depth

class Node(Base):
    __tablename__ = 'node'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('node.id'))
    data = Column(String(50))
    children = relationship("Node",
                    lazy="joined",
                    join_depth=2)

session.query(Node).all()
SELECT node_1.id AS node_1_id, node_1.parent_id AS node_1_parent_id, node_1.data AS node_1_data, node_2.id AS node_2_id, node_2.parent_id AS node_2_parent_id, node_2.data AS node_2_data, node.id AS node_id, node.parent_id AS node_parent_id, node.data AS node_data FROM node LEFT OUTER JOIN node AS node_2 ON node.id = node_2.parent_id LEFT OUTER JOIN node AS node_1 ON node_2.id = node_1.parent_id []
Previous: 基本关系模式 Next: 链接与backref的关系