objectaccess.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ObjectAccessPostCreate
struct	ObjectAccessDrop
struct	ObjectAccessPostAlter
struct	ObjectAccessNamespaceSearch

Macros
#define	InvokeObjectPostCreateHook(classId, objectId, subId)   InvokeObjectPostCreateHookArg((classId),(objectId),(subId),false)
#define	InvokeObjectPostCreateHookArg(classId, objectId, subId, is_internal)
#define	InvokeObjectDropHook(classId, objectId, subId)   InvokeObjectDropHookArg((classId),(objectId),(subId),0)
#define	InvokeObjectDropHookArg(classId, objectId, subId, dropflags)
#define	InvokeObjectTruncateHook(objectId)
#define	InvokeObjectPostAlterHook(classId, objectId, subId)
#define	InvokeObjectPostAlterHookArg(classId, objectId, subId, auxiliaryId, is_internal)
#define	InvokeNamespaceSearchHook(objectId, ereport_on_violation)
#define	InvokeFunctionExecuteHook(objectId)

Typedefs
typedef enum ObjectAccessType	ObjectAccessType
typedef void(*	object_access_hook_type) (ObjectAccessType access, Oid classId, Oid objectId, int subId, void *arg)

Enumerations
enum	ObjectAccessType {   OAT_POST_CREATE, OAT_DROP, OAT_POST_ALTER, OAT_NAMESPACE_SEARCH,   OAT_FUNCTION_EXECUTE, OAT_TRUNCATE }

Functions
void	RunObjectPostCreateHook (Oid classId, Oid objectId, int subId, bool is_internal)
void	RunObjectDropHook (Oid classId, Oid objectId, int subId, int dropflags)
void	RunObjectTruncateHook (Oid objectId)
void	RunObjectPostAlterHook (Oid classId, Oid objectId, int subId, Oid auxiliaryId, bool is_internal)
bool	RunNamespaceSearchHook (Oid objectId, bool ereport_on_violation)
void	RunFunctionExecuteHook (Oid objectId)

Variables
PGDLLIMPORT object_access_hook_type	object_access_hook

Macro Definition Documentation

InvokeFunctionExecuteHook

#define InvokeFunctionExecuteHook

(

objectId

)

Value:

do {                                        \
        if (object_access_hook)                 \
            RunFunctionExecuteHook(objectId);   \
    } while(0)

Definition at line 191 of file objectaccess.h.

Referenced by call_pltcl_start_proc(), ExecBuildGroupingEqual(), ExecBuildParamSetEqual(), ExecInitAgg(), ExecInitExprRec(), ExecInitFunc(), ExecInitWindowAgg(), ExecuteCallStmt(), HandleFunctionRequest(), init_sexpr(), and initialize_peragg().

InvokeNamespaceSearchHook

#define InvokeNamespaceSearchHook	(		objectId,
			ereport_on_violation
	)

Value:

(!object_access_hook                                            \
     ? true                                                         \
     : RunNamespaceSearchHook((objectId), (ereport_on_violation)))

Definition at line 186 of file objectaccess.h.

Referenced by HandleFunctionRequest(), LookupExplicitNamespace(), LookupNamespaceNoError(), and recomputeNamespacePath().

InvokeObjectDropHook

#define InvokeObjectDropHook	(		classId,
			objectId,
			subId
	)		InvokeObjectDropHookArg((classId),(objectId),(subId),0)

Definition at line 160 of file objectaccess.h.

Referenced by dropdb(), DropRole(), DropSubscription(), and DropTableSpace().

InvokeObjectDropHookArg

#define InvokeObjectDropHookArg	(		classId,
			objectId,
			subId,
			dropflags
	)

Value:

do {                                                            \
        if (object_access_hook)                                     \
            RunObjectDropHook((classId),(objectId),(subId),         \
                              (dropflags));                         \
    } while(0)

Definition at line 162 of file objectaccess.h.

Referenced by deleteOneObject().

InvokeObjectPostAlterHook

#define InvokeObjectPostAlterHook	(		classId,
			objectId,
			subId
	)

Value:

InvokeObjectPostAlterHookArg((classId),(objectId),(subId),      \
                                 InvalidOid,false)

Definition at line 175 of file objectaccess.h.

Referenced by AlterCollation(), AlterConstraintNamespaces(), AlterDatabase(), AlterDatabaseOwner(), AlterDomainDefault(), AlterDomainNotNull(), AlterDomainValidateConstraint(), AlterEnum(), AlterEventTrigger(), AlterEventTriggerOwner_internal(), AlterExtensionNamespace(), AlterForeignDataWrapper(), AlterForeignDataWrapperOwner_internal(), AlterForeignServer(), AlterForeignServerOwner_internal(), AlterFunction(), AlterObjectNamespace_internal(), AlterObjectOwner_internal(), AlterObjectRename_internal(), AlterOperator(), AlterPolicy(), AlterPublicationOptions(), AlterPublicationOwner_internal(), AlterRelationNamespaceInternal(), AlterRole(), AlterSchemaOwner_internal(), AlterSequence(), AlterStatistics(), AlterSubscription(), AlterSubscriptionOwner_internal(), AlterTableSpaceOptions(), AlterTSConfiguration(), AlterTSDictionary(), AlterTypeNamespaceInternal(), AlterTypeOwner_oid(), AlterTypeRecurse(), AlterUserMapping(), ApplyExtensionUpdates(), ATExecAddIdentity(), ATExecAddOf(), ATExecAlterColumnGenericOptions(), ATExecAlterColumnType(), ATExecAlterConstrRecurse(), ATExecChangeOwner(), ATExecDropExpression(), ATExecDropIdentity(), ATExecDropNotNull(), ATExecDropOf(), ATExecGenericOptions(), ATExecSetCompression(), ATExecSetIdentity(), ATExecSetNotNull(), ATExecSetOptions(), ATExecSetRelOptions(), ATExecSetStatistics(), ATExecSetStorage(), ATExecSetTableSpace(), ATExecSetTableSpaceNoStorage(), ATExecValidateConstraint(), EnableDisableRule(), EnableDisableTrigger(), ExecAlterExtensionContentsStmt(), movedb(), RemoveRoleFromObjectPolicy(), rename_policy(), renameatt_internal(), RenameConstraintById(), RenameDatabase(), RenameRewriteRule(), RenameRole(), RenameSchema(), RenameTableSpace(), renametrig_internal(), RenameTypeInternal(), SetDefaultACL(), and SetIndexStorageProperties().

InvokeObjectPostAlterHookArg

#define InvokeObjectPostAlterHookArg	(		classId,
			objectId,
			subId,
			auxiliaryId,
			is_internal
	)

Value:

do {                                                            \
        if (object_access_hook)                                     \
            RunObjectPostAlterHook((classId),(objectId),(subId),    \
                                   (auxiliaryId),(is_internal));    \
    } while(0)

Definition at line 178 of file objectaccess.h.

Referenced by AlterSetting(), ATExecSetRelOptions(), index_constraint_create(), mark_index_clustered(), relation_mark_replica_identity(), RemoveInheritance(), RenameRelationInternal(), StoreCatalogInheritance1(), and swap_relation_files().

InvokeObjectPostCreateHook

#define InvokeObjectPostCreateHook	(		classId,
			objectId,
			subId
	)		InvokeObjectPostCreateHookArg((classId),(objectId),(subId),false)

Definition at line 151 of file objectaccess.h.

Referenced by ATExecAddColumn(), CastCreate(), CollationCreate(), ConversionCreate(), CreateAccessMethod(), createdb(), CreateForeignDataWrapper(), CreateForeignServer(), CreateOpFamily(), CreatePolicy(), CreateProceduralLanguage(), CreatePublication(), CreateRole(), CreateStatistics(), CreateSubscription(), CreateTableSpace(), CreateTransform(), CreateUserMapping(), DefineOpClass(), DefineTSConfiguration(), DefineTSDictionary(), DefineTSParser(), DefineTSTemplate(), insert_event_trigger_tuple(), InsertExtensionTuple(), InsertRule(), inv_create(), NamespaceCreate(), OperatorCreate(), OperatorShellMake(), ProcedureCreate(), PublicationAddTables(), SetDefaultACL(), storeOperators(), storeProcedures(), TypeCreate(), and TypeShellMake().

InvokeObjectPostCreateHookArg

#define InvokeObjectPostCreateHookArg	(		classId,
			objectId,
			subId,
			is_internal
	)

Value:

do {                                                            \
        if (object_access_hook)                                     \
            RunObjectPostCreateHook((classId),(objectId),(subId),   \
                                    (is_internal));                 \
    } while(0)

Definition at line 153 of file objectaccess.h.

Referenced by CreateConstraintEntry(), CreateTriggerFiringOn(), heap_create_with_catalog(), index_create(), and StoreAttrDefault().

InvokeObjectTruncateHook

#define InvokeObjectTruncateHook

(

objectId

)

Value:

do {                                                            \
        if (object_access_hook)                                     \
            RunObjectTruncateHook(objectId);                        \
    } while(0)

Definition at line 169 of file objectaccess.h.

Referenced by truncate_check_rel().

Typedef Documentation

object_access_hook_type

typedef void(* object_access_hook_type) (ObjectAccessType access, Oid classId, Oid objectId, int subId, void *arg)

Definition at line 125 of file objectaccess.h.

ObjectAccessType

typedef enum ObjectAccessType ObjectAccessType

Enumeration Type Documentation

ObjectAccessType

enum ObjectAccessType

Enumerator
OAT_POST_CREATE
OAT_DROP
OAT_POST_ALTER
OAT_NAMESPACE_SEARCH
OAT_FUNCTION_EXECUTE
OAT_TRUNCATE

Definition at line 46 of file objectaccess.h.

{
    OAT_POST_CREATE,
    OAT_DROP,
    OAT_POST_ALTER,
    OAT_NAMESPACE_SEARCH,
    OAT_FUNCTION_EXECUTE,
    OAT_TRUNCATE
} ObjectAccessType;

Function Documentation

RunFunctionExecuteHook()

void RunFunctionExecuteHook

(

Oid

objectId

)

Definition at line 137 of file objectaccess.c.

References Assert, OAT_FUNCTION_EXECUTE, and object_access_hook.

{
    /* caller should check, but just in case... */
    Assert(object_access_hook != NULL);

    (*object_access_hook) (OAT_FUNCTION_EXECUTE,
                           ProcedureRelationId, objectId, 0,
                           NULL);
}

RunNamespaceSearchHook()

bool RunNamespaceSearchHook	(	Oid	objectId,
		bool	ereport_on_violation
	)

Definition at line 113 of file objectaccess.c.

References Assert, ObjectAccessNamespaceSearch::ereport_on_violation, OAT_NAMESPACE_SEARCH, object_access_hook, and ObjectAccessNamespaceSearch::result.

{
    ObjectAccessNamespaceSearch ns_arg;

    /* caller should check, but just in case... */
    Assert(object_access_hook != NULL);

    memset(&ns_arg, 0, sizeof(ObjectAccessNamespaceSearch));
    ns_arg.ereport_on_violation = ereport_on_violation;
    ns_arg.result = true;

    (*object_access_hook) (OAT_NAMESPACE_SEARCH,
                           NamespaceRelationId, objectId, 0,
                           (void *) &ns_arg);

    return ns_arg.result;
}

RunObjectDropHook()

void RunObjectDropHook	(	Oid	classId,
		Oid	objectId,
		int	subId,
		int	dropflags
	)

Definition at line 52 of file objectaccess.c.

References Assert, ObjectAccessDrop::dropflags, OAT_DROP, and object_access_hook.

{
    ObjectAccessDrop drop_arg;

    /* caller should check, but just in case... */
    Assert(object_access_hook != NULL);

    memset(&drop_arg, 0, sizeof(ObjectAccessDrop));
    drop_arg.dropflags = dropflags;

    (*object_access_hook) (OAT_DROP,
                           classId, objectId, subId,
                           (void *) &drop_arg);
}

RunObjectPostAlterHook()

void RunObjectPostAlterHook	(	Oid	classId,
		Oid	objectId,
		int	subId,
		Oid	auxiliaryId,
		bool	is_internal
	)

Definition at line 90 of file objectaccess.c.

References Assert, ObjectAccessPostAlter::auxiliary_id, ObjectAccessPostAlter::is_internal, OAT_POST_ALTER, and object_access_hook.

{
    ObjectAccessPostAlter pa_arg;

    /* caller should check, but just in case... */
    Assert(object_access_hook != NULL);

    memset(&pa_arg, 0, sizeof(ObjectAccessPostAlter));
    pa_arg.auxiliary_id = auxiliaryId;
    pa_arg.is_internal = is_internal;

    (*object_access_hook) (OAT_POST_ALTER,
                           classId, objectId, subId,
                           (void *) &pa_arg);
}

RunObjectPostCreateHook()

void RunObjectPostCreateHook	(	Oid	classId,
		Oid	objectId,
		int	subId,
		bool	is_internal
	)

Definition at line 30 of file objectaccess.c.

References Assert, ObjectAccessPostCreate::is_internal, OAT_POST_CREATE, and object_access_hook.

{
    ObjectAccessPostCreate pc_arg;

    /* caller should check, but just in case... */
    Assert(object_access_hook != NULL);

    memset(&pc_arg, 0, sizeof(ObjectAccessPostCreate));
    pc_arg.is_internal = is_internal;

    (*object_access_hook) (OAT_POST_CREATE,
                           classId, objectId, subId,
                           (void *) &pc_arg);
}

RunObjectTruncateHook()

void RunObjectTruncateHook

(

Oid

objectId

)

Definition at line 74 of file objectaccess.c.

References Assert, OAT_TRUNCATE, and object_access_hook.

{
    /* caller should check, but just in case... */
    Assert(object_access_hook != NULL);

    (*object_access_hook) (OAT_TRUNCATE,
                           RelationRelationId, objectId, 0,
                           NULL);
}

Variable Documentation

object_access_hook

PGDLLIMPORT object_access_hook_type object_access_hook

Definition at line 22 of file objectaccess.c.

Referenced by _PG_init(), RunFunctionExecuteHook(), RunNamespaceSearchHook(), RunObjectDropHook(), RunObjectPostAlterHook(), RunObjectPostCreateHook(), and RunObjectTruncateHook().