0

0

sqlalchemy 如何实现逻辑删除并在查询中自动过滤

舞夢輝影

舞夢輝影

发布时间:2026-01-26 19:43:48

|

489人浏览过

|

来源于php中文网

原创

逻辑删除是通过deleted_at等字段标记数据“已删除”而非物理删除,需自动过滤未删除记录以避免遗漏;SQLAlchemy需结合Query子类、事件监听和显式关系条件实现全局、安全、可绕过的软删机制。

sqlalchemy 如何实现逻辑删除并在查询中自动过滤

什么是逻辑删除,为什么不能只靠 WHERE deleted_at IS NULL

逻辑删除不是真删数据,而是用字段(比如 deleted_atis_deleted)标记某条记录“已删除”。但手动在每个查询里加 WHERE deleted_at IS NULL 极易遗漏,尤其 ORM 场景下关联查询、query.filter()join() 都可能绕过这个条件。

SQLAlchemy 本身不内置逻辑删除支持,得靠组合机制实现“自动过滤”——核心是让所有查询默认带上未删除条件,且不影响硬删除、恢复、以及显式查已删除数据的场景。

__mapper_args__ + default / server_default 初始化删除字段

先确保模型有可被查询和更新的删除标识字段。推荐用 deleted_at(datetime 类型),比布尔值更利于审计和软恢复。

  • deleted_at 设为 nullable=True,插入时默认为 None(即未删除)
  • default=Noneserver_default=text("NULL") 双保险,避免 ORM 层或直连 SQL 插入时意外写入非空值
  • 不要用 is_deleted = Column(Boolean, default=False),它无法区分“从未删除”和“删过又恢复”的状态
from sqlalchemy import Column, Integer, String, DateTime, text
from sqlalchemy.ext.declarative import declarative_base
from datetime import datetime

Base = declarative_base()

class User(Base): tablename = 'users' id = Column(Integer, primary_key=True) name = Column(String(50)) deleted_at = Column(DateTime, nullable=True, default=None, server_default=text("NULL"))

Query 子类 + session.query_class 实现全局自动过滤

这是最稳定、兼容性最好的方式:自定义一个继承 Query 的类,在 all()first()filter() 等方法触发前自动补上未删除条件;同时保留绕过能力(比如查回收站时显式指定 deleted_at.isnot(None))。

可赞AI
可赞AI

文字一秒可视化,免费AI办公神器

下载
  • 重写 __iter__()all() 不够,必须覆盖 _execute_and_instances() 或更底层的 __clause_element__() —— 实际推荐直接改写 filter()filter_by(),再配合 enable_assertions=False 避免重复添加
  • 通过 session.query_class = SoftDeleteQuery 注入到 session,所有 session.query(Model) 都生效
  • 关键点:只对“未显式涉及 deleted_at 字段”的查询自动加条件;一旦用户写了 .filter(User.deleted_at.isnot(None)),就不干预
from sqlalchemy.orm import Query

class SoftDeleteQuery(Query): def new(cls, *args, **kwargs):

检查是否已手动过滤 deleted_at,避免重复添加

    if args and hasattr(args[0], '__table__'):
        has_deleted_filter = any(
            isinstance(criterion, (BinaryExpression, BooleanClauseList))
            and 'deleted_at' in str(criterion)
            for criterion in getattr(args[0], '_whereclause', []).compile().params.keys()
        )
        # 实际判断需解析 where clause,此处简化示意;生产建议用 _whereclause.traverse()
    return super().__new__(cls)

def filter(self, *criterion):
    # 如果没显式过滤 deleted_at,自动加上
    from sqlalchemy.sql import expression
    from sqlalchemy import or_
    no_deleted_filter = all(
        not (hasattr(c, 'left') and hasattr(c.left, 'name') and c.left.name == 'deleted_at')
        for c in criterion
    )
    if no_deleted_filter:
        criterion = criterion + (self.mapper.class_.deleted_at.is_(None),)
    return super().filter(*criterion)

然后创建 session 时绑定:

from sqlalchemy.orm import sessionmaker

Session = sessionmaker(query_cls=SoftDeleteQuery) session = Session()

event.listen() 拦截 delete/update,避免手写 update(... set deleted_at=...)

业务代码不该暴露 deleted_at 赋值细节。监听 before_flush 事件,把 session.delete(obj) 转成更新操作,同时保持外键约束、级联行为可控。

  • 监听 before_flush,遍历 session.deleted,对每个对象设置 deleted_at = datetime.utcnow(),再从 deleted 中移除
  • 必须检查对象是否真有 deleted_at 属性,避免对无逻辑删除字段的模型报错
  • 如果需要级联软删(如删 user 同时软删其 posts),得额外处理 session.newsession.dirty 中关联对象,不能只靠数据库 ON DELETE CASCADE
  • 硬删除(绕过逻辑删除)可用特殊标记,例如给对象加临时属性 __hard_delete__ = True,在事件中跳过
from sqlalchemy import event
from datetime import datetime

@event.listens_for(Session, 'before_flush') def before_flush(session, flush_context, instances): for obj in list(session.deleted): if hasattr(obj, 'deleted_at'): obj.deleted_at = datetime.utcnow() session.deleted.discard(obj) # 移出 deleted 集合,防止真删

逻辑删除真正的复杂点不在“怎么加条件”,而在于关联查询时的语义一致性:比如 User.posts 关系默认应只返回未删除的 Post,但 SQLAlchemy 的 relationship() 不会自动继承主模型的软删规则。这需要在 relationship() 中显式用 primaryjoin 补上 and_(Post.user_id == User.id, Post.deleted_at.is_(None)),否则一查就漏数据。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

706

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

327

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

348

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1201

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

360

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

778

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

580

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

421

2024.04.29

拼多多赚钱的5种方法 拼多多赚钱的5种方法
拼多多赚钱的5种方法 拼多多赚钱的5种方法

在拼多多上赚钱主要可以通过无货源模式一件代发、精细化运营特色店铺、参与官方高流量活动、利用拼团机制社交裂变,以及成为多多进宝推广员这5种方法实现。核心策略在于通过低成本、高效率的供应链管理与营销,利用平台社交电商红利实现盈利。

31

2026.01.26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java 教程
Java 教程

共578课时 | 51.6万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.0万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号