relcache.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * relcache.h
 *    Relation descriptor cache definitions.
 *
 *
 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/utils/relcache.h
 *
 *-------------------------------------------------------------------------
 */
#ifndef RELCACHE_H
#define RELCACHE_H
 
#include "access/tupdesc.h"
#include "common/relpath.h"
#include "nodes/bitmapset.h"
 
 
/*
 * Name of relcache init file(s), used to speed up backend startup
 */
#define RELCACHE_INIT_FILENAME  "pg_internal.init"
 
typedef struct RelationData *Relation;
 
/* ----------------
 *      RelationPtr is used in the executor to support index scans
 *      where we have to keep track of several index relations in an
 *      array.  -cim 9/10/89
 * ----------------
 */
typedef Relation *RelationPtr;
 
/*
 * Routines to open (lookup) and close a relcache entry
 */
#ifdef USE_ASSERT_CHECKING
extern void AssertCouldGetRelation(void);
#else
static inline void
AssertCouldGetRelation(void)
{
}
#endif
extern Relation RelationIdGetRelation(Oid relationId);
extern void RelationClose(Relation relation);
 
/*
 * Routines to compute/retrieve additional cached information
 */
extern List *RelationGetFKeyList(Relation relation);
extern List *RelationGetIndexList(Relation relation);
extern List *RelationGetStatExtList(Relation relation);
extern Oid  RelationGetPrimaryKeyIndex(Relation relation, bool deferrable_ok);
extern Oid  RelationGetReplicaIndex(Relation relation);
extern List *RelationGetIndexExpressions(Relation relation);
extern List *RelationGetDummyIndexExpressions(Relation relation);
extern List *RelationGetIndexPredicate(Relation relation);
extern bytea **RelationGetIndexAttOptions(Relation relation, bool copy);
 
/*
 * Which set of columns to return by RelationGetIndexAttrBitmap.
 */
typedef enum IndexAttrBitmapKind
{
    INDEX_ATTR_BITMAP_KEY,
    INDEX_ATTR_BITMAP_PRIMARY_KEY,
    INDEX_ATTR_BITMAP_IDENTITY_KEY,
    INDEX_ATTR_BITMAP_HOT_BLOCKING,
    INDEX_ATTR_BITMAP_SUMMARIZED,
} IndexAttrBitmapKind;
 
extern Bitmapset *RelationGetIndexAttrBitmap(Relation relation,
                                             IndexAttrBitmapKind attrKind);
 
extern Bitmapset *RelationGetIdentityKeyBitmap(Relation relation);
 
extern void RelationGetExclusionInfo(Relation indexRelation,
                                     Oid **operators,
                                     Oid **procs,
                                     uint16 **strategies);
 
extern void RelationInitIndexAccessInfo(Relation relation);
 
/* caller must include pg_publication.h */
struct PublicationDesc;
extern void RelationBuildPublicationDesc(Relation relation,
                                         struct PublicationDesc *pubdesc);
 
extern void RelationInitTableAccessMethod(Relation relation);
 
/*
 * Routines to support ereport() reports of relation-related errors
 */
extern int  errtable(Relation rel);
extern int  errtablecol(Relation rel, int attnum);
extern int  errtablecolname(Relation rel, const char *colname);
extern int  errtableconstraint(Relation rel, const char *conname);
 
/*
 * Routines for backend startup
 */
extern void RelationCacheInitialize(void);
extern void RelationCacheInitializePhase2(void);
extern void RelationCacheInitializePhase3(void);
 
/*
 * Routine to create a relcache entry for an about-to-be-created relation
 */
extern 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);
 
/*
 * Routines to manage assignment of new relfilenumber to a relation
 */
extern void RelationSetNewRelfilenumber(Relation relation, char persistence);
extern void RelationAssumeNewRelfilelocator(Relation relation);
 
/*
 * Routines for flushing/rebuilding relcache entries in various scenarios
 */
extern void RelationForgetRelation(Oid rid);
 
extern void RelationCacheInvalidateEntry(Oid relationId);
 
extern void RelationCacheInvalidate(bool debug_discard);
 
#ifdef USE_ASSERT_CHECKING
extern void AssertPendingSyncs_RelationCache(void);
#else
#define AssertPendingSyncs_RelationCache() do {} while (0)
#endif
extern void AtEOXact_RelationCache(bool isCommit);
extern void AtEOSubXact_RelationCache(bool isCommit, SubTransactionId mySubid,
                                      SubTransactionId parentSubid);
 
/*
 * Routines to help manage rebuilding of relcache init files
 */
extern bool RelationIdIsInInitFile(Oid relationId);
extern void RelationCacheInitFilePreInvalidate(void);
extern void RelationCacheInitFilePostInvalidate(void);
extern void RelationCacheInitFileRemove(void);
 
/* should be used only by relcache.c and catcache.c */
extern PGDLLIMPORT bool criticalRelcachesBuilt;
 
/* should be used only by relcache.c and postinit.c */
extern PGDLLIMPORT bool criticalSharedRelcachesBuilt;
 
#endif                          /* RELCACHE_H */