具有多态实体的子类关联表的 SQLAlchemy 设置

Posted 2023-02-19

【中文标题】具有多态实体的子类关联表的 SQLAlchemy 设置

【英文标题】：SQLAlchemy Setup For Subclassed Association Table With Polymorphic Entities

【发布时间】：2021-10-10 17:57:15

【问题描述】：

我是 python 和 sqlalchemy 的新手，但是建模情况相当复杂，我在设置时遇到了麻烦。它涉及一个关联表，其中关联表与其中一个实体具有多态关联。

我非常接近完成这项工作。当数据库中已经存在数据时，我可以按预期读取它和模型并与之交互。问题来自于写作，我会在展示代码后解决这个问题：

首先，有一个共享基类将tablename和id定义为postgres uuid

@as_declarative()
class Base(object):
    @declared_attr
    def __tablename__(cls):
        return cls.__name__.lower()

    id = Column(pg.UUID(as_uuid=True), primary_key=True, default=uuid4)

多态列中允许定义类型的枚举。虽然我最终会支持 Aaa 和 Bbb，但为了清楚起见，这个示例到目前为止只定义了 Bbb。

class EntityTypes(Enum):
    AAA = Aaa.__name__.lower()
    BBB = Bbb.__name__.lower()

这是表示多态关联表的模型。它具有用于连接的 entity_id、entity_type 和 ccc_id 列。 “实体”可以是 Aaa 或 Bbb，但 Ccc 始终是 Ccc（非多态）。

class EntityCcc(Base):
    """Polymorphic mapping between an EntityType and Ccc."""
    
    # entity_id is defined in subclasses, with foreign keys
    entity_type = Column(
        Enum(EntityTypes, values_callable=lambda x: [e.value for e in x]), nullable=False
    )

    ccc_id = Column(
        pg.UUID(as_uuid=True),
        ForeignKey(f"Ccc.__tablename__.id"),
        nullable=False
    )

    __mapper_args__ = 
        "polymorphic_on": entity_type
    

这是多态模型的一个子类，它知道Bbbs，因此它相应地设置外键，并设置关系。将定义一个类似的AaaCcc 类

class BbbCcc(EntityCcc):
    """
        Mapping between a Bbb and Ccc.
        Subclasses polymorphic join model to get specific
        bbb accessor and set appropriate foreign key.
    """

    __tablename__ = EntityCcc.__tablename__

    entity_id = Column(
        pg.UUID(as_uuid=True), ForeignKey(f"Bbb.__tablename__.id"), nullable=False
    )

    bbb = relationship("Bbb", back_populates='bbb_ccc')
    ccc = relationship("Ccc", back_populates='bbb_ccc')

    __mapper_args__ = 
        "polymorphic_identity": EntityTypes(Bbb.__name__.lower())
    

这是一个Bbb，它具有与子类连接模型的关系设置，以及通过连接表指向其Ccc 的辅助关系设置（使用secondary）

class Bbb(Base):
    """Represents a Bbb entity."""

    name = Column(TEXT)

    bbb_ccc = relationship("BbbCcc", back_populates="bbb", uselist=False)

    ccc = relationship(
        "Ccc",
        secondary="entity_ccc",
        back_populates="bbb",
        uselist=False
    )

这是一个 Ccc，它具有与子类连接模型的关系设置，以及通过连接表指向其 Bbb 的辅助关系设置（使用 secondary）

class Ccc(Base):
    """Represents a Ccc entity."""

    name = Column(TEXT)

    bbb_ccc = relationship("BbbCcc", back_populates="ccc", uselist=False)

    bbb = relationship(
        "Bbb",
        secondary="entity_ccc",
        back_populates="ccc",
        uselist=False
    )

---

那么问题出在哪里？

在数据库中已经播种了适当的条目后，我可以按预期与它们进行交互：

(Pdb) found_bbb_ccc = db.session.query(BbbCcc).get(uuid)
(Pdb) found_bbb_ccc
<app.models.mappings.bbb_ccc.BbbCcc object at 0x7f488ce6ebe0>
(Pdb) found_bbb_ccc.bbb
<app.models.entities.bbb.Bbb object at 0x7f488dd73f10>
(Pdb) found_bbb_ccc.ccc
<app.models.entities.ccc.Ccc object at 0x7f488ce6ec40>
(Pdb) found_bbb_ccc.bbb.ccc
<app.models.entities.ccc.Ccc object at 0x7f488ce6ec40>
(Pdb) found_bbb_ccc.ccc.bbb
<app.models.entities.bbb.Bbb object at 0x7f488dd73f10>

这表明bbb可以通过join模型引用并找到它的ccc，反之亦然。通读协会很好。但是通过写作来建立新的联想是有问题的：

new_bbb = Bbb(name='Bbb instance')
new_ccc = Ccc(name='Ccc instance')

new_bbb.ccc = new_ccc
db.session.commit()

*** sqlalchemy.exc.IntegrityError: (psycopg2.errors.NotNullViolation) null value in column "entity_type" violates not-null constraint
DETAIL:  Failing row contains (4b1f7ac7-16b0-4972-9577-bda1b5efe2aa, 2021-08-05 17:50:05.233465, 2021-08-05 17:50:05.233482, 63463492-0a9d-492f-b42a-72ec276f2768, null, a75d06af-33bd-4345-abbd-c6098e9a797d).

[SQL: INSERT INTO entity_ccc (created, updated, id, ccc_id, entity_id) VALUES (%(created)s, %(updated)s, %(id)s, %(ccc_id)s, %(entity_id)s)]
[parameters: 'created': datetime.datetime(2021, 8, 5, 17, 50, 5, 233465), 'updated': datetime.datetime(2021, 8, 5, 17, 50, 5, 233482), 'id': UUID('4b1f7ac7-16b0-4972-9577-bda1b5efe2aa'), 'ccc_id': UUID('a75d06af-33bd-4345-abbd-c6098e9a797d'), 'entity_id': UUID('63463492-0a9d-492f-b42a-72ec276f2768')]
(Background on this error at: http://sqlalche.me/e/14/gkpj)

看到的错误是这个数据的写入没有设置多态entity_type，这里应该是bbb。我认为问题在于secondary 关系定义需要一个表名，而不是一个对象（传递BbbCcc 可能会选择entity_type 对吗？）但也许是别的东西。

如何调整此代码以允许设置所描述的多态关联？谢谢！

【问题讨论】：

在 SQLAlchemy github repo 上交叉发布here，但无法获得它

【参考方案1】：

试试

from sqlalchemy import inspect

    [...]
    eng_mapper = inspect(Engineer)
    query.filter(
        eng_mapper.polymorphic_on.in_(
            m.polymorphic_identity
            for m in eng_mapper.polymorphic_iterator()
        ),
    )

我更喜欢稍微不那么冗长的咒语，但这很有效，并且不需要了解多态层次结构的具体配置。

详情 当在 ORM 映射类上调用 inspect() 时，它会返回该类的 Mapper。这与 Model.ma​​pper 类属性相同。

Mapper 包含内省多态层次结构所需的所有信息。特别是：

.polymorphic_on 是模型中位于层次结构顶部的字段（列），其中包含记录的多态标识值（例如，对于 Engineer 而言，它将是 Employee.type 字段）。 .polymorphic_identity 是映射模型的每个实例将在 .polymorphic_on 字段中具有的值（例如，对于工程师来说，这将是“工程师”）。 .polymorphic_iterator() 迭代模型映射器的集合，其中包括 Model.ma​​pper 和所有 Model 子类的 .ma​​pper只有工程师。映射器）。 为了使其更具可读性，可以轻松地将上述过滤器表达式转换为函数：

从 sqlalchemy 导入检查

def filter_instances_of(cls):
    mapper = inspect(cls)
    return mapper.polymorphic_on.in_(
        m.polymorphic_identity for m in mapper.polymorphic_iterator()
    )

并像这样使用它：

query = query.filter(
    filter_instances_of(Engineer),
    [... other filter criteria ...]
)