
在数据库应用中,我们经常遇到需要维护对象之间多对多(n:m)关系,并且要求这些关联对象具有特定顺序的场景。例如,一个 folder(文件夹)包含多个 item(项目),每个 item 只能属于一个 folder,但 item 在 folder 中的显示顺序至关重要。
最初的实现可能尝试在 Folder 中存储一个 Item ID 列表来维护顺序,但这容易导致数据不一致:列表中的 ID 可能与实际关联的 Item 对象不符。更健壮的方法是使用 SQLAlchemy 的关联对象模式(Association Object Pattern),引入一个中间表来存储关联信息和顺序。
然而,当使用关联对象时,实现正确的级联删除(例如,删除一个 Folder 时,其关联的 Item 也应被删除)变得复杂。简单的 cascade="all, delete-orphan" 可能不足以覆盖所有层级的级联删除。
为了解决上述问题,我们引入一个关联表 FolderItemAssociation 来连接 Folder 和 Item,并在此表中添加一个 order 字段来维护顺序。
以下是使用关联对象模式定义 Folder、Item 和 FolderItemAssociation 的 SQLAlchemy 模型:
from sqlalchemy import (
create_engine,
Integer,
String,
BigInteger,
Column,
ForeignKey,
)
from sqlalchemy.orm import declarative_base, Session, relationship
Base = declarative_base()
class Folder(Base):
__tablename__ = "folder"
id = Column(Integer, primary_key=True)
# 通过 FolderItemAssociation 关联 Item
item_associations = relationship(
"FolderItemAssociation",
back_populates="folder",
order_by="desc(FolderItemAssociation.order)", # 按照 order 字段降序排列
single_parent=True, # 确保 FolderItemAssociation 实例只有一个 Folder 父级
cascade="all, delete-orphan", # 级联删除 FolderItemAssociation
)
def __repr__(self):
return f"Folder(id={self.id}, item_associations={', '.join(repr(assoc) for assoc in self.item_associations)})"
class FolderItemAssociation(Base):
__tablename__ = "folder_item_association"
folder_id = Column(
Integer,
ForeignKey("folder.id", ondelete="CASCADE"), # 数据库层级联删除
primary_key=True,
)
item_id = Column(
Integer,
ForeignKey("item.id", ondelete="CASCADE"), # 数据库层级联删除
primary_key=True,
unique=True, # 确保一个 Item 只能关联到一个 Folder,从而实现 Item 到 Folder 的 1:M 关系
)
order = Column(
BigInteger,
# autoincrement=True, # 注意:autoincrement 在某些数据库(如PostgreSQL)中可能不会自动填充此列,需手动管理
)
folder = relationship(
"Folder",
back_populates="item_associations",
)
item = relationship(
"Item",
back_populates="folder_association",
# 关键配置:确保 Item 的生命周期由 FolderItemAssociation 管理
cascade="all, delete-orphan",
single_parent=True # 确保 Item 实例只有一个 FolderItemAssociation 父级
)
def __repr__(self):
return f"Assoc(id={(self.folder_id, self.item_id)}, order={self.order}, item={repr(self.item)})"
class Item(Base):
__tablename__ = "item"
id = Column(Integer, primary_key=True)
# Item 反向关联到 FolderItemAssociation
folder_association = relationship(
"FolderItemAssociation",
back_populates="item",
passive_deletes=True, # 依赖数据库的 ON DELETE CASCADE 行为
uselist=False, # Item 只有一个关联对象
)
def __repr__(self):
return f"Item(id={self.id})"
为了验证上述配置是否正确实现了级联删除,我们可以编写测试用例来模拟不同的删除场景。
# 假设 engine 已创建,例如:
# engine = create_engine(f"postgresql+psycopg2://{username}:{password}@/{db}", echo=False)
def reset(session):
"""清空所有表数据,用于测试前初始化。"""
session.query(Folder).delete()
session.query(FolderItemAssociation).delete()
session.query(Item).delete()
session.commit()
assert_counts(session, (0, 0, 0)) # 确保清空后计数为0
def assert_counts(session, expected_counts):
"""验证当前各表记录数是否符合预期。"""
counts = get_counts(session)
assert counts == expected_counts, f'Expected {expected_counts} but got {counts}'
def get_counts(session):
"""获取 Folder, FolderItemAssociation, Item 表的记录数。"""
return (
session.query(Folder).count(),
session.query(FolderItemAssociation).count(),
session.query(Item).count(),
)
def create_sample_folders(session):
"""创建示例数据:两个 Folder,每个包含两个 Item。"""
folder1 = Folder(
item_associations=[
FolderItemAssociation(item=Item()), FolderItemAssociation(item=Item())
]
)
session.add(folder1)
folder2 = Folder(
item_associations=[
FolderItemAssociation(item=Item()), FolderItemAssociation(item=Item())
]
)
session.add(folder2)
session.commit()
print(repr(folder1))
print(repr(folder2))
以下测试用例演示了不同删除操作的级联行为:
def test_folder_deletion_cascades_to_item():
"""测试:当 Folder 被删除时,其关联的 FolderItemAssociation 和 Item 都应被删除。"""
with Session(engine) as session:
create_sample_folders(session)
assert_counts(session, (2, 4, 4)) # 初始状态:2 Folder, 4 Association, 4 Item
# 删除一个 Folder
session.delete(session.query(Folder).first())
session.commit()
# 预期:剩余 1 Folder, 2 Association, 2 Item
assert_counts(session, (1, 2, 2))
reset(session) # 清空数据,为下一个测试准备
def test_item_deletion_does_not_delete_folder():
"""测试:当 Item 被删除时,Folder 不应被删除,但关联对象应被删除。"""
with Session(engine) as session:
create_sample_folders(session)
assert_counts(session, (2, 4, 4))
# 删除一个 Item
session.delete(session.query(Item).first())
session.commit()
# 预期:剩余 2 Folder, 3 Association, 3 Item
assert_counts(session, (2, 3, 3))
reset(session)
def test_association_deletion_cascades_to_item():
"""测试:当 FolderItemAssociation 被删除时,其关联的 Item 应被删除,Folder 不应被删除。"""
with Session(engine) as session:
create_sample_folders(session)
assert_counts(session, (2, 4, 4))
# 删除一个 FolderItemAssociation
session.delete(session.query(FolderItemAssociation).first())
session.commit()
# 预期:剩余 2 Folder, 3 Association, 3 Item
assert_counts(session, (2, 3, 3))
reset(session)
# 运行所有测试
# test_folder_deletion_cascades_to_item()
# test_item_deletion_does_not_delete_folder()
# test_association_deletion_cascades_to_item()
通过正确地使用 SQLAlchemy 的关联对象模式并配置 single_parent 和 cascade 参数,我们可以构建出健壮且具有正确级联删除行为的数据模型,有效管理复杂的多对多关系和对象生命周期。
以上就是SQLAlchemy 中带顺序的关联对象级联删除的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号