事件触发器

触发器会在指定的ddl事件发生时自动执行函数。目前事件触发器仅在PG兼容模式下可用。

语法格式

• 创建事件触发器。

  CREATE EVENT TRIGGER name
      ON event
      [ WHEN filter_variable IN (filter_value [, ... ]) [ AND ... ] ]
      EXECUTE PROCEDURE function_name()
  

• 修改事件触发器。

  ALTER EVENT TRIGGER name DISABLE
  ALTER EVENT TRIGGER name ENABLE [ REPLICA | ALWAYS ]
  ALTER EVENT TRIGGER name OWNER TO { new_owner | CURRENT_USER | SESSION_USER }
  ALTER EVENT TRIGGER name RENAME TO new_name
  

• 删除事件触发器。

  DROP EVENT TRIGGER [ IF EXISTS ] name [ CASCADE | RESTRICT ];
  

参数说明

• name

  事件触发器名称。

• filter_variable

  事件触发器用来做过滤的变量（目前仅支持TAG）。

• event

  事件触发器支持的事件，目前支持ddl_command_start、ddl_command_end、sql_drop、table_rewrite。

• function_name

  用户定义的函数，必须声明为不带参数并返回类型为event_trigger，在事件触发器触发时执行。

• new_name

  修改后的新事件触发器名称。

• disable

  禁用该事件触发器。

• ENABLE [ REPLICA | ALWAYS ]

  该事件触发器在session_replication_role为REPLICA\任何取值时可用。

示例

--创建测试数据库
openGauss=# create database test_event_trigger dbcompatibility='PG';
openGauss=# \c test_event_trigger
--创建事件触发器函数(用于ddl_command_start、ddl_command_end事件)
test_event_trigger=# create function test_event_trigger() returns event_trigger as $$
BEGIN
    RAISE NOTICE 'test_event_trigger: % %', tg_event, tg_tag;
END
$$ language plpgsql;

--创建事件触发器函数(用于sql_drop事件)
test_event_trigger=# CREATE OR REPLACE FUNCTION drop_sql_command()
RETURNS event_trigger AS $$
BEGIN
RAISE NOTICE '% - sql_drop', tg_tag;
END;
$$ LANGUAGE plpgsql;

--创建事件触发器函数(用于table_rewrite事件)
test_event_trigger=# CREATE OR REPLACE FUNCTION test_evtrig_no_rewrite() RETURNS event_trigger
LANGUAGE plpgsql AS $$
BEGIN
  RAISE EXCEPTION 'rewrites not allowed';
END;
$$;

--创建事件类型为ddl_command_start的事件触发器
test_event_trigger=# create event trigger regress_event_trigger on ddl_command_start
   execute procedure test_event_trigger();

--创建事件类型为ddl_command_end的事件触发器
test_event_trigger=# create event trigger regress_event_trigger_end on ddl_command_end
   execute procedure test_event_trigger();

--创建事件类型为sql_drop的事件触发器
test_event_trigger=# CREATE EVENT TRIGGER sql_drop_command ON sql_drop
    EXECUTE PROCEDURE drop_sql_command();

--创建事件类型为table_rewrite的事件触发器
test_event_trigger=# create event trigger no_rewrite_allowed on table_rewrite
  when tag in ('alter table') execute procedure test_evtrig_no_rewrite();

--执行ddl语句查看事件触发器效果(触发ddl_command_start与ddl_command_end)
test_event_trigger=# create table event_trigger_table (a int);

--执行alter table语句查看事件触发器效果(触发ddl_command_start与table_rewrite,ddl_command_end由于禁止rewrite报错不触发)
test_event_trigger=# alter table event_trigger_table alter column a type numeric;

--执行drop语句查看事件触发器效果(触发ddl_command_start、sql_drop与ddl_command_end)
test_event_trigger=# drop table event_trigger_table;

--修改事件触发器
test_event_trigger=# create role regress_evt_user WITH ENCRYPTED PASSWORD 'EvtUser123';
test_event_trigger=# ALTER EVENT TRIGGER regress_event_trigger RENAME TO regress_event_trigger_start;
--应该失败，事件触发器的owner只能为超级用户
test_event_trigger=# ALTER EVENT TRIGGER regress_event_trigger_start owner to regress_evt_user;
test_event_trigger=# ALTER EVENT TRIGGER regress_event_trigger_start disable;
test_event_trigger=# ALTER EVENT TRIGGER regress_event_trigger_start enable always;

--删除事件触发器
test_event_trigger=# DROP EVENT TRIGGER regress_event_trigger_start;
test_event_trigger=# DROP EVENT TRIGGER regress_event_trigger_end;
test_event_trigger=# DROP EVENT TRIGGER sql_drop_command;
test_event_trigger=# DROP EVENT TRIGGER no_rewrite_allowed;