granicus.if.org Git - postgresql/blob - src/include/catalog/dependency.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * dependency.h
   4  *        Routines to support inter-object dependencies.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2005, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $PostgreSQL: pgsql/src/include/catalog/dependency.h,v 1.19 2006/02/11 22:17:19 momjian Exp $
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef DEPENDENCY_H
  15 #define DEPENDENCY_H
  16
  17 #include "nodes/parsenodes.h"   /* for DropBehavior */
  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:
  28  *
  29  * DEPENDENCY_NORMAL ('n'): normal relationship between separately-created
  30  * objects.  The dependent object may be dropped without affecting the
  31  * referenced object.  The referenced object may only be dropped by
  32  * specifying CASCADE, in which case the dependent object is dropped too.
  33  * Example: a table column has a normal dependency on its datatype.
  34  *
  35  * DEPENDENCY_AUTO ('a'): the dependent object can be dropped separately
  36  * from the referenced object, and should be automatically dropped
  37  * (regardless of RESTRICT or CASCADE mode) if the referenced object
  38  * is dropped.
  39  * Example: a named constraint on a table is made auto-dependent on
  40  * the table, so that it will go away if the table is dropped.
  41  *
  42  * DEPENDENCY_INTERNAL ('i'): the dependent object was created as part
  43  * of creation of the referenced object, and is really just a part of
  44  * its internal implementation.  A DROP of the dependent object will be
  45  * disallowed outright (we'll tell the user to issue a DROP against the
  46  * referenced object, instead).  A DROP of the referenced object will be
  47  * propagated through to drop the dependent object whether CASCADE is
  48  * specified or not.
  49  * Example: a trigger that's created to enforce a foreign-key constraint
  50  * is made internally dependent on the constraint's pg_constraint entry.
  51  *
  52  * DEPENDENCY_PIN ('p'): there is no dependent object; this type of entry
  53  * is a signal that the system itself depends on the referenced object,
  54  * and so that object must never be deleted.  Entries of this type are
  55  * created only during initdb.  The fields for the dependent object
  56  * contain zeroes.
  57  *
  58  * Other dependency flavors may be needed in future.
  59  *----------
  60  */
  61
  62 typedef enum DependencyType
  63 {
  64         DEPENDENCY_NORMAL = 'n',
  65         DEPENDENCY_AUTO = 'a',
  66         DEPENDENCY_INTERNAL = 'i',
  67         DEPENDENCY_PIN = 'p'
  68 } DependencyType;
  69
  70 /*
  71  * There is also a SharedDependencyType enum type that determines the exact
  72  * semantics of an entry in pg_shdepend.  Just like regular dependency entries,
  73  * any pg_shdepend entry means that the referenced object cannot be dropped
  74  * unless the dependent object is dropped at the same time.  There are some
  75  * additional rules however:
  76  *
  77  * (a) For a SHARED_DEPENDENCY_PIN entry, there is no dependent object --
  78  * rather, the referenced object is an essential part of the system.  This
  79  * applies to the initdb-created superuser.  Entries of this type are only
  80  * created by initdb; objects in this category don't need further pg_shdepend
  81  * entries if more objects come to depend on them.
  82  *
  83  * (b) a SHARED_DEPENDENCY_OWNER entry means that the referenced object is
  84  * the role owning the dependent object.  The referenced object must be
  85  * a pg_authid entry.
  86  *
  87  * (c) a SHARED_DEPENDENCY_ACL entry means that the referenced object is
  88  * a role mentioned in the ACL field of the dependent object.  The referenced
  89  * object must be a pg_authid entry.  (SHARED_DEPENDENCY_ACL entries are not
  90  * created for the owner of an object; hence two objects may be linked by
  91  * one or the other, but not both, of these dependency types.)
  92  *
  93  * SHARED_DEPENDENCY_INVALID is a value used as a parameter in internal
  94  * routines, and is not valid in the catalog itself.
  95  */
  96 typedef enum SharedDependencyType
  97 {
  98         SHARED_DEPENDENCY_PIN = 'p',
  99         SHARED_DEPENDENCY_OWNER = 'o',
 100         SHARED_DEPENDENCY_ACL = 'a',
 101         SHARED_DEPENDENCY_INVALID = 0
 102 } SharedDependencyType;
 103
 104
 105 /*
 106  * The two objects related by a dependency are identified by ObjectAddresses.
 107  */
 108 typedef struct ObjectAddress
 109 {
 110         Oid                     classId;                /* Class Id from pg_class */
 111         Oid                     objectId;               /* OID of the object */
 112         int32           objectSubId;    /* Subitem within the object (column of table) */
 113 } ObjectAddress;
 114
 115
 116 /*
 117  * This enum covers all system catalogs whose OIDs can appear in
 118  * pg_depend.classId or pg_shdepend.classId.
 119  */
 120 typedef enum ObjectClass
 121 {
 122         OCLASS_CLASS,                           /* pg_class */
 123         OCLASS_PROC,                            /* pg_proc */
 124         OCLASS_TYPE,                            /* pg_type */
 125         OCLASS_CAST,                            /* pg_cast */
 126         OCLASS_CONSTRAINT,                      /* pg_constraint */
 127         OCLASS_CONVERSION,                      /* pg_conversion */
 128         OCLASS_DEFAULT,                         /* pg_attrdef */
 129         OCLASS_LANGUAGE,                        /* pg_language */
 130         OCLASS_OPERATOR,                        /* pg_operator */
 131         OCLASS_OPCLASS,                         /* pg_opclass */
 132         OCLASS_REWRITE,                         /* pg_rewrite */
 133         OCLASS_TRIGGER,                         /* pg_trigger */
 134         OCLASS_SCHEMA,                          /* pg_namespace */
 135         OCLASS_ROLE,                            /* pg_authid */
 136         OCLASS_DATABASE,                        /* pg_database */
 137         OCLASS_TBLSPACE,                        /* pg_tablespace */
 138         MAX_OCLASS                                      /* MUST BE LAST */
 139 } ObjectClass;
 140
 141
 142 /* in dependency.c */
 143
 144 extern void performDeletion(const ObjectAddress *object,
 145                                 DropBehavior behavior);
 146
 147 extern void deleteWhatDependsOn(const ObjectAddress *object,
 148                                         bool showNotices);
 149
 150 extern void recordDependencyOnExpr(const ObjectAddress *depender,
 151                                            Node *expr, List *rtable,
 152                                            DependencyType behavior);
 153
 154 extern void recordDependencyOnSingleRelExpr(const ObjectAddress *depender,
 155                                                                 Node *expr, Oid relId,
 156                                                                 DependencyType behavior,
 157                                                                 DependencyType self_behavior);
 158
 159 extern ObjectClass getObjectClass(const ObjectAddress *object);
 160
 161 extern char *getObjectDescription(const ObjectAddress *object);
 162
 163 /* in pg_depend.c */
 164
 165 extern void recordDependencyOn(const ObjectAddress *depender,
 166                                    const ObjectAddress *referenced,
 167                                    DependencyType behavior);
 168
 169 extern void recordMultipleDependencies(const ObjectAddress *depender,
 170                                                    const ObjectAddress *referenced,
 171                                                    int nreferenced,
 172                                                    DependencyType behavior);
 173
 174 extern long deleteDependencyRecordsFor(Oid classId, Oid objectId);
 175
 176 extern long changeDependencyFor(Oid classId, Oid objectId,
 177                                         Oid refClassId, Oid oldRefObjectId,
 178                                         Oid newRefObjectId);
 179
 180 extern bool objectIsInternalDependency(Oid classId, Oid objectId);
 181
 182 extern List* getDependentOids(Oid classId, Oid objId,
 183                                                           Oid refClassId, DependencyType deptype);
 184
 185 extern List* getReferencingOids(Oid refClassId, Oid refObjId, Oid refObjSubId,
 186                                                                 Oid classId, DependencyType deptype);
 187
 188 /* in pg_shdepend.c */
 189
 190 extern void recordSharedDependencyOn(ObjectAddress *depender,
 191                                                  ObjectAddress *referenced,
 192                                                  SharedDependencyType deptype);
 193
 194 extern void deleteSharedDependencyRecordsFor(Oid classId, Oid objectId);
 195
 196 extern void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner);
 197
 198 extern void changeDependencyOnOwner(Oid classId, Oid objectId,
 199                                                 Oid newOwnerId);
 200
 201 extern void updateAclDependencies(Oid classId, Oid objectId,
 202                                           Oid ownerId, bool isGrant,
 203                                           int noldmembers, Oid *oldmembers,
 204                                           int nnewmembers, Oid *newmembers);
 205
 206 extern char *checkSharedDependencies(Oid classId, Oid objectId);
 207
 208 extern void copyTemplateDependencies(Oid templateDbId, Oid newDbId);
 209
 210 extern void dropDatabaseDependencies(Oid databaseId);
 211
 212 extern void shdepDropOwned(List *relids, DropBehavior behavior);
 213
 214 extern void shdepReassignOwned(List *relids, Oid newrole);
 215
 216 #endif   /* DEPENDENCY_H */