PostgreSQL Source Code  git master
pg_trigger.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pg_trigger.h
4  * definition of the "trigger" system catalog (pg_trigger)
5  *
6  *
7  * Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/catalog/pg_trigger.h
11  *
12  * NOTES
13  * The Catalog.pm module reads this file and derives schema
14  * information.
15  *
16  *-------------------------------------------------------------------------
17  */
18 #ifndef PG_TRIGGER_H
19 #define PG_TRIGGER_H
20 
21 #include "catalog/genbki.h"
22 #include "catalog/pg_trigger_d.h"
23 
24 /* ----------------
25  * pg_trigger definition. cpp turns this into
26  * typedef struct FormData_pg_trigger
27  *
28  * Note: when tgconstraint is nonzero, tgconstrrelid, tgconstrindid,
29  * tgdeferrable, and tginitdeferred are largely redundant with the referenced
30  * pg_constraint entry. However, it is possible for a non-deferrable trigger
31  * to be associated with a deferrable constraint.
32  * ----------------
33  */
34 CATALOG(pg_trigger,2620,TriggerRelationId)
35 {
36  Oid tgrelid; /* relation trigger is attached to */
37  NameData tgname; /* trigger's name */
38  Oid tgfoid; /* OID of function to be called */
39  int16 tgtype; /* BEFORE/AFTER/INSTEAD, UPDATE/DELETE/INSERT,
40  * ROW/STATEMENT; see below */
41  char tgenabled; /* trigger's firing configuration WRT
42  * session_replication_role */
43  bool tgisinternal; /* trigger is system-generated */
44  Oid tgconstrrelid; /* constraint's FROM table, if any */
45  Oid tgconstrindid; /* constraint's supporting index, if any */
46  Oid tgconstraint; /* associated pg_constraint entry, if any */
47  bool tgdeferrable; /* constraint trigger is deferrable */
48  bool tginitdeferred; /* constraint trigger is deferred initially */
49  int16 tgnargs; /* # of extra arguments in tgargs */
50 
51  /*
52  * Variable-length fields start here, but we allow direct access to
53  * tgattr. Note: tgattr and tgargs must not be null.
54  */
55  int2vector tgattr; /* column numbers, if trigger is on columns */
56 
57 #ifdef CATALOG_VARLEN
58  bytea tgargs BKI_FORCE_NOT_NULL; /* first\000second\000tgnargs\000 */
59  pg_node_tree tgqual; /* WHEN expression, or NULL if none */
60  NameData tgoldtable; /* old transition table, or NULL if none */
61  NameData tgnewtable; /* new transition table, or NULL if none */
62 #endif
64 
65 /* ----------------
66  * Form_pg_trigger corresponds to a pointer to a tuple with
67  * the format of pg_trigger relation.
68  * ----------------
69  */
71 
72 #ifdef EXPOSE_TO_CLIENT_CODE
73 
74 /* Bits within tgtype */
75 #define TRIGGER_TYPE_ROW (1 << 0)
76 #define TRIGGER_TYPE_BEFORE (1 << 1)
77 #define TRIGGER_TYPE_INSERT (1 << 2)
78 #define TRIGGER_TYPE_DELETE (1 << 3)
79 #define TRIGGER_TYPE_UPDATE (1 << 4)
80 #define TRIGGER_TYPE_TRUNCATE (1 << 5)
81 #define TRIGGER_TYPE_INSTEAD (1 << 6)
82 
83 #define TRIGGER_TYPE_LEVEL_MASK (TRIGGER_TYPE_ROW)
84 #define TRIGGER_TYPE_STATEMENT 0
85 
86 /* Note bits within TRIGGER_TYPE_TIMING_MASK aren't adjacent */
87 #define TRIGGER_TYPE_TIMING_MASK \
88  (TRIGGER_TYPE_BEFORE | TRIGGER_TYPE_INSTEAD)
89 #define TRIGGER_TYPE_AFTER 0
90 
91 #define TRIGGER_TYPE_EVENT_MASK \
92  (TRIGGER_TYPE_INSERT | TRIGGER_TYPE_DELETE | TRIGGER_TYPE_UPDATE | TRIGGER_TYPE_TRUNCATE)
93 
94 /* Macros for manipulating tgtype */
95 #define TRIGGER_CLEAR_TYPE(type) ((type) = 0)
96 
97 #define TRIGGER_SETT_ROW(type) ((type) |= TRIGGER_TYPE_ROW)
98 #define TRIGGER_SETT_STATEMENT(type) ((type) |= TRIGGER_TYPE_STATEMENT)
99 #define TRIGGER_SETT_BEFORE(type) ((type) |= TRIGGER_TYPE_BEFORE)
100 #define TRIGGER_SETT_AFTER(type) ((type) |= TRIGGER_TYPE_AFTER)
101 #define TRIGGER_SETT_INSTEAD(type) ((type) |= TRIGGER_TYPE_INSTEAD)
102 #define TRIGGER_SETT_INSERT(type) ((type) |= TRIGGER_TYPE_INSERT)
103 #define TRIGGER_SETT_DELETE(type) ((type) |= TRIGGER_TYPE_DELETE)
104 #define TRIGGER_SETT_UPDATE(type) ((type) |= TRIGGER_TYPE_UPDATE)
105 #define TRIGGER_SETT_TRUNCATE(type) ((type) |= TRIGGER_TYPE_TRUNCATE)
106 
107 #define TRIGGER_FOR_ROW(type) ((type) & TRIGGER_TYPE_ROW)
108 #define TRIGGER_FOR_BEFORE(type) (((type) & TRIGGER_TYPE_TIMING_MASK) == TRIGGER_TYPE_BEFORE)
109 #define TRIGGER_FOR_AFTER(type) (((type) & TRIGGER_TYPE_TIMING_MASK) == TRIGGER_TYPE_AFTER)
110 #define TRIGGER_FOR_INSTEAD(type) (((type) & TRIGGER_TYPE_TIMING_MASK) == TRIGGER_TYPE_INSTEAD)
111 #define TRIGGER_FOR_INSERT(type) ((type) & TRIGGER_TYPE_INSERT)
112 #define TRIGGER_FOR_DELETE(type) ((type) & TRIGGER_TYPE_DELETE)
113 #define TRIGGER_FOR_UPDATE(type) ((type) & TRIGGER_TYPE_UPDATE)
114 #define TRIGGER_FOR_TRUNCATE(type) ((type) & TRIGGER_TYPE_TRUNCATE)
115 
116 /*
117  * Efficient macro for checking if tgtype matches a particular level
118  * (TRIGGER_TYPE_ROW or TRIGGER_TYPE_STATEMENT), timing (TRIGGER_TYPE_BEFORE,
119  * TRIGGER_TYPE_AFTER or TRIGGER_TYPE_INSTEAD), and event (TRIGGER_TYPE_INSERT,
120  * TRIGGER_TYPE_DELETE, TRIGGER_TYPE_UPDATE, or TRIGGER_TYPE_TRUNCATE). Note
121  * that a tgtype can match more than one event, but only one level or timing.
122  */
123 #define TRIGGER_TYPE_MATCHES(type, level, timing, event) \
124  (((type) & (TRIGGER_TYPE_LEVEL_MASK | TRIGGER_TYPE_TIMING_MASK | (event))) == ((level) | (timing) | (event)))
125 
126 /*
127  * Macro to determine whether tgnewtable or tgoldtable has been specified for
128  * a trigger.
129  */
130 #define TRIGGER_USES_TRANSITION_TABLE(namepointer) \
131  ((namepointer) != (char *) NULL)
132 
133 #endif /* EXPOSE_TO_CLIENT_CODE */
134 
135 #endif /* PG_TRIGGER_H */
signed short int16
Definition: c.h:312
FormData_pg_trigger
Definition: pg_trigger.h:63
unsigned int Oid
Definition: postgres_ext.h:31
#define BKI_FORCE_NOT_NULL
Definition: genbki.h:34
Definition: c.h:570
CATALOG(pg_trigger, 2620, TriggerRelationId)
Definition: pg_trigger.h:34
Definition: c.h:544
FormData_pg_trigger * Form_pg_trigger
Definition: pg_trigger.h:70
Definition: c.h:516