1 /*------------------------------------------------------------------------- 2 * 3 * trigger.h 4 * Declarations for trigger handling. 5 * 6 * Portions Copyright (c) 1996-2016, PostgreSQL Global Development Group 7 * Portions Copyright (c) 1994, Regents of the University of California 8 * 9 * src/include/commands/trigger.h 10 * 11 *------------------------------------------------------------------------- 12 */ 13 #ifndef TRIGGER_H 14 #define TRIGGER_H 15 16 #include "catalog/objectaddress.h" 17 #include "nodes/execnodes.h" 18 #include "nodes/parsenodes.h" 19 20 /* 21 * TriggerData is the node type that is passed as fmgr "context" info 22 * when a function is called by the trigger manager. 23 */ 24 25 #define CALLED_AS_TRIGGER(fcinfo) \ 26 ((fcinfo)->context != NULL && IsA((fcinfo)->context, TriggerData)) 27 28 typedef uint32 TriggerEvent; 29 30 typedef struct TriggerData 31 { 32 NodeTag type; 33 TriggerEvent tg_event; 34 Relation tg_relation; 35 HeapTuple tg_trigtuple; 36 HeapTuple tg_newtuple; 37 Trigger *tg_trigger; 38 Buffer tg_trigtuplebuf; 39 Buffer tg_newtuplebuf; 40 } TriggerData; 41 42 /* 43 * TriggerEvent bit flags 44 * 45 * Note that we assume different event types (INSERT/DELETE/UPDATE/TRUNCATE) 46 * can't be OR'd together in a single TriggerEvent. This is unlike the 47 * situation for pg_trigger rows, so pg_trigger.tgtype uses a different 48 * representation! 49 */ 50 #define TRIGGER_EVENT_INSERT 0x00000000 51 #define TRIGGER_EVENT_DELETE 0x00000001 52 #define TRIGGER_EVENT_UPDATE 0x00000002 53 #define TRIGGER_EVENT_TRUNCATE 0x00000003 54 #define TRIGGER_EVENT_OPMASK 0x00000003 55 56 #define TRIGGER_EVENT_ROW 0x00000004 57 58 #define TRIGGER_EVENT_BEFORE 0x00000008 59 #define TRIGGER_EVENT_AFTER 0x00000000 60 #define TRIGGER_EVENT_INSTEAD 0x00000010 61 #define TRIGGER_EVENT_TIMINGMASK 0x00000018 62 63 /* More TriggerEvent flags, used only within trigger.c */ 64 65 #define AFTER_TRIGGER_DEFERRABLE 0x00000020 66 #define AFTER_TRIGGER_INITDEFERRED 0x00000040 67 68 #define TRIGGER_FIRED_BY_INSERT(event) \ 69 (((event) & TRIGGER_EVENT_OPMASK) == TRIGGER_EVENT_INSERT) 70 71 #define TRIGGER_FIRED_BY_DELETE(event) \ 72 (((event) & TRIGGER_EVENT_OPMASK) == TRIGGER_EVENT_DELETE) 73 74 #define TRIGGER_FIRED_BY_UPDATE(event) \ 75 (((event) & TRIGGER_EVENT_OPMASK) == TRIGGER_EVENT_UPDATE) 76 77 #define TRIGGER_FIRED_BY_TRUNCATE(event) \ 78 (((event) & TRIGGER_EVENT_OPMASK) == TRIGGER_EVENT_TRUNCATE) 79 80 #define TRIGGER_FIRED_FOR_ROW(event) \ 81 ((event) & TRIGGER_EVENT_ROW) 82 83 #define TRIGGER_FIRED_FOR_STATEMENT(event) \ 84 (!TRIGGER_FIRED_FOR_ROW(event)) 85 86 #define TRIGGER_FIRED_BEFORE(event) \ 87 (((event) & TRIGGER_EVENT_TIMINGMASK) == TRIGGER_EVENT_BEFORE) 88 89 #define TRIGGER_FIRED_AFTER(event) \ 90 (((event) & TRIGGER_EVENT_TIMINGMASK) == TRIGGER_EVENT_AFTER) 91 92 #define TRIGGER_FIRED_INSTEAD(event) \ 93 (((event) & TRIGGER_EVENT_TIMINGMASK) == TRIGGER_EVENT_INSTEAD) 94 95 /* 96 * Definitions for replication role based firing. 97 */ 98 #define SESSION_REPLICATION_ROLE_ORIGIN 0 99 #define SESSION_REPLICATION_ROLE_REPLICA 1 100 #define SESSION_REPLICATION_ROLE_LOCAL 2 101 extern PGDLLIMPORT int SessionReplicationRole; 102 103 /* 104 * States at which a trigger can be fired. These are the 105 * possible values for pg_trigger.tgenabled. 106 */ 107 #define TRIGGER_FIRES_ON_ORIGIN 'O' 108 #define TRIGGER_FIRES_ALWAYS 'A' 109 #define TRIGGER_FIRES_ON_REPLICA 'R' 110 #define TRIGGER_DISABLED 'D' 111 112 extern ObjectAddress CreateTrigger(CreateTrigStmt *stmt, const char *queryString, 113 Oid relOid, Oid refRelOid, Oid constraintOid, Oid indexOid, 114 bool isInternal); 115 116 extern void RemoveTriggerById(Oid trigOid); 117 extern Oid get_trigger_oid(Oid relid, const char *name, bool missing_ok); 118 119 extern ObjectAddress renametrig(RenameStmt *stmt); 120 121 extern void EnableDisableTrigger(Relation rel, const char *tgname, 122 char fires_when, bool skip_system); 123 124 extern void RelationBuildTriggers(Relation relation); 125 126 extern TriggerDesc *CopyTriggerDesc(TriggerDesc *trigdesc); 127 128 extern void FreeTriggerDesc(TriggerDesc *trigdesc); 129 130 extern void ExecBSInsertTriggers(EState *estate, 131 ResultRelInfo *relinfo); 132 extern void ExecASInsertTriggers(EState *estate, 133 ResultRelInfo *relinfo); 134 extern TupleTableSlot *ExecBRInsertTriggers(EState *estate, 135 ResultRelInfo *relinfo, 136 TupleTableSlot *slot); 137 extern void ExecARInsertTriggers(EState *estate, 138 ResultRelInfo *relinfo, 139 HeapTuple trigtuple, 140 List *recheckIndexes); 141 extern TupleTableSlot *ExecIRInsertTriggers(EState *estate, 142 ResultRelInfo *relinfo, 143 TupleTableSlot *slot); 144 extern void ExecBSDeleteTriggers(EState *estate, 145 ResultRelInfo *relinfo); 146 extern void ExecASDeleteTriggers(EState *estate, 147 ResultRelInfo *relinfo); 148 extern bool ExecBRDeleteTriggers(EState *estate, 149 EPQState *epqstate, 150 ResultRelInfo *relinfo, 151 ItemPointer tupleid, 152 HeapTuple fdw_trigtuple); 153 extern void ExecARDeleteTriggers(EState *estate, 154 ResultRelInfo *relinfo, 155 ItemPointer tupleid, 156 HeapTuple fdw_trigtuple); 157 extern bool ExecIRDeleteTriggers(EState *estate, 158 ResultRelInfo *relinfo, 159 HeapTuple trigtuple); 160 extern void ExecBSUpdateTriggers(EState *estate, 161 ResultRelInfo *relinfo); 162 extern void ExecASUpdateTriggers(EState *estate, 163 ResultRelInfo *relinfo); 164 extern TupleTableSlot *ExecBRUpdateTriggers(EState *estate, 165 EPQState *epqstate, 166 ResultRelInfo *relinfo, 167 ItemPointer tupleid, 168 HeapTuple fdw_trigtuple, 169 TupleTableSlot *slot); 170 extern void ExecARUpdateTriggers(EState *estate, 171 ResultRelInfo *relinfo, 172 ItemPointer tupleid, 173 HeapTuple fdw_trigtuple, 174 HeapTuple newtuple, 175 List *recheckIndexes); 176 extern TupleTableSlot *ExecIRUpdateTriggers(EState *estate, 177 ResultRelInfo *relinfo, 178 HeapTuple trigtuple, 179 TupleTableSlot *slot); 180 extern void ExecBSTruncateTriggers(EState *estate, 181 ResultRelInfo *relinfo); 182 extern void ExecASTruncateTriggers(EState *estate, 183 ResultRelInfo *relinfo); 184 185 extern void AfterTriggerBeginXact(void); 186 extern void AfterTriggerBeginQuery(void); 187 extern void AfterTriggerEndQuery(EState *estate); 188 extern void AfterTriggerFireDeferred(void); 189 extern void AfterTriggerEndXact(bool isCommit); 190 extern void AfterTriggerBeginSubXact(void); 191 extern void AfterTriggerEndSubXact(bool isCommit); 192 extern void AfterTriggerSetState(ConstraintsSetStmt *stmt); 193 extern bool AfterTriggerPendingOnRel(Oid relid); 194 195 196 /* 197 * in utils/adt/ri_triggers.c 198 */ 199 extern bool RI_FKey_pk_upd_check_required(Trigger *trigger, Relation pk_rel, 200 HeapTuple old_row, HeapTuple new_row); 201 extern bool RI_FKey_fk_upd_check_required(Trigger *trigger, Relation fk_rel, 202 HeapTuple old_row, HeapTuple new_row); 203 extern bool RI_Initial_Check(Trigger *trigger, 204 Relation fk_rel, Relation pk_rel); 205 206 /* result values for RI_FKey_trigger_type: */ 207 #define RI_TRIGGER_PK 1 /* is a trigger on the PK relation */ 208 #define RI_TRIGGER_FK 2 /* is a trigger on the FK relation */ 209 #define RI_TRIGGER_NONE 0 /* is not an RI trigger function */ 210 211 extern int RI_FKey_trigger_type(Oid tgfoid); 212 213 extern Datum pg_trigger_depth(PG_FUNCTION_ARGS); 214 215 #endif /* TRIGGER_H */ 216