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-2020, 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 {
42 
43 /*
44  * There is also a SharedDependencyType enum type that determines the exact
45  * semantics of an entry in pg_shdepend. Just like regular dependency entries,
46  * any pg_shdepend entry means that the referenced object cannot be dropped
47  * unless the dependent object is dropped at the same time. There are some
48  * additional rules however:
49  *
50  * (a) For a SHARED_DEPENDENCY_PIN entry, there is no dependent object --
51  * rather, the referenced object is an essential part of the system. This
52  * applies to the initdb-created superuser. Entries of this type are only
53  * created by initdb; objects in this category don't need further pg_shdepend
54  * entries if more objects come to depend on them.
55  *
56  * (b) a SHARED_DEPENDENCY_OWNER entry means that the referenced object is
57  * the role owning the dependent object. The referenced object must be
58  * a pg_authid entry.
59  *
60  * (c) a SHARED_DEPENDENCY_ACL entry means that the referenced object is
61  * a role mentioned in the ACL field of the dependent object. The referenced
62  * object must be a pg_authid entry. (SHARED_DEPENDENCY_ACL entries are not
63  * created for the owner of an object; hence two objects may be linked by
64  * one or the other, but not both, of these dependency types.)
65  *
66  * (d) a SHARED_DEPENDENCY_POLICY entry means that the referenced object is
67  * a role mentioned in a policy object. The referenced object must be a
68  * pg_authid entry.
69  *
70  * SHARED_DEPENDENCY_INVALID is a value used as a parameter in internal
71  * routines, and is not valid in the catalog itself.
72  */
74 {
81 
82 /* expansible list of ObjectAddresses (private in dependency.c) */
84 
85 /*
86  * This enum covers all system catalogs whose OIDs can appear in
87  * pg_depend.classId or pg_shdepend.classId. Keep object_classes[] in sync.
88  */
89 typedef enum ObjectClass
90 {
91  OCLASS_CLASS, /* pg_class */
92  OCLASS_PROC, /* pg_proc */
93  OCLASS_TYPE, /* pg_type */
94  OCLASS_CAST, /* pg_cast */
95  OCLASS_COLLATION, /* pg_collation */
96  OCLASS_CONSTRAINT, /* pg_constraint */
97  OCLASS_CONVERSION, /* pg_conversion */
98  OCLASS_DEFAULT, /* pg_attrdef */
99  OCLASS_LANGUAGE, /* pg_language */
100  OCLASS_LARGEOBJECT, /* pg_largeobject */
101  OCLASS_OPERATOR, /* pg_operator */
102  OCLASS_OPCLASS, /* pg_opclass */
103  OCLASS_OPFAMILY, /* pg_opfamily */
104  OCLASS_AM, /* pg_am */
105  OCLASS_AMOP, /* pg_amop */
106  OCLASS_AMPROC, /* pg_amproc */
107  OCLASS_REWRITE, /* pg_rewrite */
108  OCLASS_TRIGGER, /* pg_trigger */
109  OCLASS_SCHEMA, /* pg_namespace */
110  OCLASS_STATISTIC_EXT, /* pg_statistic_ext */
111  OCLASS_TSPARSER, /* pg_ts_parser */
112  OCLASS_TSDICT, /* pg_ts_dict */
113  OCLASS_TSTEMPLATE, /* pg_ts_template */
114  OCLASS_TSCONFIG, /* pg_ts_config */
115  OCLASS_ROLE, /* pg_authid */
116  OCLASS_DATABASE, /* pg_database */
117  OCLASS_TBLSPACE, /* pg_tablespace */
118  OCLASS_FDW, /* pg_foreign_data_wrapper */
119  OCLASS_FOREIGN_SERVER, /* pg_foreign_server */
120  OCLASS_USER_MAPPING, /* pg_user_mapping */
121  OCLASS_DEFACL, /* pg_default_acl */
122  OCLASS_EXTENSION, /* pg_extension */
123  OCLASS_EVENT_TRIGGER, /* pg_event_trigger */
124  OCLASS_POLICY, /* pg_policy */
125  OCLASS_PUBLICATION, /* pg_publication */
126  OCLASS_PUBLICATION_REL, /* pg_publication_rel */
127  OCLASS_SUBSCRIPTION, /* pg_subscription */
128  OCLASS_TRANSFORM /* pg_transform */
129 } ObjectClass;
130 
131 #define LAST_OCLASS OCLASS_TRANSFORM
132 
133 /* flag bits for performDeletion/performMultipleDeletions: */
134 #define PERFORM_DELETION_INTERNAL 0x0001 /* internal action */
135 #define PERFORM_DELETION_CONCURRENTLY 0x0002 /* concurrent drop */
136 #define PERFORM_DELETION_QUIETLY 0x0004 /* suppress notices */
137 #define PERFORM_DELETION_SKIP_ORIGINAL 0x0008 /* keep original obj */
138 #define PERFORM_DELETION_SKIP_EXTENSIONS 0x0010 /* keep extensions */
139 #define PERFORM_DELETION_CONCURRENT_LOCK 0x0020 /* normal drop with
140  * concurrent lock mode */
141 
142 
143 /* in dependency.c */
144 
145 extern void AcquireDeletionLock(const ObjectAddress *object, int flags);
146 
147 extern void ReleaseDeletionLock(const ObjectAddress *object);
148 
149 extern void performDeletion(const ObjectAddress *object,
150  DropBehavior behavior, int flags);
151 
152 extern void performMultipleDeletions(const ObjectAddresses *objects,
153  DropBehavior behavior, int flags);
154 
155 extern void recordDependencyOnExpr(const ObjectAddress *depender,
156  Node *expr, List *rtable,
157  DependencyType behavior);
158 
159 extern void recordDependencyOnSingleRelExpr(const ObjectAddress *depender,
160  Node *expr, Oid relId,
161  DependencyType behavior,
162  DependencyType self_behavior,
163  bool reverse_self);
164 
165 extern ObjectClass getObjectClass(const ObjectAddress *object);
166 
168 
169 extern void add_exact_object_address(const ObjectAddress *object,
170  ObjectAddresses *addrs);
171 
172 extern bool object_address_present(const ObjectAddress *object,
173  const ObjectAddresses *addrs);
174 
175 extern void record_object_address_dependencies(const ObjectAddress *depender,
176  ObjectAddresses *referenced,
177  DependencyType behavior);
178 
179 extern void sort_object_addresses(ObjectAddresses *addrs);
180 
181 extern void free_object_addresses(ObjectAddresses *addrs);
182 
183 /* in pg_depend.c */
184 
185 extern void recordDependencyOn(const ObjectAddress *depender,
186  const ObjectAddress *referenced,
187  DependencyType behavior);
188 
189 extern void recordMultipleDependencies(const ObjectAddress *depender,
190  const ObjectAddress *referenced,
191  int nreferenced,
192  DependencyType behavior);
193 
194 extern void recordDependencyOnCurrentExtension(const ObjectAddress *object,
195  bool isReplace);
196 
197 extern long deleteDependencyRecordsFor(Oid classId, Oid objectId,
198  bool skipExtensionDeps);
199 
200 extern long deleteDependencyRecordsForClass(Oid classId, Oid objectId,
201  Oid refclassId, char deptype);
202 
203 extern long deleteDependencyRecordsForSpecific(Oid classId, Oid objectId,
204  char deptype,
205  Oid refclassId, Oid refobjectId);
206 
207 extern long changeDependencyFor(Oid classId, Oid objectId,
208  Oid refClassId, Oid oldRefObjectId,
209  Oid newRefObjectId);
210 
211 extern long changeDependenciesOf(Oid classId, Oid oldObjectId,
212  Oid newObjectId);
213 
214 extern long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId,
215  Oid newRefObjectId);
216 
217 extern Oid getExtensionOfObject(Oid classId, Oid objectId);
218 extern List *getAutoExtensionsOfObject(Oid classId, Oid objectId);
219 
220 extern bool sequenceIsOwned(Oid seqId, char deptype, Oid *tableId, int32 *colId);
221 extern List *getOwnedSequences(Oid relid);
222 extern Oid getIdentitySequence(Oid relid, AttrNumber attnum, bool missing_ok);
223 
224 extern Oid get_constraint_index(Oid constraintId);
225 
226 extern Oid get_index_constraint(Oid indexId);
227 
228 extern List *get_index_ref_constraints(Oid indexId);
229 
230 /* in pg_shdepend.c */
231 
232 extern void recordSharedDependencyOn(ObjectAddress *depender,
233  ObjectAddress *referenced,
234  SharedDependencyType deptype);
235 
236 extern void deleteSharedDependencyRecordsFor(Oid classId, Oid objectId,
237  int32 objectSubId);
238 
239 extern void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner);
240 
241 extern void changeDependencyOnOwner(Oid classId, Oid objectId,
242  Oid newOwnerId);
243 
244 extern void updateAclDependencies(Oid classId, Oid objectId, int32 objectSubId,
245  Oid ownerId,
246  int noldmembers, Oid *oldmembers,
247  int nnewmembers, Oid *newmembers);
248 
249 extern bool checkSharedDependencies(Oid classId, Oid objectId,
250  char **detail_msg, char **detail_log_msg);
251 
252 extern void shdepLockAndCheckObject(Oid classId, Oid objectId);
253 
254 extern void copyTemplateDependencies(Oid templateDbId, Oid newDbId);
255 
256 extern void dropDatabaseDependencies(Oid databaseId);
257 
258 extern void shdepDropOwned(List *relids, DropBehavior behavior);
259 
260 extern void shdepReassignOwned(List *relids, Oid newrole);
261 
262 #endif /* DEPENDENCY_H */
List * getOwnedSequences(Oid relid)
Definition: pg_depend.c:863
DependencyType
Definition: dependency.h:31
void ReleaseDeletionLock(const ObjectAddress *object)
Definition: dependency.c:1557
void updateAclDependencies(Oid classId, Oid objectId, int32 objectSubId, Oid ownerId, int noldmembers, Oid *oldmembers, int nnewmembers, Oid *newmembers)
Definition: pg_shdepend.c:426
bool sequenceIsOwned(Oid seqId, char deptype, Oid *tableId, int32 *colId)
Definition: pg_depend.c:755
void shdepLockAndCheckObject(Oid classId, Oid objectId)
Definition: pg_shdepend.c:1071
long changeDependenciesOn(Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:512
void shdepReassignOwned(List *relids, Oid newrole)
Definition: pg_shdepend.c:1401
bool checkSharedDependencies(Oid classId, Oid objectId, char **detail_msg, char **detail_log_msg)
Definition: pg_shdepend.c:577
void performDeletion(const ObjectAddress *object, DropBehavior behavior, int flags)
Definition: dependency.c:312
Definition: nodes.h:529
long deleteDependencyRecordsForClass(Oid classId, Oid objectId, Oid refclassId, char deptype)
Definition: pg_depend.c:240
void recordMultipleDependencies(const ObjectAddress *depender, const ObjectAddress *referenced, int nreferenced, DependencyType behavior)
Definition: pg_depend.c:55
unsigned int Oid
Definition: postgres_ext.h:31
void changeDependencyOnOwner(Oid classId, Oid objectId, Oid newOwnerId)
Definition: pg_shdepend.c:309
void dropDatabaseDependencies(Oid databaseId)
Definition: pg_shdepend.c:859
signed int int32
Definition: c.h:355
Oid getIdentitySequence(Oid relid, AttrNumber attnum, bool missing_ok)
Definition: pg_depend.c:872
void sort_object_addresses(ObjectAddresses *addrs)
Definition: dependency.c:2693
void AcquireDeletionLock(const ObjectAddress *object, int flags)
Definition: dependency.c:1528
void copyTemplateDependencies(Oid templateDbId, Oid newDbId)
Definition: pg_shdepend.c:795
long changeDependencyFor(Oid classId, Oid objectId, Oid refClassId, Oid oldRefObjectId, Oid newRefObjectId)
Definition: pg_depend.c:346
ObjectClass
Definition: dependency.h:89
void deleteSharedDependencyRecordsFor(Oid classId, Oid objectId, int32 objectSubId)
Definition: pg_shdepend.c:907
ObjectClass getObjectClass(const ObjectAddress *object)
Definition: dependency.c:2720
void free_object_addresses(ObjectAddresses *addrs)
Definition: dependency.c:2705
void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner)
Definition: pg_shdepend.c:164
SharedDependencyType
Definition: dependency.h:73
List * getAutoExtensionsOfObject(Oid classId, Oid objectId)
Definition: pg_depend.c:705
bool object_address_present(const ObjectAddress *object, const ObjectAddresses *addrs)
Definition: dependency.c:2525
DropBehavior
Definition: parsenodes.h:1764
Oid get_index_constraint(Oid indexId)
Definition: pg_depend.c:965
long deleteDependencyRecordsFor(Oid classId, Oid objectId, bool skipExtensionDeps)
Definition: pg_depend.c:190
void add_exact_object_address(const ObjectAddress *object, ObjectAddresses *addrs)
Definition: dependency.c:2465
ObjectAddresses * new_object_addresses(void)
Definition: dependency.c:2410
List * get_index_ref_constraints(Oid indexId)
Definition: pg_depend.c:1021
int16 attnum
Definition: pg_attribute.h:79
void performMultipleDeletions(const ObjectAddresses *objects, DropBehavior behavior, int flags)
Definition: dependency.c:371
long changeDependenciesOf(Oid classId, Oid oldObjectId, Oid newObjectId)
Definition: pg_depend.c:456
long deleteDependencyRecordsForSpecific(Oid classId, Oid objectId, char deptype, Oid refclassId, Oid refobjectId)
Definition: pg_depend.c:287
Oid getExtensionOfObject(Oid classId, Oid objectId)
Definition: pg_depend.c:659
void recordDependencyOnCurrentExtension(const ObjectAddress *object, bool isReplace)
Definition: pg_depend.c:138
Oid get_constraint_index(Oid constraintId)
Definition: pg_depend.c:898
void recordDependencyOnExpr(const ObjectAddress *depender, Node *expr, List *rtable, DependencyType behavior)
Definition: dependency.c:1582
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 recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:43
void record_object_address_dependencies(const ObjectAddress *depender, ObjectAddresses *referenced, DependencyType behavior)
Definition: dependency.c:2674
void shdepDropOwned(List *relids, DropBehavior behavior)
Definition: pg_shdepend.c:1247
void recordDependencyOnSingleRelExpr(const ObjectAddress *depender, Node *expr, Oid relId, DependencyType behavior, DependencyType self_behavior, bool reverse_self)
Definition: dependency.c:1625