PostgreSQL Source Code git master
objectaddress.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * objectaddress.h
4 * functions for working with object addresses
5 *
6 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
8 *
9 * src/include/catalog/objectaddress.h
10 *
11 *-------------------------------------------------------------------------
12 */
13#ifndef OBJECTADDRESS_H
14#define OBJECTADDRESS_H
15
16#include "access/htup.h"
17#include "nodes/parsenodes.h"
18#include "storage/lockdefs.h"
19#include "utils/relcache.h"
20
21/*
22 * An ObjectAddress represents a database object of any type.
23 */
24typedef struct ObjectAddress
25{
26 Oid classId; /* Class Id from pg_class */
27 Oid objectId; /* OID of the object */
28 int32 objectSubId; /* Subitem within object (eg column), or 0 */
30
32
33#define ObjectAddressSubSet(addr, class_id, object_id, object_sub_id) \
34 do { \
35 (addr).classId = (class_id); \
36 (addr).objectId = (object_id); \
37 (addr).objectSubId = (object_sub_id); \
38 } while (0)
39
40#define ObjectAddressSet(addr, class_id, object_id) \
41 ObjectAddressSubSet(addr, class_id, object_id, 0)
42
43extern ObjectAddress get_object_address(ObjectType objtype, Node *object,
44 Relation *relp,
45 LOCKMODE lockmode, bool missing_ok);
46
48 List *object, Relation *relp,
49 LOCKMODE lockmode, bool missing_ok);
50
51extern void check_object_ownership(Oid roleid,
52 ObjectType objtype, ObjectAddress address,
53 Node *object, Relation relation);
54
55extern Oid get_object_namespace(const ObjectAddress *address);
56
57extern bool is_objectclass_supported(Oid class_id);
58extern const char *get_object_class_descr(Oid class_id);
59extern Oid get_object_oid_index(Oid class_id);
60extern int get_object_catcache_oid(Oid class_id);
61extern int get_object_catcache_name(Oid class_id);
62extern AttrNumber get_object_attnum_oid(Oid class_id);
66extern AttrNumber get_object_attnum_acl(Oid class_id);
67extern ObjectType get_object_type(Oid class_id, Oid object_id);
68extern bool get_object_namensp_unique(Oid class_id);
69
71 AttrNumber oidcol, Oid objectId);
73 AttrNumber oidcol,
74 Oid objectId,
75 bool locktup);
76
77extern char *getObjectDescription(const ObjectAddress *object,
78 bool missing_ok);
79extern char *getObjectDescriptionOids(Oid classid, Oid objid);
80
81extern int read_objtype_from_string(const char *objtype);
82extern char *getObjectTypeDescription(const ObjectAddress *object,
83 bool missing_ok);
84extern char *getObjectIdentity(const ObjectAddress *object,
85 bool missing_ok);
86extern char *getObjectIdentityParts(const ObjectAddress *object,
87 List **objname, List **objargs,
88 bool missing_ok);
90
91extern ObjectType get_relkind_objtype(char relkind);
92
93#endif /* OBJECTADDRESS_H */
int16 AttrNumber
Definition: attnum.h:21
#define PGDLLIMPORT
Definition: c.h:1277
int32_t int32
Definition: c.h:484
int LOCKMODE
Definition: lockdefs.h:26
int get_object_catcache_name(Oid class_id)
char * getObjectTypeDescription(const ObjectAddress *object, bool missing_ok)
bool get_object_namensp_unique(Oid class_id)
ObjectAddress get_object_address_rv(ObjectType objtype, RangeVar *rel, List *object, Relation *relp, LOCKMODE lockmode, bool missing_ok)
AttrNumber get_object_attnum_owner(Oid class_id)
HeapTuple get_catalog_object_by_oid(Relation catalog, AttrNumber oidcol, Oid objectId)
AttrNumber get_object_attnum_oid(Oid class_id)
ObjectType get_relkind_objtype(char relkind)
AttrNumber get_object_attnum_namespace(Oid class_id)
void check_object_ownership(Oid roleid, ObjectType objtype, ObjectAddress address, Node *object, Relation relation)
char * getObjectDescriptionOids(Oid classid, Oid objid)
char * getObjectIdentityParts(const ObjectAddress *object, List **objname, List **objargs, bool missing_ok)
AttrNumber get_object_attnum_name(Oid class_id)
const char * get_object_class_descr(Oid class_id)
char * getObjectDescription(const ObjectAddress *object, bool missing_ok)
PGDLLIMPORT const ObjectAddress InvalidObjectAddress
AttrNumber get_object_attnum_acl(Oid class_id)
int get_object_catcache_oid(Oid class_id)
Oid get_object_oid_index(Oid class_id)
int read_objtype_from_string(const char *objtype)
ObjectType get_object_type(Oid class_id, Oid object_id)
struct ObjectAddress ObjectAddress
ObjectAddress get_object_address(ObjectType objtype, Node *object, Relation *relp, LOCKMODE lockmode, bool missing_ok)
char * getObjectIdentity(const ObjectAddress *object, bool missing_ok)
struct ArrayType * strlist_to_textarray(List *list)
Oid get_object_namespace(const ObjectAddress *address)
HeapTuple get_catalog_object_by_oid_extended(Relation catalog, AttrNumber oidcol, Oid objectId, bool locktup)
bool is_objectclass_supported(Oid class_id)
ObjectType
Definition: parsenodes.h:2311
unsigned int Oid
Definition: postgres_ext.h:32
Definition: pg_list.h:54
Definition: nodes.h:129