PostgreSQL Source Code  git master
dependency.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * dependency.h
4  * Routines to support inter-object dependencies.
5  *
6  *
7  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/catalog/dependency.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef DEPENDENCY_H
15 #define DEPENDENCY_H
16 
17 #include "catalog/objectaddress.h"
18 
19 
20 /*
21  * Precise semantics of a dependency relationship are specified by the
22  * DependencyType code (which is stored in a "char" field in pg_depend,
23  * so we assign ASCII-code values to the enumeration members).
24  *
25  * In all cases, a dependency relationship indicates that the referenced
26  * object may not be dropped without also dropping the dependent object.
27  * However, there are several subflavors; see the description of pg_depend
28  * in catalogs.sgml for details.
29  */
30 
31 typedef enum DependencyType
32 {
41 
42 /*
43  * There is also a SharedDependencyType enum type that determines the exact
44  * semantics of an entry in pg_shdepend. Just like regular dependency entries,
45  * any pg_shdepend entry means that the referenced object cannot be dropped
46  * unless the dependent object is dropped at the same time. There are some
47  * additional rules however:
48  *
49  * (a) a SHARED_DEPENDENCY_OWNER entry means that the referenced object is
50  * the role owning the dependent object. The referenced object must be
51  * a pg_authid entry.
52  *
53  * (b) a SHARED_DEPENDENCY_ACL entry means that the referenced object is
54  * a role mentioned in the ACL field of the dependent object. The referenced
55  * object must be a pg_authid entry. (SHARED_DEPENDENCY_ACL entries are not
56  * created for the owner of an object; hence two objects may be linked by
57  * one or the other, but not both, of these dependency types.)
58  *
59  * (c) a SHARED_DEPENDENCY_POLICY entry means that the referenced object is
60  * a role mentioned in a policy object. The referenced object must be a
61  * pg_authid entry.
62  *
63  * (d) a SHARED_DEPENDENCY_TABLESPACE entry means that the referenced
64  * object is a tablespace mentioned in a relation without storage. The
65  * referenced object must be a pg_tablespace entry. (Relations that have
66  * storage don't need this: they are protected by the existence of a physical
67  * file in the tablespace.)
68  *
69  * SHARED_DEPENDENCY_INVALID is a value used as a parameter in internal
70  * routines, and is not valid in the catalog itself.
71  */
73 {
80 
81 /* expansible list of ObjectAddresses (private in dependency.c) */
82 typedef struct ObjectAddresses ObjectAddresses;
83 
84 /* flag bits for performDeletion/performMultipleDeletions: */
85 #define PERFORM_DELETION_INTERNAL 0x0001 /* internal action */
86 #define PERFORM_DELETION_CONCURRENTLY 0x0002 /* concurrent drop */
87 #define PERFORM_DELETION_QUIETLY 0x0004 /* suppress notices */
88 #define PERFORM_DELETION_SKIP_ORIGINAL 0x0008 /* keep original obj */
89 #define PERFORM_DELETION_SKIP_EXTENSIONS 0x0010 /* keep extensions */
90 #define PERFORM_DELETION_CONCURRENT_LOCK 0x0020 /* normal drop with
91  * concurrent lock mode */
92 
93 
94 /* in dependency.c */
95 
96 extern void AcquireDeletionLock(const ObjectAddress *object, int flags);
97 
98 extern void ReleaseDeletionLock(const ObjectAddress *object);
99 
100 extern void performDeletion(const ObjectAddress *object,
101  DropBehavior behavior, int flags);
102 
103 extern void performMultipleDeletions(const ObjectAddresses *objects,
104  DropBehavior behavior, int flags);
105 
106 extern void recordDependencyOnExpr(const ObjectAddress *depender,
107  Node *expr, List *rtable,
108  DependencyType behavior);
109 
110 extern void recordDependencyOnSingleRelExpr(const ObjectAddress *depender,
111  Node *expr, Oid relId,
112  DependencyType behavior,
113  DependencyType self_behavior,
114  bool reverse_self);
115 
117 
118 extern void add_exact_object_address(const ObjectAddress *object,
119  ObjectAddresses *addrs);
120 
121 extern bool object_address_present(const ObjectAddress *object,
122  const ObjectAddresses *addrs);
123 
124 extern void record_object_address_dependencies(const ObjectAddress *depender,
125  ObjectAddresses *referenced,
126  DependencyType behavior);
127 
128 extern void sort_object_addresses(ObjectAddresses *addrs);
129 
130 extern void free_object_addresses(ObjectAddresses *addrs);
131 
132 /* in pg_depend.c */
133 
134 extern void recordDependencyOn(const ObjectAddress *depender,
135  const ObjectAddress *referenced,
136  DependencyType behavior);
137 
138 extern void recordMultipleDependencies(const ObjectAddress *depender,
139  const ObjectAddress *referenced,
140  int nreferenced,
141  DependencyType behavior);
142 
143 extern void recordDependencyOnCurrentExtension(const ObjectAddress *object,
144  bool isReplace);
145 
146 extern void checkMembershipInCurrentExtension(const ObjectAddress *object);
147 
148 extern long deleteDependencyRecordsFor(Oid classId, Oid objectId,
149  bool skipExtensionDeps);
150 
151 extern long deleteDependencyRecordsForClass(Oid classId, Oid objectId,
152  Oid refclassId, char deptype);
153 
154 extern long deleteDependencyRecordsForSpecific(Oid classId, Oid objectId,
155  char deptype,
156  Oid refclassId, Oid refobjectId);
157 
158 extern long changeDependencyFor(Oid classId, Oid objectId,
159  Oid refClassId, Oid oldRefObjectId,
160  Oid newRefObjectId);
161 
162 extern long changeDependenciesOf(Oid classId, Oid oldObjectId,
163  Oid newObjectId);
164 
165 extern long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId,
166  Oid newRefObjectId);
167 
168 extern Oid getExtensionOfObject(Oid classId, Oid objectId);
169 extern List *getAutoExtensionsOfObject(Oid classId, Oid objectId);
170 
171 extern bool sequenceIsOwned(Oid seqId, char deptype, Oid *tableId, int32 *colId);
172 extern List *getOwnedSequences(Oid relid);
173 extern Oid getIdentitySequence(Oid relid, AttrNumber attnum, bool missing_ok);
174 
175 extern Oid get_index_constraint(Oid indexId);
176 
177 extern List *get_index_ref_constraints(Oid indexId);
178 
179 /* in pg_shdepend.c */
180 
181 extern void recordSharedDependencyOn(ObjectAddress *depender,
182  ObjectAddress *referenced,
183  SharedDependencyType deptype);
184 
185 extern void deleteSharedDependencyRecordsFor(Oid classId, Oid objectId,
186  int32 objectSubId);
187 
188 extern void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner);
189 
190 extern void changeDependencyOnOwner(Oid classId, Oid objectId,
191  Oid newOwnerId);
192 
193 extern void recordDependencyOnTablespace(Oid classId, Oid objectId,
194  Oid tablespace);
195 
196 extern void changeDependencyOnTablespace(Oid classId, Oid objectId,
197  Oid newTablespaceId);
198 
199 extern void updateAclDependencies(Oid classId, Oid objectId, int32 objsubId,
200  Oid ownerId,
201  int noldmembers, Oid *oldmembers,
202  int nnewmembers, Oid *newmembers);
203 
204 extern bool checkSharedDependencies(Oid classId, Oid objectId,
205  char **detail_msg, char **detail_log_msg);
206 
207 extern void shdepLockAndCheckObject(Oid classId, Oid objectId);
208 
209 extern void copyTemplateDependencies(Oid templateDbId, Oid newDbId);
210 
211 extern void dropDatabaseDependencies(Oid databaseId);
212 
213 extern void shdepDropOwned(List *roleids, DropBehavior behavior);
214 
215 extern void shdepReassignOwned(List *roleids, Oid newrole);
216 
217 #endif /* DEPENDENCY_H */
int16 AttrNumber
Definition: attnum.h:21
signed int int32
Definition: c.h:481
void performMultipleDeletions(const ObjectAddresses *objects, DropBehavior behavior, int flags)
Definition: dependency.c:332
void checkMembershipInCurrentExtension(const ObjectAddress *object)
Definition: pg_depend.c:257
void recordMultipleDependencies(const ObjectAddress *depender, const ObjectAddress *referenced, int nreferenced, DependencyType behavior)
Definition: pg_depend.c:56
void record_object_address_dependencies(const ObjectAddress *depender, ObjectAddresses *referenced, DependencyType behavior)
Definition: dependency.c:2736
void recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:44
long changeDependencyFor(Oid classId, Oid objectId, Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:456
DependencyType
Definition: dependency.h:32
@ DEPENDENCY_AUTO
Definition: dependency.h:34
@ DEPENDENCY_AUTO_EXTENSION
Definition: dependency.h:39
@ DEPENDENCY_INTERNAL
Definition: dependency.h:35
@ DEPENDENCY_PARTITION_PRI
Definition: dependency.h:36
@ DEPENDENCY_PARTITION_SEC
Definition: dependency.h:37
@ DEPENDENCY_EXTENSION
Definition: dependency.h:38
@ DEPENDENCY_NORMAL
Definition: dependency.h:33
void sort_object_addresses(ObjectAddresses *addrs)
Definition: dependency.c:2755
SharedDependencyType
Definition: dependency.h:73
@ SHARED_DEPENDENCY_TABLESPACE
Definition: dependency.h:77
@ SHARED_DEPENDENCY_INVALID
Definition: dependency.h:78
@ SHARED_DEPENDENCY_POLICY
Definition: dependency.h:76
@ SHARED_DEPENDENCY_ACL
Definition: dependency.h:75
@ SHARED_DEPENDENCY_OWNER
Definition: dependency.h:74
List * getAutoExtensionsOfObject(Oid classId, Oid objectId)
Definition: pg_depend.c:777
void dropDatabaseDependencies(Oid databaseId)
Definition: pg_shdepend.c:949
void changeDependencyOnOwner(Oid classId, Oid objectId, Oid newOwnerId)
Definition: pg_shdepend.c:308
long deleteDependencyRecordsForClass(Oid classId, Oid objectId, Oid refclassId, char deptype)
Definition: pg_depend.c:350
Oid getExtensionOfObject(Oid classId, Oid objectId)
Definition: pg_depend.c:731
void AcquireDeletionLock(const ObjectAddress *object, int flags)
Definition: dependency.c:1494
void copyTemplateDependencies(Oid templateDbId, Oid newDbId)
Definition: pg_shdepend.c:845
long changeDependenciesOf(Oid classId, Oid oldObjectId, Oid newObjectId)
Definition: pg_depend.c:564
void performDeletion(const ObjectAddress *object, DropBehavior behavior, int flags)
Definition: dependency.c:273
void deleteSharedDependencyRecordsFor(Oid classId, Oid objectId, int32 objectSubId)
Definition: pg_shdepend.c:997
void updateAclDependencies(Oid classId, Oid objectId, int32 objsubId, Oid ownerId, int noldmembers, Oid *oldmembers, int nnewmembers, Oid *newmembers)
Definition: pg_shdepend.c:477
void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner)
Definition: pg_shdepend.c:160
long deleteDependencyRecordsFor(Oid classId, Oid objectId, bool skipExtensionDeps)
Definition: pg_depend.c:300
bool checkSharedDependencies(Oid classId, Oid objectId, char **detail_msg, char **detail_log_msg)
Definition: pg_shdepend.c:626
void recordDependencyOnTablespace(Oid classId, Oid objectId, Oid tablespace)
Definition: pg_shdepend.c:356
long deleteDependencyRecordsForSpecific(Oid classId, Oid objectId, char deptype, Oid refclassId, Oid refobjectId)
Definition: pg_depend.c:397
long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:620
void ReleaseDeletionLock(const ObjectAddress *object)
Definition: dependency.c:1526
void shdepDropOwned(List *roleids, DropBehavior behavior)
Definition: pg_shdepend.c:1290
void recordDependencyOnSingleRelExpr(const ObjectAddress *depender, Node *expr, Oid relId, DependencyType behavior, DependencyType self_behavior, bool reverse_self)
Definition: dependency.c:1594
void recordDependencyOnExpr(const ObjectAddress *depender, Node *expr, List *rtable, DependencyType behavior)
Definition: dependency.c:1551
void recordSharedDependencyOn(ObjectAddress *depender, ObjectAddress *referenced, SharedDependencyType deptype)
Definition: pg_shdepend.c:117
void shdepLockAndCheckObject(Oid classId, Oid objectId)
Definition: pg_shdepend.c:1161
bool object_address_present(const ObjectAddress *object, const ObjectAddresses *addrs)
Definition: dependency.c:2587
ObjectAddresses * new_object_addresses(void)
Definition: dependency.c:2481
Oid get_index_constraint(Oid indexId)
Definition: pg_depend.c:968
List * get_index_ref_constraints(Oid indexId)
Definition: pg_depend.c:1024
void add_exact_object_address(const ObjectAddress *object, ObjectAddresses *addrs)
Definition: dependency.c:2527
Oid getIdentitySequence(Oid relid, AttrNumber attnum, bool missing_ok)
Definition: pg_depend.c:944
void recordDependencyOnCurrentExtension(const ObjectAddress *object, bool isReplace)
Definition: pg_depend.c:192
List * getOwnedSequences(Oid relid)
Definition: pg_depend.c:935
void changeDependencyOnTablespace(Oid classId, Oid objectId, Oid newTablespaceId)
Definition: pg_shdepend.c:377
void shdepReassignOwned(List *roleids, Oid newrole)
Definition: pg_shdepend.c:1463
bool sequenceIsOwned(Oid seqId, char deptype, Oid *tableId, int32 *colId)
Definition: pg_depend.c:827
void free_object_addresses(ObjectAddresses *addrs)
Definition: dependency.c:2767
DropBehavior
Definition: parsenodes.h:2251
int16 attnum
Definition: pg_attribute.h:74
char * tablespace
Definition: pgbench.c:216
unsigned int Oid
Definition: postgres_ext.h:31
Definition: pg_list.h:54
Definition: nodes.h:129