2012-07-18 16:16:16 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
|
|
|
* event_trigger.h
|
|
|
|
* Declarations for command trigger handling.
|
|
|
|
*
|
2013-01-01 23:15:01 +01:00
|
|
|
* Portions Copyright (c) 1996-2013, PostgreSQL Global Development Group
|
2012-07-18 16:16:16 +02:00
|
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
|
|
*
|
|
|
|
* src/include/commands/event_trigger.h
|
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
#ifndef EVENT_TRIGGER_H
|
|
|
|
#define EVENT_TRIGGER_H
|
|
|
|
|
2013-04-11 16:59:47 +02:00
|
|
|
#include "catalog/dependency.h"
|
Add sql_drop event for event triggers
This event takes place just before ddl_command_end, and is fired if and
only if at least one object has been dropped by the command. (For
instance, DROP TABLE IF EXISTS of a table that does not in fact exist
will not lead to such a trigger firing). Commands that drop multiple
objects (such as DROP SCHEMA or DROP OWNED BY) will cause a single event
to fire. Some firings might be surprising, such as
ALTER TABLE DROP COLUMN.
The trigger is fired after the drop has taken place, because that has
been deemed the safest design, to avoid exposing possibly-inconsistent
internal state (system catalogs as well as current transaction) to the
user function code. This means that careful tracking of object
identification is required during the object removal phase.
Like other currently existing events, there is support for tag
filtering.
To support the new event, add a new pg_event_trigger_dropped_objects()
set-returning function, which returns a set of rows comprising the
objects affected by the command. This is to be used within the user
function code, and is mostly modelled after the recently introduced
pg_identify_object() function.
Catalog version bumped due to the new function.
Dimitri Fontaine and Álvaro Herrera
Review by Robert Haas, Tom Lane
2013-03-27 20:02:10 +01:00
|
|
|
#include "catalog/objectaddress.h"
|
2012-07-18 16:16:16 +02:00
|
|
|
#include "catalog/pg_event_trigger.h"
|
|
|
|
#include "nodes/parsenodes.h"
|
|
|
|
|
2012-07-20 17:38:47 +02:00
|
|
|
typedef struct EventTriggerData
|
|
|
|
{
|
|
|
|
NodeTag type;
|
Add sql_drop event for event triggers
This event takes place just before ddl_command_end, and is fired if and
only if at least one object has been dropped by the command. (For
instance, DROP TABLE IF EXISTS of a table that does not in fact exist
will not lead to such a trigger firing). Commands that drop multiple
objects (such as DROP SCHEMA or DROP OWNED BY) will cause a single event
to fire. Some firings might be surprising, such as
ALTER TABLE DROP COLUMN.
The trigger is fired after the drop has taken place, because that has
been deemed the safest design, to avoid exposing possibly-inconsistent
internal state (system catalogs as well as current transaction) to the
user function code. This means that careful tracking of object
identification is required during the object removal phase.
Like other currently existing events, there is support for tag
filtering.
To support the new event, add a new pg_event_trigger_dropped_objects()
set-returning function, which returns a set of rows comprising the
objects affected by the command. This is to be used within the user
function code, and is mostly modelled after the recently introduced
pg_identify_object() function.
Catalog version bumped due to the new function.
Dimitri Fontaine and Álvaro Herrera
Review by Robert Haas, Tom Lane
2013-03-27 20:02:10 +01:00
|
|
|
const char *event; /* event name */
|
2012-07-20 17:38:47 +02:00
|
|
|
Node *parsetree; /* parse tree */
|
|
|
|
const char *tag; /* command tag */
|
|
|
|
} EventTriggerData;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* 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))
|
|
|
|
|
2012-12-29 13:55:37 +01:00
|
|
|
extern Oid CreateEventTrigger(CreateEventTrigStmt *stmt);
|
2012-07-18 16:16:16 +02:00
|
|
|
extern void RemoveEventTriggerById(Oid ctrigOid);
|
|
|
|
extern Oid get_event_trigger_oid(const char *trigname, bool missing_ok);
|
|
|
|
|
2012-12-29 13:55:37 +01:00
|
|
|
extern Oid AlterEventTrigger(AlterEventTrigStmt *stmt);
|
2012-12-24 17:25:26 +01:00
|
|
|
extern Oid AlterEventTriggerOwner(const char *name, Oid newOwnerId);
|
2012-07-18 16:16:16 +02:00
|
|
|
extern void AlterEventTriggerOwner_oid(Oid, Oid newOwnerId);
|
|
|
|
|
2012-07-20 17:38:47 +02:00
|
|
|
extern bool EventTriggerSupportsObjectType(ObjectType obtype);
|
2013-04-11 16:59:47 +02:00
|
|
|
extern bool EventTriggerSupportsObjectClass(ObjectClass objclass);
|
2012-07-20 17:38:47 +02:00
|
|
|
extern void EventTriggerDDLCommandStart(Node *parsetree);
|
2013-01-22 00:00:24 +01:00
|
|
|
extern void EventTriggerDDLCommandEnd(Node *parsetree);
|
Add sql_drop event for event triggers
This event takes place just before ddl_command_end, and is fired if and
only if at least one object has been dropped by the command. (For
instance, DROP TABLE IF EXISTS of a table that does not in fact exist
will not lead to such a trigger firing). Commands that drop multiple
objects (such as DROP SCHEMA or DROP OWNED BY) will cause a single event
to fire. Some firings might be surprising, such as
ALTER TABLE DROP COLUMN.
The trigger is fired after the drop has taken place, because that has
been deemed the safest design, to avoid exposing possibly-inconsistent
internal state (system catalogs as well as current transaction) to the
user function code. This means that careful tracking of object
identification is required during the object removal phase.
Like other currently existing events, there is support for tag
filtering.
To support the new event, add a new pg_event_trigger_dropped_objects()
set-returning function, which returns a set of rows comprising the
objects affected by the command. This is to be used within the user
function code, and is mostly modelled after the recently introduced
pg_identify_object() function.
Catalog version bumped due to the new function.
Dimitri Fontaine and Álvaro Herrera
Review by Robert Haas, Tom Lane
2013-03-27 20:02:10 +01:00
|
|
|
extern void EventTriggerSQLDrop(Node *parsetree);
|
|
|
|
|
|
|
|
extern bool EventTriggerBeginCompleteQuery(void);
|
|
|
|
extern void EventTriggerEndCompleteQuery(void);
|
|
|
|
extern bool trackDroppedObjectsNeeded(void);
|
|
|
|
extern void EventTriggerSQLDropAddObject(ObjectAddress *object);
|
2012-07-20 17:38:47 +02:00
|
|
|
|
2012-07-18 16:16:16 +02:00
|
|
|
#endif /* EVENT_TRIGGER_H */
|