codekingpro/portable-devtools

1/*-------------------------------------------------------------------------2 *3 * trigger.h4 *	  Declarations for trigger handling.5 *6 * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group7 * Portions Copyright (c) 1994, Regents of the University of California8 *9 * src/include/commands/trigger.h10 *11 *-------------------------------------------------------------------------12 */13#ifndef TRIGGER_H14#define TRIGGER_H15 16#include "access/tableam.h"17#include "catalog/objectaddress.h"18#include "nodes/execnodes.h"19#include "nodes/parsenodes.h"20 21/*22 * TriggerData is the node type that is passed as fmgr "context" info23 * when a function is called by the trigger manager.24 */25 26#define CALLED_AS_TRIGGER(fcinfo) \27	((fcinfo)->context != NULL && IsA((fcinfo)->context, TriggerData))28 29typedef uint32 TriggerEvent;30 31typedef struct TriggerData32{33	NodeTag		type;34	TriggerEvent tg_event;35	Relation	tg_relation;36	HeapTuple	tg_trigtuple;37	HeapTuple	tg_newtuple;38	Trigger    *tg_trigger;39	TupleTableSlot *tg_trigslot;40	TupleTableSlot *tg_newslot;41	Tuplestorestate *tg_oldtable;42	Tuplestorestate *tg_newtable;43	const Bitmapset *tg_updatedcols;44} TriggerData;45 46/*47 * The state for capturing old and new tuples into transition tables for a48 * single ModifyTable node (or other operation source, e.g. copyfrom.c).49 *50 * This is per-caller to avoid conflicts in setting51 * tcs_original_insert_tuple.  Note, however, that the pointed-to52 * private data may be shared across multiple callers.53 */54struct AfterTriggersTableData;	/* private in trigger.c */55 56typedef struct TransitionCaptureState57{58	/*59	 * Is there at least one trigger specifying each transition relation on60	 * the relation explicitly named in the DML statement or COPY command?61	 * Note: in current usage, these flags could be part of the private state,62	 * but it seems possibly useful to let callers see them.63	 */64	bool		tcs_delete_old_table;65	bool		tcs_update_old_table;66	bool		tcs_update_new_table;67	bool		tcs_insert_new_table;68 69	/*70	 * For INSERT and COPY, it would be wasteful to convert tuples from child71	 * format to parent format after they have already been converted in the72	 * opposite direction during routing.  In that case we bypass conversion73	 * and allow the inserting code (copyfrom.c and nodeModifyTable.c) to74	 * provide a slot containing the original tuple directly.75	 */76	TupleTableSlot *tcs_original_insert_tuple;77 78	/*79	 * Private data including the tuplestore(s) into which to insert tuples.80	 */81	struct AfterTriggersTableData *tcs_private;82} TransitionCaptureState;83 84/*85 * TriggerEvent bit flags86 *87 * Note that we assume different event types (INSERT/DELETE/UPDATE/TRUNCATE)88 * can't be OR'd together in a single TriggerEvent.  This is unlike the89 * situation for pg_trigger rows, so pg_trigger.tgtype uses a different90 * representation!91 */92#define TRIGGER_EVENT_INSERT			0x0000000093#define TRIGGER_EVENT_DELETE			0x0000000194#define TRIGGER_EVENT_UPDATE			0x0000000295#define TRIGGER_EVENT_TRUNCATE			0x0000000396#define TRIGGER_EVENT_OPMASK			0x0000000397 98#define TRIGGER_EVENT_ROW				0x0000000499 100#define TRIGGER_EVENT_BEFORE			0x00000008101#define TRIGGER_EVENT_AFTER				0x00000000102#define TRIGGER_EVENT_INSTEAD			0x00000010103#define TRIGGER_EVENT_TIMINGMASK		0x00000018104 105/* More TriggerEvent flags, used only within trigger.c */106 107#define AFTER_TRIGGER_DEFERRABLE		0x00000020108#define AFTER_TRIGGER_INITDEFERRED		0x00000040109 110#define TRIGGER_FIRED_BY_INSERT(event) \111	(((event) & TRIGGER_EVENT_OPMASK) == TRIGGER_EVENT_INSERT)112 113#define TRIGGER_FIRED_BY_DELETE(event) \114	(((event) & TRIGGER_EVENT_OPMASK) == TRIGGER_EVENT_DELETE)115 116#define TRIGGER_FIRED_BY_UPDATE(event) \117	(((event) & TRIGGER_EVENT_OPMASK) == TRIGGER_EVENT_UPDATE)118 119#define TRIGGER_FIRED_BY_TRUNCATE(event) \120	(((event) & TRIGGER_EVENT_OPMASK) == TRIGGER_EVENT_TRUNCATE)121 122#define TRIGGER_FIRED_FOR_ROW(event) \123	((event) & TRIGGER_EVENT_ROW)124 125#define TRIGGER_FIRED_FOR_STATEMENT(event) \126	(!TRIGGER_FIRED_FOR_ROW(event))127 128#define TRIGGER_FIRED_BEFORE(event) \129	(((event) & TRIGGER_EVENT_TIMINGMASK) == TRIGGER_EVENT_BEFORE)130 131#define TRIGGER_FIRED_AFTER(event) \132	(((event) & TRIGGER_EVENT_TIMINGMASK) == TRIGGER_EVENT_AFTER)133 134#define TRIGGER_FIRED_INSTEAD(event) \135	(((event) & TRIGGER_EVENT_TIMINGMASK) == TRIGGER_EVENT_INSTEAD)136 137/*138 * Definitions for replication role based firing.139 */140#define SESSION_REPLICATION_ROLE_ORIGIN		0141#define SESSION_REPLICATION_ROLE_REPLICA	1142#define SESSION_REPLICATION_ROLE_LOCAL		2143extern PGDLLIMPORT int SessionReplicationRole;144 145/*146 * States at which a trigger can be fired. These are the147 * possible values for pg_trigger.tgenabled.148 */149#define TRIGGER_FIRES_ON_ORIGIN				'O'150#define TRIGGER_FIRES_ALWAYS				'A'151#define TRIGGER_FIRES_ON_REPLICA			'R'152#define TRIGGER_DISABLED					'D'153 154extern ObjectAddress CreateTrigger(CreateTrigStmt *stmt, const char *queryString,155								   Oid relOid, Oid refRelOid, Oid constraintOid, Oid indexOid,156								   Oid funcoid, Oid parentTriggerOid, Node *whenClause,157								   bool isInternal, bool in_partition);158extern ObjectAddress CreateTriggerFiringOn(CreateTrigStmt *stmt, const char *queryString,159										   Oid relOid, Oid refRelOid, Oid constraintOid,160										   Oid indexOid, Oid funcoid, Oid parentTriggerOid,161										   Node *whenClause, bool isInternal, bool in_partition,162										   char trigger_fires_when);163 164extern void TriggerSetParentTrigger(Relation trigRel,165									Oid childTrigId,166									Oid parentTrigId,167									Oid childTableId);168extern void RemoveTriggerById(Oid trigOid);169extern Oid	get_trigger_oid(Oid relid, const char *trigname, bool missing_ok);170 171extern ObjectAddress renametrig(RenameStmt *stmt);172 173extern void EnableDisableTrigger(Relation rel, const char *tgname, Oid tgparent,174								 char fires_when, bool skip_system, bool recurse,175								 LOCKMODE lockmode);176 177extern void RelationBuildTriggers(Relation relation);178 179extern TriggerDesc *CopyTriggerDesc(TriggerDesc *trigdesc);180 181extern const char *FindTriggerIncompatibleWithInheritance(TriggerDesc *trigdesc);182 183extern TransitionCaptureState *MakeTransitionCaptureState(TriggerDesc *trigdesc,184														  Oid relid, CmdType cmdType);185 186extern void FreeTriggerDesc(TriggerDesc *trigdesc);187 188extern void ExecBSInsertTriggers(EState *estate,189								 ResultRelInfo *relinfo);190extern void ExecASInsertTriggers(EState *estate,191								 ResultRelInfo *relinfo,192								 TransitionCaptureState *transition_capture);193extern bool ExecBRInsertTriggers(EState *estate,194								 ResultRelInfo *relinfo,195								 TupleTableSlot *slot);196extern void ExecARInsertTriggers(EState *estate,197								 ResultRelInfo *relinfo,198								 TupleTableSlot *slot,199								 List *recheckIndexes,200								 TransitionCaptureState *transition_capture);201extern bool ExecIRInsertTriggers(EState *estate,202								 ResultRelInfo *relinfo,203								 TupleTableSlot *slot);204extern void ExecBSDeleteTriggers(EState *estate,205								 ResultRelInfo *relinfo);206extern void ExecASDeleteTriggers(EState *estate,207								 ResultRelInfo *relinfo,208								 TransitionCaptureState *transition_capture);209extern bool ExecBRDeleteTriggers(EState *estate,210								 EPQState *epqstate,211								 ResultRelInfo *relinfo,212								 ItemPointer tupleid,213								 HeapTuple fdw_trigtuple,214								 TupleTableSlot **epqslot,215								 TM_Result *tmresult,216								 TM_FailureData *tmfd);217extern void ExecARDeleteTriggers(EState *estate,218								 ResultRelInfo *relinfo,219								 ItemPointer tupleid,220								 HeapTuple fdw_trigtuple,221								 TransitionCaptureState *transition_capture,222								 bool is_crosspart_update);223extern bool ExecIRDeleteTriggers(EState *estate,224								 ResultRelInfo *relinfo,225								 HeapTuple trigtuple);226extern void ExecBSUpdateTriggers(EState *estate,227								 ResultRelInfo *relinfo);228extern void ExecASUpdateTriggers(EState *estate,229								 ResultRelInfo *relinfo,230								 TransitionCaptureState *transition_capture);231extern bool ExecBRUpdateTriggers(EState *estate,232								 EPQState *epqstate,233								 ResultRelInfo *relinfo,234								 ItemPointer tupleid,235								 HeapTuple fdw_trigtuple,236								 TupleTableSlot *newslot,237								 TM_Result *tmresult,238								 TM_FailureData *tmfd);239extern void ExecARUpdateTriggers(EState *estate,240								 ResultRelInfo *relinfo,241								 ResultRelInfo *src_partinfo,242								 ResultRelInfo *dst_partinfo,243								 ItemPointer tupleid,244								 HeapTuple fdw_trigtuple,245								 TupleTableSlot *newslot,246								 List *recheckIndexes,247								 TransitionCaptureState *transition_capture,248								 bool is_crosspart_update);249extern bool ExecIRUpdateTriggers(EState *estate,250								 ResultRelInfo *relinfo,251								 HeapTuple trigtuple,252								 TupleTableSlot *newslot);253extern void ExecBSTruncateTriggers(EState *estate,254								   ResultRelInfo *relinfo);255extern void ExecASTruncateTriggers(EState *estate,256								   ResultRelInfo *relinfo);257 258extern void AfterTriggerBeginXact(void);259extern void AfterTriggerBeginQuery(void);260extern void AfterTriggerEndQuery(EState *estate);261extern void AfterTriggerFireDeferred(void);262extern void AfterTriggerEndXact(bool isCommit);263extern void AfterTriggerBeginSubXact(void);264extern void AfterTriggerEndSubXact(bool isCommit);265extern void AfterTriggerSetState(ConstraintsSetStmt *stmt);266extern bool AfterTriggerPendingOnRel(Oid relid);267 268 269/*270 * in utils/adt/ri_triggers.c271 */272extern bool RI_FKey_pk_upd_check_required(Trigger *trigger, Relation pk_rel,273										  TupleTableSlot *oldslot, TupleTableSlot *newslot);274extern bool RI_FKey_fk_upd_check_required(Trigger *trigger, Relation fk_rel,275										  TupleTableSlot *oldslot, TupleTableSlot *newslot);276extern bool RI_Initial_Check(Trigger *trigger,277							 Relation fk_rel, Relation pk_rel);278extern void RI_PartitionRemove_Check(Trigger *trigger, Relation fk_rel,279									 Relation pk_rel);280 281/* result values for RI_FKey_trigger_type: */282#define RI_TRIGGER_PK	1		/* is a trigger on the PK relation */283#define RI_TRIGGER_FK	2		/* is a trigger on the FK relation */284#define RI_TRIGGER_NONE 0		/* is not an RI trigger function */285 286extern int	RI_FKey_trigger_type(Oid tgfoid);287 288#endif							/* TRIGGER_H */289