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-2021, 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) */
83 
84 /*
85  * This enum covers all system catalogs whose OIDs can appear in
86  * pg_depend.classId or pg_shdepend.classId. Keep object_classes[] in sync.
87  */
88 typedef enum ObjectClass
89 {
90  OCLASS_CLASS, /* pg_class */
91  OCLASS_PROC, /* pg_proc */
92  OCLASS_TYPE, /* pg_type */
93  OCLASS_CAST, /* pg_cast */
94  OCLASS_COLLATION, /* pg_collation */
95  OCLASS_CONSTRAINT, /* pg_constraint */
96  OCLASS_CONVERSION, /* pg_conversion */
97  OCLASS_DEFAULT, /* pg_attrdef */
98  OCLASS_LANGUAGE, /* pg_language */
99  OCLASS_LARGEOBJECT, /* pg_largeobject */
100  OCLASS_OPERATOR, /* pg_operator */
101  OCLASS_OPCLASS, /* pg_opclass */
102  OCLASS_OPFAMILY, /* pg_opfamily */
103  OCLASS_AM, /* pg_am */
104  OCLASS_AMOP, /* pg_amop */
105  OCLASS_AMPROC, /* pg_amproc */
106  OCLASS_REWRITE, /* pg_rewrite */
107  OCLASS_TRIGGER, /* pg_trigger */
108  OCLASS_SCHEMA, /* pg_namespace */
109  OCLASS_STATISTIC_EXT, /* pg_statistic_ext */
110  OCLASS_TSPARSER, /* pg_ts_parser */
111  OCLASS_TSDICT, /* pg_ts_dict */
112  OCLASS_TSTEMPLATE, /* pg_ts_template */
113  OCLASS_TSCONFIG, /* pg_ts_config */
114  OCLASS_ROLE, /* pg_authid */
115  OCLASS_DATABASE, /* pg_database */
116  OCLASS_TBLSPACE, /* pg_tablespace */
117  OCLASS_FDW, /* pg_foreign_data_wrapper */
118  OCLASS_FOREIGN_SERVER, /* pg_foreign_server */
119  OCLASS_USER_MAPPING, /* pg_user_mapping */
120  OCLASS_DEFACL, /* pg_default_acl */
121  OCLASS_EXTENSION, /* pg_extension */
122  OCLASS_EVENT_TRIGGER, /* pg_event_trigger */
123  OCLASS_POLICY, /* pg_policy */
124  OCLASS_PUBLICATION, /* pg_publication */
125  OCLASS_PUBLICATION_REL, /* pg_publication_rel */
126  OCLASS_SUBSCRIPTION, /* pg_subscription */
127  OCLASS_TRANSFORM /* pg_transform */
128 } ObjectClass;
129 
130 #define LAST_OCLASS OCLASS_TRANSFORM
131 
132 /* flag bits for performDeletion/performMultipleDeletions: */
133 #define PERFORM_DELETION_INTERNAL 0x0001 /* internal action */
134 #define PERFORM_DELETION_CONCURRENTLY 0x0002 /* concurrent drop */
135 #define PERFORM_DELETION_QUIETLY 0x0004 /* suppress notices */
136 #define PERFORM_DELETION_SKIP_ORIGINAL 0x0008 /* keep original obj */
137 #define PERFORM_DELETION_SKIP_EXTENSIONS 0x0010 /* keep extensions */
138 #define PERFORM_DELETION_CONCURRENT_LOCK 0x0020 /* normal drop with
139  * concurrent lock mode */
140 
141 
142 /* in dependency.c */
143 
144 extern void AcquireDeletionLock(const ObjectAddress *object, int flags);
145 
146 extern void ReleaseDeletionLock(const ObjectAddress *object);
147 
148 extern void performDeletion(const ObjectAddress *object,
149  DropBehavior behavior, int flags);
150 
151 extern void performMultipleDeletions(const ObjectAddresses *objects,
152  DropBehavior behavior, int flags);
153 
154 extern void recordDependencyOnExpr(const ObjectAddress *depender,
155  Node *expr, List *rtable,
156  DependencyType behavior);
157 
158 extern void recordDependencyOnSingleRelExpr(const ObjectAddress *depender,
159  Node *expr, Oid relId,
160  DependencyType behavior,
161  DependencyType self_behavior,
162  bool reverse_self);
163 
164 extern ObjectClass getObjectClass(const ObjectAddress *object);
165 
167 
168 extern void add_exact_object_address(const ObjectAddress *object,
169  ObjectAddresses *addrs);
170 
171 extern bool object_address_present(const ObjectAddress *object,
172  const ObjectAddresses *addrs);
173 
174 extern void record_object_address_dependencies(const ObjectAddress *depender,
175  ObjectAddresses *referenced,
176  DependencyType behavior);
177 
178 extern void sort_object_addresses(ObjectAddresses *addrs);
179 
180 extern void free_object_addresses(ObjectAddresses *addrs);
181 
182 /* in pg_depend.c */
183 
184 extern void recordDependencyOn(const ObjectAddress *depender,
185  const ObjectAddress *referenced,
186  DependencyType behavior);
187 
188 extern void recordMultipleDependencies(const ObjectAddress *depender,
189  const ObjectAddress *referenced,
190  int nreferenced,
191  DependencyType behavior);
192 
193 extern void recordDependencyOnCurrentExtension(const ObjectAddress *object,
194  bool isReplace);
195 
196 extern long deleteDependencyRecordsFor(Oid classId, Oid objectId,
197  bool skipExtensionDeps);
198 
199 extern long deleteDependencyRecordsForClass(Oid classId, Oid objectId,
200  Oid refclassId, char deptype);
201 
202 extern long deleteDependencyRecordsForSpecific(Oid classId, Oid objectId,
203  char deptype,
204  Oid refclassId, Oid refobjectId);
205 
206 extern long changeDependencyFor(Oid classId, Oid objectId,
207  Oid refClassId, Oid oldRefObjectId,
208  Oid newRefObjectId);
209 
210 extern long changeDependenciesOf(Oid classId, Oid oldObjectId,
211  Oid newObjectId);
212 
213 extern long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId,
214  Oid newRefObjectId);
215 
216 extern Oid getExtensionOfObject(Oid classId, Oid objectId);
217 extern List *getAutoExtensionsOfObject(Oid classId, Oid objectId);
218 
219 extern bool sequenceIsOwned(Oid seqId, char deptype, Oid *tableId, int32 *colId);
220 extern List *getOwnedSequences(Oid relid);
221 extern Oid getIdentitySequence(Oid relid, AttrNumber attnum, bool missing_ok);
222 
223 extern Oid get_index_constraint(Oid indexId);
224 
225 extern List *get_index_ref_constraints(Oid indexId);
226 
227 /* in pg_shdepend.c */
228 
229 extern void recordSharedDependencyOn(ObjectAddress *depender,
230  ObjectAddress *referenced,
231  SharedDependencyType deptype);
232 
233 extern void deleteSharedDependencyRecordsFor(Oid classId, Oid objectId,
234  int32 objectSubId);
235 
236 extern void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner);
237 
238 extern void changeDependencyOnOwner(Oid classId, Oid objectId,
239  Oid newOwnerId);
240 
241 extern void recordDependencyOnTablespace(Oid classId, Oid objectId,
242  Oid tablespace);
243 
244 extern void changeDependencyOnTablespace(Oid classId, Oid objectId,
245  Oid newTablespaceId);
246 
247 extern void updateAclDependencies(Oid classId, Oid objectId, int32 objectSubId,
248  Oid ownerId,
249  int noldmembers, Oid *oldmembers,
250  int nnewmembers, Oid *newmembers);
251 
252 extern bool checkSharedDependencies(Oid classId, Oid objectId,
253  char **detail_msg, char **detail_log_msg);
254 
255 extern void shdepLockAndCheckObject(Oid classId, Oid objectId);
256 
257 extern void copyTemplateDependencies(Oid templateDbId, Oid newDbId);
258 
259 extern void dropDatabaseDependencies(Oid databaseId);
260 
261 extern void shdepDropOwned(List *relids, DropBehavior behavior);
262 
263 extern void shdepReassignOwned(List *relids, Oid newrole);
264 
265 #endif /* DEPENDENCY_H */
List * getOwnedSequences(Oid relid)
Definition: pg_depend.c:878
void recordDependencyOnTablespace(Oid classId, Oid objectId, Oid tablespace)
Definition: pg_shdepend.c:359
DependencyType
Definition: dependency.h:31
void ReleaseDeletionLock(const ObjectAddress *object)
Definition: dependency.c:1546
void updateAclDependencies(Oid classId, Oid objectId, int32 objectSubId, Oid ownerId, int noldmembers, Oid *oldmembers, int nnewmembers, Oid *newmembers)
Definition: pg_shdepend.c:480
bool sequenceIsOwned(Oid seqId, char deptype, Oid *tableId, int32 *colId)
Definition: pg_depend.c:770
void shdepLockAndCheckObject(Oid classId, Oid objectId)
Definition: pg_shdepend.c:1161
long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:563
void shdepReassignOwned(List *relids, Oid newrole)
Definition: pg_shdepend.c:1437
bool checkSharedDependencies(Oid classId, Oid objectId, char **detail_msg, char **detail_log_msg)
Definition: pg_shdepend.c:629
void performDeletion(const ObjectAddress *object, DropBehavior behavior, int flags)
Definition: dependency.c:313
Definition: nodes.h:536
long deleteDependencyRecordsForClass(Oid classId, Oid objectId, Oid refclassId, char deptype)
Definition: pg_depend.c:293
void recordMultipleDependencies(const ObjectAddress *depender, const ObjectAddress *referenced, int nreferenced, DependencyType behavior)
Definition: pg_depend.c:56
unsigned int Oid
Definition: postgres_ext.h:31
void changeDependencyOnOwner(Oid classId, Oid objectId, Oid newOwnerId)
Definition: pg_shdepend.c:311
void dropDatabaseDependencies(Oid databaseId)
Definition: pg_shdepend.c:949
signed int int32
Definition: c.h:429
Oid getIdentitySequence(Oid relid, AttrNumber attnum, bool missing_ok)
Definition: pg_depend.c:887
void sort_object_addresses(ObjectAddresses *addrs)
Definition: dependency.c:2713
void AcquireDeletionLock(const ObjectAddress *object, int flags)
Definition: dependency.c:1517
void copyTemplateDependencies(Oid templateDbId, Oid newDbId)
Definition: pg_shdepend.c:848
long changeDependencyFor(Oid classId, Oid objectId, Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:399
ObjectClass
Definition: dependency.h:88
char * tablespace
Definition: pgbench.c:226
void deleteSharedDependencyRecordsFor(Oid classId, Oid objectId, int32 objectSubId)
Definition: pg_shdepend.c:997
ObjectClass getObjectClass(const ObjectAddress *object)
Definition: dependency.c:2740
void free_object_addresses(ObjectAddresses *addrs)
Definition: dependency.c:2725
void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner)
Definition: pg_shdepend.c:163
SharedDependencyType
Definition: dependency.h:72
List * getAutoExtensionsOfObject(Oid classId, Oid objectId)
Definition: pg_depend.c:720
bool object_address_present(const ObjectAddress *object, const ObjectAddresses *addrs)
Definition: dependency.c:2545
DropBehavior
Definition: parsenodes.h:1858
Oid get_index_constraint(Oid indexId)
Definition: pg_depend.c:911
long deleteDependencyRecordsFor(Oid classId, Oid objectId, bool skipExtensionDeps)
Definition: pg_depend.c:243
void add_exact_object_address(const ObjectAddress *object, ObjectAddresses *addrs)
Definition: dependency.c:2485
ObjectAddresses * new_object_addresses(void)
Definition: dependency.c:2430
List * get_index_ref_constraints(Oid indexId)
Definition: pg_depend.c:967
int16 attnum
Definition: pg_attribute.h:83
void performMultipleDeletions(const ObjectAddresses *objects, DropBehavior behavior, int flags)
Definition: dependency.c:372
long changeDependenciesOf(Oid classId, Oid oldObjectId, Oid newObjectId)
Definition: pg_depend.c:507
long deleteDependencyRecordsForSpecific(Oid classId, Oid objectId, char deptype, Oid refclassId, Oid refobjectId)
Definition: pg_depend.c:340
Oid getExtensionOfObject(Oid classId, Oid objectId)
Definition: pg_depend.c:674
void recordDependencyOnCurrentExtension(const ObjectAddress *object, bool isReplace)
Definition: pg_depend.c:191
void recordDependencyOnExpr(const ObjectAddress *depender, Node *expr, List *rtable, DependencyType behavior)
Definition: dependency.c:1571
void recordSharedDependencyOn(ObjectAddress *depender, ObjectAddress *referenced, SharedDependencyType deptype)
Definition: pg_shdepend.c:120
Definition: pg_list.h:50
int16 AttrNumber
Definition: attnum.h:21
void changeDependencyOnTablespace(Oid classId, Oid objectId, Oid newTablespaceId)
Definition: pg_shdepend.c:380
void recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:44
void record_object_address_dependencies(const ObjectAddress *depender, ObjectAddresses *referenced, DependencyType behavior)
Definition: dependency.c:2694
void shdepDropOwned(List *relids, DropBehavior behavior)
Definition: pg_shdepend.c:1284
void recordDependencyOnSingleRelExpr(const ObjectAddress *depender, Node *expr, Oid relId, DependencyType behavior, DependencyType self_behavior, bool reverse_self)
Definition: dependency.c:1614