38.3. 用 C 编写触发器函数

本节描述了触发功能的接口的底层细节。仅在用 C 编写触发器函数时才需要此信息。如果您使用高级语言，则将为您处理这些详细信息。在大多数情况下，您应该在使用 C 编写触发器之前考虑使用一种过程语言。每种过程语言的文档都说明了如何用该语言编写触发器。

触发功能必须使用“版本 1”功能 Management 器界面。

触发器 Management 器调用函数时，不会传递任何常规参数，而是会传递指向TriggerData结构的“上下文”指针。 C 函数可以通过执行宏来检查是否从触发器 Management 器中调用了它们：

CALLED_AS_TRIGGER(fcinfo)

扩展为：

((fcinfo)->context != NULL && IsA((fcinfo)->context, TriggerData))

如果返回 true，则可以安全地将fcinfo->context转换为TriggerData *并使用指向TriggerData的结构。该函数必须不得更改TriggerData结构或其指向的任何数据。

struct TriggerData在commands/trigger.h中定义：

typedef struct TriggerData
{
    NodeTag          type;
    TriggerEvent     tg_event;
    Relation         tg_relation;
    HeapTuple        tg_trigtuple;
    HeapTuple        tg_newtuple;
    Trigger         *tg_trigger;
    Buffer           tg_trigtuplebuf;
    Buffer           tg_newtuplebuf;
    Tuplestorestate *tg_oldtable;
    Tuplestorestate *tg_newtable;
} TriggerData;

成员定义如下：

type
- 一律T_TriggerData。
tg_event
- 描述为其调用函数的事件。您可以使用以下宏检查tg_event：
TRIGGER_FIRED_BEFORE(tg_event)
- 如果触发器在操作之前触发，则返回 true。
- TRIGGER_FIRED_AFTER(tg_event)
  - 如果触发器在操作后触发，则返回 true。
- TRIGGER_FIRED_INSTEAD(tg_event)
  - 如果触发触发器而不是操作，则返回 true。
- TRIGGER_FIRED_FOR_ROW(tg_event)
  - 如果针对行级事件触发了触发器，则返回 true。
- TRIGGER_FIRED_FOR_STATEMENT(tg_event)
  - 如果为语句级事件触发了触发器，则返回 true。
- TRIGGER_FIRED_BY_INSERT(tg_event)
  - 如果触发器是由INSERT命令触发的，则返回 true。
- TRIGGER_FIRED_BY_UPDATE(tg_event)
  - 如果触发器是由UPDATE命令触发的，则返回 true。
- TRIGGER_FIRED_BY_DELETE(tg_event)
  - 如果触发器是由DELETE命令触发的，则返回 true。
- TRIGGER_FIRED_BY_TRUNCATE(tg_event)
  - 如果触发器是由TRUNCATE命令触发的，则返回 true。
tg_relation
- 指向描述触发器触发关系的结构的指针。有关此结构的详细信息，请参见utils/rel.h。最有趣的是tg_relation->rd_att(关系 Tuples 的 Descriptors)和tg_relation->rd_rel->relname(关系名称；类型不是char*而是NameData；如果需要名称的副本，请使用SPI_getrelname(tg_relation)获得char*)。
tg_trigtuple
- 指向为其触发触发器的行的指针。这是要插入，更新或删除的行。如果为INSERT或DELETE触发了此触发器，那么如果您不想将行替换为其他行(对于INSERT)或跳过该操作，则应从该函数返回该值。对于外部表上的触发器，此处的系统列的值未指定。
tg_newtuple
- 如果为UPDATE触发了触发器，则指向该行的新版本的指针，如果是INSERT或DELETE则触发了NULL的指针。如果事件是UPDATE并且您不想用另一行替换此行或跳过该操作，则必须从函数返回该行。对于外部表上的触发器，此处的系统列的值未指定。
tg_trigger
- 指向utils/reltrigger.h中定义的Trigger类型的结构的指针：

typedef struct Trigger
{
    Oid         tgoid;
    char       *tgname;
    Oid         tgfoid;
    int16       tgtype;
    char        tgenabled;
    bool        tgisinternal;
    Oid         tgconstrrelid;
    Oid         tgconstrindid;
    Oid         tgconstraint;
    bool        tgdeferrable;
    bool        tginitdeferred;
    int16       tgnargs;
    int16       tgnattr;
    int16      *tgattr;
    char      **tgargs;
    char       *tgqual;
    char       *tgoldtable;
    char       *tgnewtable;
} Trigger;

其中tgname是触发器的名称，tgnargs是tgargs中参数的数量，而tgargs是指向CREATE TRIGGER语句中指定的参数的指针的数组。其他成员仅供内部使用。

tg_trigtuplebuf
- 包含tg_trigtuple或InvalidBuffer的缓冲区(如果没有这样的 Tuples 或未将其存储在磁盘缓冲区中)。
tg_newtuplebuf
- 包含tg_newtuple或InvalidBuffer的缓冲区(如果没有这样的 Tuples 或未将其存储在磁盘缓冲区中)。
tg_oldtable
- 指向类型Tuplestorestate的结构的指针，该结构以tg_relation指定的格式包含零个或多个行，如果没有OLD TABLE转换关系，则为NULL指针。
tg_newtable
- 指向类型Tuplestorestate的结构的指针，该结构以tg_relation指定的格式包含零个或多个行，如果没有NEW TABLE转换关系，则为NULL指针。

要允许通过 SPI 发出的查询引用过渡表，请参见SPI_register_trigger_data。

触发器函数必须返回HeapTuple指针或NULL指针(不是 SQL 空值，即，不设置* isNull * true)。如果您不想修改正在操作的行，请小心地根据需要返回tg_trigtuple或tg_newtuple。

Docs

Docs4dev

Title here

38.3. 用 C 编写触发器函数