PostgreSQL中事件触发器Event Trigger

在PostgreSQL中，事件触发器（Event Trigger）是一种特殊的触发器类型，它允许你在特定的数据库系统事件发生时执行特定的操作。与普通的触发器不同，事件触发器并不与特定的表或视图相关联，而是与数据库级别的全局事件相关联。

参考官方文档如下

https://www.postgresql.org/docs/16/functions-event-triggers.html

事件触发器的特点

1. 全局作用：事件触发器作用于整个数据库实例，而不是单个表或视图。
2. 系统事件：它们响应的是数据库系统级的事件，如DDL（数据定义语言）命令的执行、配置参数的更改、日志文件的切换等。
3. 灵活性：可以定义复杂的响应逻辑，通过PL/pgSQL、PL/Tcl、PL/Perl等过程语言来实现。

事件触发器的使用场景

• 审计和日志记录：记录所有DDL操作的日志，以便进行审计或回滚。
• 安全策略实施：防止未经授权的DDL更改，或确保在更改前满足某些条件。
• 自动化任务：在数据库达到特定条件时自动执行维护任务，如清理日志、备份等。

事件触发器的创建

创建事件触发器需要两个步骤：

1. 定义触发器函数：这个函数将包含事件发生时需要执行的逻辑。
2. 创建事件触发器：将这个触发器函数与一个或多个特定的事件关联起来。

示例：记录DDL操作

1. 定义触发器函数：

CREATE TABLE ddl_log(command_text varchar(64), user_name varchar(32), command_time datetime);

CREATE  FUNCTION log_ddl_commands()
        RETURNS event_trigger LANGUAGE plpgsql AS $$
DECLARE
    obj record;
BEGIN
    -- Capturing Changes at Command End 
    FOR obj IN SELECT * FROM pg_event_trigger_ddl_commands ()
    LOOP
        INSERT INTO ddl_log (command_text,user_name,command_time,obj_name,obj_id)
        values(tg_tag,current_user,now(),obj.schema_name,obj.object_identity);
    END LOOP;
END
$$;

在这个例子中，我们创建了一个名为log_ddl_commands的函数，它会在DDL命令执行时插入一条记录到ddl_log表中。这个表需要事先创建，并包含相应的列来存储命令文本、用户名和命令执行时间。

Capturing Changes at Command End

• pg_event_trigger_ddl_commands returns a list of DDL commands executed by each user action, when invoked in a function attached to a ddl_command_end event trigger. If called in any other context, an error is raised.
• pg_event_trigger_ddl_commands returns one row for each base command executed; some commands that are a single SQL sentence may return more than one row. This function returns the following columns:
  

2. 创建事件触发器：

CREATE EVENT TRIGGER ddl_audit_trigger ON ddl_command_end EXECUTE FUNCTION log_ddl_commands();

在这个例子中，我们创建了一个名为ddl_audit_trigger的事件触发器，它会在任何CREATE TABLE、ALTER TABLE命令执行结束时调用log_ddl_commands函数。

-- 创建一个表，测试事件触发器是否正确执行
superdb=#  create table t_event_trigger(id int);
CREATE TABLE
-- 查询DDL变更日志记录
superdb=# select * from  ddl_log;
 command_text | user_name |        command_time        | obj_name |         obj_id
--------------+-----------+----------------------------+----------+------------------------
 CREATE TABLE | super     | 2024-12-13 19:55:33.232567 | public   | public.t_event_trigger
(1 rows)
-- 给表增加字段，并查询DDL变更日志记录
superdb=# alter table t_event_trigger add column infoname varchar(32);
ALTER TABLE
superdb=# select * from ddl_log;
 command_text | user_name |        command_time        | obj_name |         obj_id
--------------+-----------+----------------------------+----------+------------------------
 CREATE TABLE | super     | 2024-12-13 19:55:33.232567 | public   | public.t_event_trigger
 ALTER TABLE  | super     | 2024-12-13 19:57:45.244284 | public   | public.t_event_trigger
(3 rows)
-- 可以观察导，事件触发器是否正确执行，DDL变更日志已经成功插入导ddl_log

Processing Objects Dropped by a DDL Command

• pg_event_trigger_dropped_objects returns a list of all objects dropped by the command in whose sql_drop event it is called. If called in any other context, an error is raised. This function returns the following columns:
  

-- 创建函数用于记录DDL删除事件日志
CREATE FUNCTION log_ddl_commands_for_drops()
        RETURNS event_trigger LANGUAGE plpgsql AS $$
DECLARE
    obj record;
BEGIN
    FOR obj IN SELECT * FROM pg_event_trigger_dropped_objects()
    LOOP
        INSERT INTO ddl_log (command_text,user_name,command_time,obj_name,obj_id)
        values(tg_tag,current_user,now(),obj.schema_name,obj.object_identity);
    END LOOP;
END;
$$;
-- 创建事件触发器
CREATE EVENT TRIGGER ddl_audit_trigger_for_drops ON sql_drop EXECUTE FUNCTION log_ddl_commands_for_drops();
   
-- 删除表,测试事件触发器是否正确执行
superdb=# drop table t_event_trigger;
DROP TABLE

superdb=# select * from  ddl_log;
  command_text   | user_name |        command_time        | obj_name |               obj_id
-----------------+-----------+----------------------------+----------+-------------------------------------
 CREATE TABLE    | super     | 2024-12-13 19:55:33.232567 | public   | public.t_event_trigger
 ALTER TABLE     | super     | 2024-12-13 19:57:45.244284 | public   | public.t_event_trigger
 CREATE FUNCTION | super     | 2024-12-13 20:11:23.028464 | public   | public.log_ddl_commands_for_drops()
 DROP TABLE      | super     | 2024-12-13 20:12:33.692562 | public   | public.t_event_trigger
 DROP TABLE      | super     | 2024-12-13 20:12:33.692562 | public   | public.t_event_trigger
 DROP TABLE      | super     | 2024-12-13 20:12:33.692562 | public   | public.t_event_trigger[]
(7 rows)

事件触发器的限制

• 事件触发器不能回滚它们所执行的操作，如果触发器函数中的操作失败，它不会阻止已经发生的DDL命令。
• 由于事件触发器作用于整个数据库实例，因此它们可能会对性能产生影响，特别是在处理大量并发DDL操作时。

总结

事件触发器是PostgreSQL中强大的工具，允许数据库管理员在数据库级别实施全局策略和执行自动化任务。通过合理使用事件触发器，可以有效地提高数据库的安全性、可维护性和可操作性。