PostgreSQL Source Code  git master
relcache.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * relcache.h
4  * Relation descriptor cache definitions.
5  *
6  *
7  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * src/include/utils/relcache.h
11  *
12  *-------------------------------------------------------------------------
13  */
14 #ifndef RELCACHE_H
15 #define RELCACHE_H
16 
17 #include "access/tupdesc.h"
18 #include "common/relpath.h"
19 #include "nodes/bitmapset.h"
20 
21 
22 /*
23  * Name of relcache init file(s), used to speed up backend startup
24  */
25 #define RELCACHE_INIT_FILENAME "pg_internal.init"
26 
27 typedef struct RelationData *Relation;
28 
29 /* ----------------
30  * RelationPtr is used in the executor to support index scans
31  * where we have to keep track of several index relations in an
32  * array. -cim 9/10/89
33  * ----------------
34  */
36 
37 /*
38  * Routines to open (lookup) and close a relcache entry
39  */
40 extern Relation RelationIdGetRelation(Oid relationId);
41 extern void RelationClose(Relation relation);
42 
43 /*
44  * Routines to compute/retrieve additional cached information
45  */
46 extern List *RelationGetFKeyList(Relation relation);
47 extern List *RelationGetIndexList(Relation relation);
48 extern List *RelationGetStatExtList(Relation relation);
49 extern Oid RelationGetPrimaryKeyIndex(Relation relation);
50 extern Oid RelationGetReplicaIndex(Relation relation);
51 extern List *RelationGetIndexExpressions(Relation relation);
53 extern List *RelationGetIndexPredicate(Relation relation);
55 extern bytea **RelationGetIndexAttOptions(Relation relation, bool copy);
56 
57 typedef enum IndexAttrBitmapKind
58 {
65 
67  IndexAttrBitmapKind attrKind);
68 
70 
71 extern void RelationGetExclusionInfo(Relation indexRelation,
72  Oid **operators,
73  Oid **procs,
74  uint16 **strategies);
75 
76 extern void RelationInitIndexAccessInfo(Relation relation);
77 
78 /* caller must include pg_publication.h */
79 struct PublicationDesc;
80 extern void RelationBuildPublicationDesc(Relation relation,
81  struct PublicationDesc *pubdesc);
82 
83 extern void RelationInitTableAccessMethod(Relation relation);
84 
85 /*
86  * Routines to support ereport() reports of relation-related errors
87  */
88 extern int errtable(Relation rel);
89 extern int errtablecol(Relation rel, int attnum);
90 extern int errtablecolname(Relation rel, const char *colname);
91 extern int errtableconstraint(Relation rel, const char *conname);
92 
93 /*
94  * Routines for backend startup
95  */
96 extern void RelationCacheInitialize(void);
97 extern void RelationCacheInitializePhase2(void);
98 extern void RelationCacheInitializePhase3(void);
99 
100 /*
101  * Routine to create a relcache entry for an about-to-be-created relation
102  */
103 extern Relation RelationBuildLocalRelation(const char *relname,
104  Oid relnamespace,
105  TupleDesc tupDesc,
106  Oid relid,
107  Oid accessmtd,
108  RelFileNumber relfilenumber,
109  Oid reltablespace,
110  bool shared_relation,
111  bool mapped_relation,
112  char relpersistence,
113  char relkind);
114 
115 /*
116  * Routines to manage assignment of new relfilenumber to a relation
117  */
118 extern void RelationSetNewRelfilenumber(Relation relation, char persistence);
119 extern void RelationAssumeNewRelfilelocator(Relation relation);
120 
121 /*
122  * Routines for flushing/rebuilding relcache entries in various scenarios
123  */
124 extern void RelationForgetRelation(Oid rid);
125 
126 extern void RelationCacheInvalidateEntry(Oid relationId);
127 
128 extern void RelationCacheInvalidate(bool debug_discard);
129 
130 extern void RelationCloseSmgrByOid(Oid relationId);
131 
132 #ifdef USE_ASSERT_CHECKING
133 extern void AssertPendingSyncs_RelationCache(void);
134 #else
135 #define AssertPendingSyncs_RelationCache() do {} while (0)
136 #endif
137 extern void AtEOXact_RelationCache(bool isCommit);
138 extern void AtEOSubXact_RelationCache(bool isCommit, SubTransactionId mySubid,
139  SubTransactionId parentSubid);
140 
141 /*
142  * Routines to help manage rebuilding of relcache init files
143  */
144 extern bool RelationIdIsInInitFile(Oid relationId);
145 extern void RelationCacheInitFilePreInvalidate(void);
146 extern void RelationCacheInitFilePostInvalidate(void);
147 extern void RelationCacheInitFileRemove(void);
148 
149 /* should be used only by relcache.c and catcache.c */
151 
152 /* should be used only by relcache.c and postinit.c */
154 
155 #endif /* RELCACHE_H */
unsigned short uint16
Definition: c.h:489
#define PGDLLIMPORT
Definition: c.h:1321
uint32 SubTransactionId
Definition: c.h:640
int16 attnum
Definition: pg_attribute.h:74
NameData relname
Definition: pg_class.h:38
uintptr_t Datum
Definition: postgres.h:64
unsigned int Oid
Definition: postgres_ext.h:31
List * RelationGetIndexList(Relation relation)
Definition: relcache.c:4739
void RelationCacheInvalidate(bool debug_discard)
Definition: relcache.c:2933
struct RelationData * Relation
Definition: relcache.h:27
PGDLLIMPORT bool criticalRelcachesBuilt
Definition: relcache.c:140
Oid RelationGetPrimaryKeyIndex(Relation relation)
Definition: relcache.c:4927
int errtableconstraint(Relation rel, const char *conname)
Definition: relcache.c:5960
int errtablecol(Relation rel, int attnum)
Definition: relcache.c:5923
IndexAttrBitmapKind
Definition: relcache.h:58
@ INDEX_ATTR_BITMAP_KEY
Definition: relcache.h:59
@ INDEX_ATTR_BITMAP_HOT_BLOCKING
Definition: relcache.h:62
@ INDEX_ATTR_BITMAP_PRIMARY_KEY
Definition: relcache.h:60
@ INDEX_ATTR_BITMAP_SUMMARIZED
Definition: relcache.h:63
@ INDEX_ATTR_BITMAP_IDENTITY_KEY
Definition: relcache.h:61
PGDLLIMPORT bool criticalSharedRelcachesBuilt
Definition: relcache.c:146
void RelationInitIndexAccessInfo(Relation relation)
Definition: relcache.c:1417
List * RelationGetIndexPredicate(Relation relation)
Definition: relcache.c:5086
List * RelationGetStatExtList(Relation relation)
Definition: relcache.c:4858
void AtEOSubXact_RelationCache(bool isCommit, SubTransactionId mySubid, SubTransactionId parentSubid)
Definition: relcache.c:3329
void RelationCacheInitFilePostInvalidate(void)
Definition: relcache.c:6732
Bitmapset * RelationGetIndexAttrBitmap(Relation relation, IndexAttrBitmapKind attrKind)
Definition: relcache.c:5169
void RelationCacheInitializePhase3(void)
Definition: relcache.c:4039
List * RelationGetDummyIndexExpressions(Relation relation)
Definition: relcache.c:5032
List * RelationGetFKeyList(Relation relation)
Definition: relcache.c:4630
void RelationInitTableAccessMethod(Relation relation)
Definition: relcache.c:1801
void RelationBuildPublicationDesc(Relation relation, struct PublicationDesc *pubdesc)
Definition: relcache.c:5648
void RelationSetNewRelfilenumber(Relation relation, char persistence)
Definition: relcache.c:3709
#define AssertPendingSyncs_RelationCache()
Definition: relcache.h:135
Oid RelationGetReplicaIndex(Relation relation)
Definition: relcache.c:4948
Relation RelationIdGetRelation(Oid relationId)
Definition: relcache.c:2054
void AtEOXact_RelationCache(bool isCommit)
Definition: relcache.c:3177
void RelationForgetRelation(Oid rid)
Definition: relcache.c:2833
void RelationCacheInitialize(void)
Definition: relcache.c:3934
void RelationCacheInitFilePreInvalidate(void)
Definition: relcache.c:6707
Relation RelationBuildLocalRelation(const char *relname, Oid relnamespace, TupleDesc tupDesc, Oid relid, Oid accessmtd, RelFileNumber relfilenumber, Oid reltablespace, bool shared_relation, bool mapped_relation, char relpersistence, char relkind)
Definition: relcache.c:3466
void RelationAssumeNewRelfilelocator(Relation relation)
Definition: relcache.c:3908
void RelationCacheInitFileRemove(void)
Definition: relcache.c:6747
int errtablecolname(Relation rel, const char *colname)
Definition: relcache.c:5947
void RelationCacheInitializePhase2(void)
Definition: relcache.c:3980
bool RelationIdIsInInitFile(Oid relationId)
Definition: relcache.c:6667
int errtable(Relation rel)
Definition: relcache.c:5906
void RelationCacheInvalidateEntry(Oid relationId)
Definition: relcache.c:2877
bytea ** RelationGetIndexAttOptions(Relation relation, bool copy)
Definition: relcache.c:5845
Bitmapset * RelationGetIdentityKeyBitmap(Relation relation)
Definition: relcache.c:5442
Datum * RelationGetIndexRawAttOptions(Relation indexrel)
Definition: relcache.c:5799
void RelationCloseSmgrByOid(Oid relationId)
Definition: relcache.c:3042
void RelationGetExclusionInfo(Relation indexRelation, Oid **operators, Oid **procs, uint16 **strategies)
Definition: relcache.c:5516
Relation * RelationPtr
Definition: relcache.h:35
List * RelationGetIndexExpressions(Relation relation)
Definition: relcache.c:4973
void RelationClose(Relation relation)
Definition: relcache.c:2160
Oid RelFileNumber
Definition: relpath.h:25
Definition: pg_list.h:54
Definition: c.h:671