event_trigger.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * event_trigger.h
 *    Declarations for command trigger handling.
 *
 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/commands/event_trigger.h
 *
 *-------------------------------------------------------------------------
 */
#ifndef EVENT_TRIGGER_H
#define EVENT_TRIGGER_H
 
#include "catalog/dependency.h"
#include "catalog/objectaddress.h"
#include "catalog/pg_event_trigger.h"
#include "nodes/parsenodes.h"
#include "tcop/cmdtag.h"
#include "tcop/deparse_utility.h"
#include "utils/aclchk_internal.h"
 
typedef struct EventTriggerData
{
    NodeTag     type;
    const char *event;          /* event name */
    Node       *parsetree;      /* parse tree */
    CommandTag  tag;
} EventTriggerData;
 
extern PGDLLIMPORT bool event_triggers;
 
/*
 * Reasons for relation rewrites.
 *
 * pg_event_trigger_table_rewrite_reason() uses these values, so make sure to
 * update the documentation when changing this list.
 */
#define AT_REWRITE_ALTER_PERSISTENCE    0x01
#define AT_REWRITE_DEFAULT_VAL          0x02
#define AT_REWRITE_COLUMN_REWRITE       0x04
#define AT_REWRITE_ACCESS_METHOD        0x08
 
/*
 * EventTriggerData is the node type that is passed as fmgr "context" info
 * when a function is called by the event trigger manager.
 */
#define CALLED_AS_EVENT_TRIGGER(fcinfo) \
    ((fcinfo)->context != NULL && IsA((fcinfo)->context, EventTriggerData))
 
extern Oid  CreateEventTrigger(CreateEventTrigStmt *stmt);
extern Oid  get_event_trigger_oid(const char *trigname, bool missing_ok);
 
extern Oid  AlterEventTrigger(AlterEventTrigStmt *stmt);
extern ObjectAddress AlterEventTriggerOwner(const char *name, Oid newOwnerId);
extern void AlterEventTriggerOwner_oid(Oid, Oid newOwnerId);
 
extern bool EventTriggerSupportsObjectType(ObjectType obtype);
extern bool EventTriggerSupportsObject(const ObjectAddress *object);
extern void EventTriggerDDLCommandStart(Node *parsetree);
extern void EventTriggerDDLCommandEnd(Node *parsetree);
extern void EventTriggerSQLDrop(Node *parsetree);
extern void EventTriggerTableRewrite(Node *parsetree, Oid tableOid, int reason);
extern void EventTriggerOnLogin(void);
 
extern bool EventTriggerBeginCompleteQuery(void);
extern void EventTriggerEndCompleteQuery(void);
extern bool trackDroppedObjectsNeeded(void);
extern void EventTriggerSQLDropAddObject(const ObjectAddress *object,
                                         bool original, bool normal);
 
extern void EventTriggerInhibitCommandCollection(void);
extern void EventTriggerUndoInhibitCommandCollection(void);
 
extern void EventTriggerCollectSimpleCommand(ObjectAddress address,
                                             ObjectAddress secondaryObject,
                                             Node *parsetree);
 
extern void EventTriggerAlterTableStart(Node *parsetree);
extern void EventTriggerAlterTableRelid(Oid objectId);
extern void EventTriggerCollectAlterTableSubcmd(Node *subcmd,
                                                ObjectAddress address);
extern void EventTriggerAlterTableEnd(void);
 
extern void EventTriggerCollectGrant(InternalGrant *istmt);
extern void EventTriggerCollectAlterOpFam(AlterOpFamilyStmt *stmt,
                                          Oid opfamoid, List *operators,
                                          List *procedures);
extern void EventTriggerCollectCreateOpClass(CreateOpClassStmt *stmt,
                                             Oid opcoid, List *operators,
                                             List *procedures);
extern void EventTriggerCollectAlterTSConfig(AlterTSConfigurationStmt *stmt,
                                             Oid cfgId, Oid *dictIds, int ndicts);
extern void EventTriggerCollectAlterDefPrivs(AlterDefaultPrivilegesStmt *stmt);
 
#endif                          /* EVENT_TRIGGER_H */