src/include/utils/relcache.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * relcache.h
   4  *        Relation descriptor cache definitions.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2008, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * $PostgreSQL$
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef RELCACHE_H
  15 #define RELCACHE_H
  16
  17 #include "access/tupdesc.h"
  18 #include "nodes/bitmapset.h"
  19 #include "nodes/pg_list.h"
  20
  21
  22 typedef struct RelationData *Relation;
  23
  24 /* ----------------
  25  *              RelationPtr is used in the executor to support index scans
  26  *              where we have to keep track of several index relations in an
  27  *              array.  -cim 9/10/89
  28  * ----------------
  29  */
  30 typedef Relation *RelationPtr;
  31
  32 /*
  33  * Routines to open (lookup) and close a relcache entry
  34  */
  35 extern Relation RelationIdGetRelation(Oid relationId);
  36 extern void RelationClose(Relation relation);
  37
  38 /*
  39  * Routines to compute/retrieve additional cached information
  40  */
  41 extern List *RelationGetIndexList(Relation relation);
  42 extern Oid      RelationGetOidIndex(Relation relation);
  43 extern List *RelationGetIndexExpressions(Relation relation);
  44 extern List *RelationGetIndexPredicate(Relation relation);
  45 extern Bitmapset *RelationGetIndexAttrBitmap(Relation relation);
  46
  47 extern void RelationSetIndexList(Relation relation,
  48                                          List *indexIds, Oid oidIndex);
  49
  50 extern void RelationInitIndexAccessInfo(Relation relation);
  51
  52 /*
  53  * Routines for backend startup
  54  */
  55 extern void RelationCacheInitialize(void);
  56 extern void RelationCacheInitializePhase2(void);
  57
  58 /*
  59  * Routine to create a relcache entry for an about-to-be-created relation
  60  */
  61 extern Relation RelationBuildLocalRelation(const char *relname,
  62                                                    Oid relnamespace,
  63                                                    TupleDesc tupDesc,
  64                                                    Oid relid,
  65                                                    Oid reltablespace,
  66                                                    bool shared_relation);
  67
  68 /*
  69  * Routines for flushing/rebuilding relcache entries in various scenarios
  70  */
  71 extern void RelationForgetRelation(Oid rid);
  72
  73 extern void RelationCacheInvalidateEntry(Oid relationId);
  74
  75 extern void RelationCacheInvalidate(void);
  76
  77 extern void AtEOXact_RelationCache(bool isCommit);
  78 extern void AtEOSubXact_RelationCache(bool isCommit, SubTransactionId mySubid,
  79                                                   SubTransactionId parentSubid);
  80
  81 extern void RelationCacheMarkNewRelfilenode(Relation rel);
  82
  83 /*
  84  * Routines to help manage rebuilding of relcache init file
  85  */
  86 extern bool RelationIdIsInInitFile(Oid relationId);
  87 extern void RelationCacheInitFileInvalidate(bool beforeSend);
  88 extern void RelationCacheInitFileRemove(const char *dbPath);
  89
  90 /* should be used only by relcache.c and catcache.c */
  91 extern bool criticalRelcachesBuilt;
  92
  93 #endif   /* RELCACHE_H */