postgres_lsp 安全规则实战:banDropTrigger 全面解析与配置指南

原创2026-09-17 16:22:541,888 阅读
文章标签:开发工具数据库CLI

postgres_lsp 安全规则实战:banDropTrigger 全面解析与配置指南

本指南以 postgres_lsp 仓库中 lint/safety/banDropTrigger 规则文档为核心,深入剖析该规则的设计动机、检测原理、报错形态与配置方法,并结合仓库源码与测试用例,帮助你理解为何 DROP TRIGGER 是高危操作、如何在自己的项目中启用并验证该规则。读完本文,你将掌握在 postgres_lsp(Postgres Language Server)中配置、运行与调试 banDropTrigger 规则的完整方法。

规则概览

banDropTrigger 是 postgres_lsp 的 safety(安全)lint 组下的一条规则,用于禁止直接执行 DROP TRIGGER 语句。

属性 值
诊断类别 lint/safety/banDropTrigger
引入版本 vnext
默认严重级别 Warning(警告)
默认推荐启用 否(recommended: false)
灵感来源 pgfence/drop-trigger(仓库中记录为 RuleSource::Pgfence("drop-trigger"))
是否支持配置选项 否(type Options = ())

从源码结构看,该规则属于 pgls_analyser crate 的 safety 模块,与 avoidCreateTrigger、avoidEnableDisableTrigger、banDropTable、banDropColumn 等规则共同构成针对破坏性 DDL 语句的安全防护体系。

为什么 DROP TRIGGER 是危险的

规则的文档描述(与源码注释一致)给出了两点核心原因:

  1. 锁冲突风险:DROP TRIGGER 会在目标表上获取 ACCESS EXCLUSIVE 锁。这是 PostgreSQL 中最强的表级锁,与所有其他锁模式互斥,因此在锁持有的整个窗口内,对该表的所有读写操作都会被阻塞。
  2. 破坏应用逻辑:触发器往往承载着关键的业务行为(审计、数据校验、级联更新、软删除等)。直接删除触发器可能破坏依赖其行为的应用逻辑,且这种破坏通常是静默的——数据库不会报错,但业务行为悄然改变,排查成本极高。

源码在 ban_drop_trigger.rs 中的规则声明里,将这两点原因原样固化为了规则的对外文档与诊断文案。

检测原理:从源码看实现

该规则的实现位于 crates/pgls_analyser/src/lint/safety/ban_drop_trigger.rs。核心逻辑非常精简:

impl LinterRule for BanDropTrigger {
    type Options = ();

    fn run(ctx: &LinterRuleContext<Self>) -> Vec<LinterDiagnostic> {
        let mut diagnostics = vec![];

        if let pgls_query::NodeEnum::DropStmt(stmt) = &ctx.stmt()
            && stmt.remove_type() == pgls_query::protobuf::ObjectType::ObjectTrigger
        {
            diagnostics.push(
                LinterDiagnostic::new(
                    rule_category!(),
                    None,
                    markup! {
                        "Dropping a trigger acquires an "<Emphasis>"ACCESS EXCLUSIVE"</Emphasis>" lock on the table."
                    },
                )
                .detail(
                    None,
                    "This blocks all reads and writes. Ensure no application logic depends on the trigger before dropping it.",
                ),
            );
        }

        diagnostics
    }
}

其检测流程可以概括为三步:

  1. 解析语句:利用 pgls_query 将 SQL 文本解析为语法树,并匹配 DropStmt(DROP 语句)节点;
  2. 判断对象类型:检查该 DROP 语句的 remove_type 是否为 ObjectType::ObjectTrigger,即确认被删除的对象是触发器而非表、索引、视图等其他对象;
  3. 产出诊断:命中后生成一条 LinterDiagnostic 诊断,主消息强调 ACCESS EXCLUSIVE 锁,附加详情(detail)提示会阻塞读写并提醒先确认应用逻辑依赖。

值得注意的是:由于匹配的是 DropStmt 节点并校验 remove_type,规则的检测范围覆盖 DROP TRIGGER 的各种写法(如带 IF EXISTS、限定 schema 名等),只要最终对象类型解析为触发器即会命中。

触发示例与报错形态

触发场景(Invalid)

以下语句会被 banDropTrigger 标记为违规:

drop trigger my_trigger on my_table;

对应的终端诊断输出如下:

code-block.sql:1:1 lint/safety/banDropTrigger ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ! Dropping a trigger acquires an ACCESS EXCLUSIVE lock on the table.

  > 1 │ drop trigger my_trigger on my_table;
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │

  i This blocks all reads and writes. Ensure no application logic depends on the trigger before dropping it.

诊断的定位(1:1)指向 DROP 关键字起始位置,整个语句被波浪线标记;主消息与详情分别对应源码中的 markup! 主文案与 .detail(...) 详情文案。

通过场景(Valid)

不涉及 DROP TRIGGER 的普通语句不会被该规则干预,例如:

select 1;

测试用例佐证

仓库为该规则提供了端到端的快照测试,位于 crates/pgls_analyser/tests/specs/safety/banDropTrigger/。其中 basic.sql 内容为:

-- expect_lint/safety/banDropTrigger
drop trigger my_trigger on my_table;

-- expect_lint/safety/banDropTrigger 注释声明了期望触发的诊断类别;配套的 basic.sql.snap 快照则记录了实际输出:

# Diagnostics
lint/safety/banDropTrigger ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  × Dropping a trigger acquires an ACCESS EXCLUSIVE lock on the table.

  i This blocks all reads and writes. Ensure no application logic depends on the trigger before dropping it.

这套用例由 rules_tests.rs 驱动,验证了解析、匹配与诊断产出的完整链路,是理解规则行为最直观的参考。

如何配置

配置文件方式

在项目根目录的 postgres-language-server.jsonc(即 postgres-language-server.jsonc)中加入如下配置即可启用该规则:

{
  "linter": {
    "rules": {
      "safety": {
        "banDropTrigger": "error"
      }
    }
  }
}

关于配置值,需要说明以下几点:

  • 级别取值:规则值可以是 "error"、"warning"、"off" 等。文档示例使用 "error",但该规则源码声明的默认严重级别为 Warning;若不显式配置而通过 "recommended": true 之类的方式间接启用,则以源码默认级别为准。仓库根目录示例配置 postgres-language-server.jsonc 使用 "linter": { "enabled": true, "rules": { "recommended": true } } 的形态,由于 banDropTrigger 的 recommended 为 false,它不会被 recommended 集合自动加载,需要显式点名配置才会生效。
  • 配置结构:规则按 linter.rules.<group>.<ruleName> 三层结构组织,本规则的组名为 safety,规则名为 banDropTrigger。
  • 无需额外选项:规则实现中 type Options = (),说明它不接受任何额外选项参数,配置级别即可。

与其他触发器规则的协同

safety 组还包含一系列与触发器生命周期相关的规则,可组合使用形成完整的触发器治理策略:

  • avoidCreateTrigger:禁止 CREATE TRIGGER,因其会获取 SHARE ROW EXCLUSIVE 锁并隐藏写路径复杂度(详见 avoid-create-trigger.md);
  • avoidEnableDisableTrigger:禁止启用/禁用触发器。

三者分别约束触发器的创建、启停与删除,配合 banDropTable、banDropColumn 等 DDL 禁令,可在团队内落地"触发器变更必须走审批/迁移流程"的工程规范。

规则注册与命名

该规则通过宏 declare_lint_rule! 声明,并注册进全局 lint 规则注册表 registry.rs 中(按规则名 banDropTrigger 映射到具体的规则实现)。这意味着它可以通过 CLI、LSP、CI 等 postgres_lsp 的所有入口统一生效,无需为不同场景单独配置。

在 CI 与编辑器中使用

  • 编辑器 / IDE:配置好 postgres-language-server.jsonc 后,Postgres Language Server 会在编辑 SQL 文件时实时给出诊断;将级别设为 "error" 时,违规的 DROP TRIGGER 会以错误形式高亮。
  • CI 流水线:可使用 pgls_cli 的 check 命令对 SQL 文件或目录进行静态检查,违规语句将按配置级别进入检查结果,从而在合并前拦截危险的 DROP TRIGGER。

小结

banDropTrigger 是 postgres_lsp 安全 lint 体系中针对触发器删除操作的一把"保险锁":它基于语法树精确识别 DROP TRIGGER 语句,以 ACCESS EXCLUSIVE 锁阻塞和潜在的应用逻辑破坏为由发出警告,并支持通过 linter.rules.safety.banDropTrigger 灵活配置级别。结合仓库中的源码实现(ban_drop_trigger.rs)与快照测试(basic.sql),开发者可以准确预判其行为,并将其纳入团队数据库变更安全规范。

登录后查看全文
postgres_lsp