mirror of
https://github.com/postgres/postgres.git
synced 2026-02-24 02:11:28 -05:00
911e702077
PostgreSQL provides set of template index access methods, where opclasses have much freedom in the semantics of indexing. These index AMs are GiST, GIN, SP-GiST and BRIN. There opclasses define representation of keys, operations on them and supported search strategies. So, it's natural that opclasses may be faced some tradeoffs, which require user-side decision. This commit implements opclass parameters allowing users to set some values, which tell opclass how to index the particular dataset. This commit doesn't introduce new storage in system catalog. Instead it uses pg_attribute.attoptions, which is used for table column storage options but unused for index attributes. In order to evade changing signature of each opclass support function, we implement unified way to pass options to opclass support functions. Options are set to fn_expr as the constant bytea expression. It's possible due to the fact that opclass support functions are executed outside of expressions, so fn_expr is unused for them. This commit comes with some examples of opclass options usage. We parametrize signature length in GiST. That applies to multiple opclasses: tsvector_ops, gist__intbig_ops, gist_ltree_ops, gist__ltree_ops, gist_trgm_ops and gist_hstore_ops. Also we parametrize maximum number of integer ranges for gist__int_ops. However, the main future usage of this feature is expected to be json, where users would be able to specify which way to index particular json parts. Catversion is bumped. Discussion: https://postgr.es/m/d22c3a18-31c7-1879-fc11-4c1ce2f5e5af%40postgrespro.ru Author: Nikita Glukhov, revised by me Reviwed-by: Nikolay Shaplov, Robert Haas, Tom Lane, Tomas Vondra, Alvaro Herrera
145 lines
4.4 KiB
C
145 lines
4.4 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* relcache.h
|
|
* Relation descriptor cache definitions.
|
|
*
|
|
*
|
|
* Portions Copyright (c) 1996-2020, 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 "postgres.h"
|
|
#include "access/tupdesc.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
|
|
*/
|
|
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);
|
|
extern Oid RelationGetReplicaIndex(Relation relation);
|
|
extern List *RelationGetIndexExpressions(Relation relation);
|
|
extern List *RelationGetDummyIndexExpressions(Relation relation);
|
|
extern List *RelationGetIndexPredicate(Relation relation);
|
|
extern Datum *RelationGetIndexRawAttOptions(Relation relation);
|
|
extern bytea **RelationGetIndexAttOptions(Relation relation, bool copy);
|
|
|
|
typedef enum IndexAttrBitmapKind
|
|
{
|
|
INDEX_ATTR_BITMAP_ALL,
|
|
INDEX_ATTR_BITMAP_KEY,
|
|
INDEX_ATTR_BITMAP_PRIMARY_KEY,
|
|
INDEX_ATTR_BITMAP_IDENTITY_KEY
|
|
} IndexAttrBitmapKind;
|
|
|
|
extern Bitmapset *RelationGetIndexAttrBitmap(Relation relation,
|
|
IndexAttrBitmapKind attrKind);
|
|
|
|
extern void RelationGetExclusionInfo(Relation indexRelation,
|
|
Oid **operators,
|
|
Oid **procs,
|
|
uint16 **strategies);
|
|
|
|
extern void RelationInitIndexAccessInfo(Relation relation);
|
|
|
|
/* caller must include pg_publication.h */
|
|
struct PublicationActions;
|
|
extern struct PublicationActions *GetRelationPublicationActions(Relation relation);
|
|
|
|
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,
|
|
Oid relfilenode,
|
|
Oid reltablespace,
|
|
bool shared_relation,
|
|
bool mapped_relation,
|
|
char relpersistence,
|
|
char relkind);
|
|
|
|
/*
|
|
* Routine to manage assignment of new relfilenode to a relation
|
|
*/
|
|
extern void RelationSetNewRelfilenode(Relation relation, char persistence);
|
|
|
|
/*
|
|
* Routines for flushing/rebuilding relcache entries in various scenarios
|
|
*/
|
|
extern void RelationForgetRelation(Oid rid);
|
|
|
|
extern void RelationCacheInvalidateEntry(Oid relationId);
|
|
|
|
extern void RelationCacheInvalidate(void);
|
|
|
|
extern void RelationCloseSmgrByOid(Oid relationId);
|
|
|
|
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 bool criticalRelcachesBuilt;
|
|
|
|
/* should be used only by relcache.c and postinit.c */
|
|
extern bool criticalSharedRelcachesBuilt;
|
|
|
|
#endif /* RELCACHE_H */
|