【PostgreSQL内核】Trigger的一生

Question

如题所述

Answer 1

本文简要介绍 PostgreSQL 数据库的 Trigger 从创建、存储、触发、执行、修改到删除的过程，贯穿 Trigger 的一生。

文中引用的函数、结构体来源于 PG 14 源码，分支为 REL_14_STABLE，对应的 commit id 如下。此外还引用了 PG 14 官方文档。

触发器简介

Trigger 即触发器，它可以在特定事件发生时，对数据库中的对象执行特定操作：

根据触发事件的不同，PG 的触发器分为两类：

不同数据库中触发器的分类有所不同，比如 Oracle 分为 DML Trigger 和 System Trigger，SQL Server 分为 DML Trigger、DDL Trigger 和 Login Trigger，不论其如何划分，多数都可以与 PG 的触发器对应上。

创建触发器语法

首先介绍创建触发器的 SQL 和 PLpgSQL 语法。

Trigger

根据 PG 官方文档，创建 Trigger 的语法如下：

下面以表 t1、t2 为例创建一个简单的触发器示例。表的定义如下：

触发器定义如下，是表 t1 上的行级触发器，对 t1 进行 INSERT 之后会触发，并执行 insert_into_t2 函数，将插入到 t1 的数据也插入到 t2。

insert_into_t2 函数定义如下，其中引用了上下文信息 NEW，表示插入到 t1 的数据，并将其插入到 t2。

Event Trigger

创建 Event Trigger 的语法如下，相比 Trigger 的语法要简单很多

以下是 PG 官方文档中的一个简单示例，该 Event Trigger 可以在任何 DDL 语句执行之前触发，并抛出异常，禁止执行任何 DDL 语句。

创建流程

简单介绍创建触发器时 PG 内核中的函数调用流程。

Trigger

CREATE TRIGGER 命令都属于 DDL 语句，所以会进入 DDL 的处理流程，关键的调用路径为： ProcessUtilitySlow-->CreateTrigger-->CreateTriggerFiringOn，CreateTriggerFiringOn 函数代码超过 1000 行，因此只介绍其中的关键步骤：

Event Trigger

CREATE EVENT TRIGGER 的关键调用路径为： standard_ProcessUtility-->CreateEventTrigger，该函数流程相对简单很多：

触发器的存储

用户创建的触发器必须持久化到数据库中，具体的存储位置是触发器相关的系统表中。

Trigger

Trigger 存储在 pg_trigger 系统表中，表中的关键字段如下，包含触发器所在的表、触发器名、触发器调用的函数、是否可推迟等属性。总之，通过 CREATE TRIGGER 创建触发器时指定的任何信息都会存储到系统表中。

pg_trigger 系统表的各个字段在内存中用Trigger 结构体表示，定义如下，可见其成员变量与 pg_trigger 的属性是一一对应的。

在内存中的 relcache（表缓存）中也同样保存有 Trigger 的信息：

Event Trigger

Event Trigger 存储在 pg_event_trigger 系统表中，关键字段如下，包含触发器名、调用的函数等信息。与 Trigger 不同的是，这里并不包含触发器所在的表，因为 Event Trigger 不属于任何一个表。

触发过程

触发器会在特定事件场景下被触发，它识别这些事件的方式也很简单，就是在对应事件的代码处调用触发器函数。

Trigger

对于普通的触发器，触发时机是 INSERT、UPDATE、DELETE 等操作之前或者之后，所以在 PG 的执行器阶段触发，多数在 ProcessQuery-->ExecutorRun-->ExecModifyTable 函数中

我们将执行触发操作的函数称为“触发器的执行函数”，各类触发器的执行函数命名格式比较统一，在此列举几种：

以ExecBRInsertTriggers 为例说明触发过程：

Event Trigger

事件触发器支持的事件仅有 ddl_command_start、ddl_command_end、table_rewrite 和 sql_drop 这四类，分别对应四个执行函数，其触发时机说明如下：

以 EventTriggerDDLCommandStart 为例说明触发过程：

调用功能函数

用户在创建触发器的 EXECUTE { FUNCTION | PROCEDURE } function_name 语句中指定了该触发器要执行的功能函数。在触发器被触发后，会执行该函数。

Trigger

在执行器阶段触发时，ResultRelInfo 结构体中存有表上的各项信息，其中就包括表上的触发器、函数等，所以直接从中就可以拿到触发器信息。关键结构体为 ResultRelInfo、TriggerDesc、Trigger，其嵌套关系如下：

将ResultRelInfo 中获取的 Trigger 结构体的全部内容都填充到 TriggerData 结构体，ExecCallTriggerFunc 函数再从 TriggerData 中获取函数 oid，并执行该函数。

TriggerData 结构体定义如下，其中除了 Trigger 以外还保存了各种执行上下文信息，heap 表信息等，与函数的执行有关。

TriggerData 最终会保存到PLpgSQL_execstate 中，这是 PLpgSQL 执行过程中的一个重要结构体：

触发器的功能函数执行的方法与普通的 PLpgSQL 函数、存储过程执行方法是类似的，关键调用路径是： ExecCallTriggerFunc-->plpgsql_call_handler-->plpgsql_exec_trigger-->exec_toplevel_block-->exec_stmt_block-->…………

Event Trigger

对于事件触发器，在触发阶段的EventTriggerCommonSetup 函数中，通过 EventCacheLookup 从缓存中查找触发器功能函数，然后在 EventTriggerInvoke 中根据触发器函数的 oid 进行调用。

EventTriggerCommonSetup 中还会填充 EventTriggerData 结构体，其中保存了调用过程中的一些关键信息：

与普通触发器的 TriggerData 结构一样，EventTriggerData 结构体也会保存到PLpgSQL_execstate 中，在 PLpgSQL 执行过程中使用：

事件触发器的功能函数实际执行步骤与普通触发器也基本相同，关键调用路径为： ExecCallTriggerFunc-->plpgsql_call_handler-->plpgsql_exec_event_trigger-->exec_toplevel_block-->exec_stmt_block-->…………

修改触发器

使用 ALTER 语句修改触发器的定义

Trigger

根据 PG 14 官方文档，ALTER TRIGGER 的语法如下：

仅支持重命名和修改依赖的插件。

重命名触发器的关键调用流程为：standard_ProcessUtility-->ExecRenameStmt-->renametrig，基本原理也是读取 pg_trigger 系统表的信息，修改以后写回系统表。

修改触发器依赖插件的关键调用流程为：standard_ProcessUtility-->ExecAlterObjectDependsStmt，会修改 pg_depend 系统表。

Event Trigger

根据 PG 14 官方文档，ALTER EVENT TRIGGER 语法为：

支持对事件触发器进行重命名、禁用、启用、修改 owner 的操作。

ALTER TRIGGER 的关键函数是AlterEventTrigger，其内容较为简单：

删除触发器

使用 DROP 语句删除触发器

Trigger

PG 14 文档中 DROP TRIGGER 语法如下：

删除触发器的关键函数是RemoveTriggerById，调用流程如下： ProcessUtilitySlow-->ExecDropStmt-->RemoveObjects-->performMultipleDeletions-->deleteObjectsInList-->deleteOneObject-->doDeletion-->RemoveTriggerById

RemoveTriggerById 函数流程：

Event Trigger

PG 14 文档中 DROP EVENT TRIGGER 语法如下：

删除事件触发器的关键函数是DropObjectById，这是一个公用的函数，可以删除多种类型的对象。

调用流程如下： ProcessUtilitySlow-->ExecDropStmt-->RemoveObjects-->performMultipleDeletions-->deleteObjectsInList-->deleteOneObject-->doDeletion-->DropObjectById