PostgreSQL Source Code git master
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Typedefs | Enumerations | Functions
amapi.h File Reference
#include "access/cmptype.h"
#include "access/genam.h"
#include "access/stratnum.h"
Include dependency graph for amapi.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  OpFamilyMember
 
struct  IndexAmRoutine
 

Typedefs

typedef enum IndexAMProperty IndexAMProperty
 
typedef struct OpFamilyMember OpFamilyMember
 
typedef CompareType(* amtranslate_strategy_function) (StrategyNumber strategy, Oid opfamily)
 
typedef StrategyNumber(* amtranslate_cmptype_function) (CompareType cmptype, Oid opfamily)
 
typedef IndexBuildResult *(* ambuild_function) (Relation heapRelation, Relation indexRelation, struct IndexInfo *indexInfo)
 
typedef void(* ambuildempty_function) (Relation indexRelation)
 
typedef bool(* aminsert_function) (Relation indexRelation, Datum *values, bool *isnull, ItemPointer heap_tid, Relation heapRelation, IndexUniqueCheck checkUnique, bool indexUnchanged, struct IndexInfo *indexInfo)
 
typedef void(* aminsertcleanup_function) (Relation indexRelation, struct IndexInfo *indexInfo)
 
typedef IndexBulkDeleteResult *(* ambulkdelete_function) (IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
 
typedef IndexBulkDeleteResult *(* amvacuumcleanup_function) (IndexVacuumInfo *info, IndexBulkDeleteResult *stats)
 
typedef bool(* amcanreturn_function) (Relation indexRelation, int attno)
 
typedef void(* amcostestimate_function) (struct PlannerInfo *root, struct IndexPath *path, double loop_count, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, double *indexCorrelation, double *indexPages)
 
typedef int(* amgettreeheight_function) (Relation rel)
 
typedef bytea *(* amoptions_function) (Datum reloptions, bool validate)
 
typedef bool(* amproperty_function) (Oid index_oid, int attno, IndexAMProperty prop, const char *propname, bool *res, bool *isnull)
 
typedef char *(* ambuildphasename_function) (int64 phasenum)
 
typedef bool(* amvalidate_function) (Oid opclassoid)
 
typedef void(* amadjustmembers_function) (Oid opfamilyoid, Oid opclassoid, List *operators, List *functions)
 
typedef IndexScanDesc(* ambeginscan_function) (Relation indexRelation, int nkeys, int norderbys)
 
typedef void(* amrescan_function) (IndexScanDesc scan, ScanKey keys, int nkeys, ScanKey orderbys, int norderbys)
 
typedef bool(* amgettuple_function) (IndexScanDesc scan, ScanDirection direction)
 
typedef int64(* amgetbitmap_function) (IndexScanDesc scan, TIDBitmap *tbm)
 
typedef void(* amendscan_function) (IndexScanDesc scan)
 
typedef void(* ammarkpos_function) (IndexScanDesc scan)
 
typedef void(* amrestrpos_function) (IndexScanDesc scan)
 
typedef Size(* amestimateparallelscan_function) (Relation indexRelation, int nkeys, int norderbys)
 
typedef void(* aminitparallelscan_function) (void *target)
 
typedef void(* amparallelrescan_function) (IndexScanDesc scan)
 
typedef struct IndexAmRoutine IndexAmRoutine
 

Enumerations

enum  IndexAMProperty {
  AMPROP_UNKNOWN = 0 , AMPROP_ASC , AMPROP_DESC , AMPROP_NULLS_FIRST ,
  AMPROP_NULLS_LAST , AMPROP_ORDERABLE , AMPROP_DISTANCE_ORDERABLE , AMPROP_RETURNABLE ,
  AMPROP_SEARCH_ARRAY , AMPROP_SEARCH_NULLS , AMPROP_CLUSTERABLE , AMPROP_INDEX_SCAN ,
  AMPROP_BITMAP_SCAN , AMPROP_BACKWARD_SCAN , AMPROP_CAN_ORDER , AMPROP_CAN_UNIQUE ,
  AMPROP_CAN_MULTI_COL , AMPROP_CAN_EXCLUDE , AMPROP_CAN_INCLUDE
}
 

Functions

IndexAmRoutine * GetIndexAmRoutine (Oid amhandler)
 
IndexAmRoutine * GetIndexAmRoutineByAmId (Oid amoid, bool noerror)
 
CompareType IndexAmTranslateStrategy (StrategyNumber strategy, Oid amoid, Oid opfamily, bool missing_ok)
 
StrategyNumber IndexAmTranslateCompareType (CompareType cmptype, Oid amoid, Oid opfamily, bool missing_ok)
 

Typedef Documentation

◆ amadjustmembers_function

typedef void(* amadjustmembers_function) (Oid opfamilyoid, Oid opclassoid, List *operators,List *functions)

Definition at line 178 of file amapi.h.

◆ ambeginscan_function

typedef IndexScanDesc(* ambeginscan_function) (Relation indexRelation, int nkeys, int norderbys)

Definition at line 184 of file amapi.h.

◆ ambuild_function

typedef IndexBuildResult *(* ambuild_function) (Relation heapRelation, Relation indexRelation, struct IndexInfo *indexInfo)

Definition at line 111 of file amapi.h.

◆ ambuildempty_function

typedef void(* ambuildempty_function) (Relation indexRelation)

Definition at line 116 of file amapi.h.

◆ ambuildphasename_function

typedef char *(* ambuildphasename_function) (int64 phasenum)

Definition at line 172 of file amapi.h.

◆ ambulkdelete_function

typedef IndexBulkDeleteResult *(* ambulkdelete_function) (IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)

Definition at line 133 of file amapi.h.

◆ amcanreturn_function

typedef bool(* amcanreturn_function) (Relation indexRelation, int attno)

Definition at line 143 of file amapi.h.

◆ amcostestimate_function

typedef void(* amcostestimate_function) (struct PlannerInfo *root, struct IndexPath *path, double loop_count, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, double *indexCorrelation, double *indexPages)

Definition at line 146 of file amapi.h.

◆ amendscan_function

typedef void(* amendscan_function) (IndexScanDesc scan)

Definition at line 204 of file amapi.h.

◆ amestimateparallelscan_function

typedef Size(* amestimateparallelscan_function) (Relation indexRelation, int nkeys, int norderbys)

Definition at line 217 of file amapi.h.

◆ amgetbitmap_function

typedef int64(* amgetbitmap_function) (IndexScanDesc scan, TIDBitmap *tbm)

Definition at line 200 of file amapi.h.

◆ amgettreeheight_function

typedef int(* amgettreeheight_function) (Relation rel)

Definition at line 160 of file amapi.h.

◆ amgettuple_function

typedef bool(* amgettuple_function) (IndexScanDesc scan, ScanDirection direction)

Definition at line 196 of file amapi.h.

◆ aminitparallelscan_function

typedef void(* aminitparallelscan_function) (void *target)

Definition at line 221 of file amapi.h.

◆ aminsert_function

typedef bool(* aminsert_function) (Relation indexRelation, Datum *values, bool *isnull, ItemPointer heap_tid, Relation heapRelation, IndexUniqueCheck checkUnique, bool indexUnchanged, struct IndexInfo *indexInfo)

Definition at line 119 of file amapi.h.

◆ aminsertcleanup_function

typedef void(* aminsertcleanup_function) (Relation indexRelation, struct IndexInfo *indexInfo)

Definition at line 129 of file amapi.h.

◆ ammarkpos_function

typedef void(* ammarkpos_function) (IndexScanDesc scan)

Definition at line 207 of file amapi.h.

◆ amoptions_function

typedef bytea *(* amoptions_function) (Datum reloptions, bool validate)

Definition at line 163 of file amapi.h.

◆ amparallelrescan_function

typedef void(* amparallelrescan_function) (IndexScanDesc scan)

Definition at line 224 of file amapi.h.

◆ amproperty_function

typedef bool(* amproperty_function) (Oid index_oid, int attno, IndexAMProperty prop, const char *propname, bool *res, bool *isnull)

Definition at line 167 of file amapi.h.

◆ amrescan_function

typedef void(* amrescan_function) (IndexScanDesc scan, ScanKey keys, int nkeys, ScanKey orderbys, int norderbys)

Definition at line 189 of file amapi.h.

◆ amrestrpos_function

typedef void(* amrestrpos_function) (IndexScanDesc scan)

Definition at line 210 of file amapi.h.

◆ amtranslate_cmptype_function

typedef StrategyNumber(* amtranslate_cmptype_function) (CompareType cmptype, Oid opfamily)

Definition at line 108 of file amapi.h.

◆ amtranslate_strategy_function

typedef CompareType(* amtranslate_strategy_function) (StrategyNumber strategy, Oid opfamily)

Definition at line 105 of file amapi.h.

◆ amvacuumcleanup_function

typedef IndexBulkDeleteResult *(* amvacuumcleanup_function) (IndexVacuumInfo *info, IndexBulkDeleteResult *stats)

Definition at line 139 of file amapi.h.

◆ amvalidate_function

typedef bool(* amvalidate_function) (Oid opclassoid)

Definition at line 175 of file amapi.h.

◆ IndexAMProperty

typedef enum IndexAMProperty IndexAMProperty

◆ IndexAmRoutine

typedef struct IndexAmRoutine IndexAmRoutine

◆ OpFamilyMember

typedef struct OpFamilyMember OpFamilyMember

Enumeration Type Documentation

◆ IndexAMProperty

enum IndexAMProperty
Enumerator
AMPROP_UNKNOWN 
AMPROP_ASC 
AMPROP_DESC 
AMPROP_NULLS_FIRST 
AMPROP_NULLS_LAST 
AMPROP_ORDERABLE 
AMPROP_DISTANCE_ORDERABLE 
AMPROP_RETURNABLE 
AMPROP_SEARCH_ARRAY 
AMPROP_SEARCH_NULLS 
AMPROP_CLUSTERABLE 
AMPROP_INDEX_SCAN 
AMPROP_BITMAP_SCAN 
AMPROP_BACKWARD_SCAN 
AMPROP_CAN_ORDER 
AMPROP_CAN_UNIQUE 
AMPROP_CAN_MULTI_COL 
AMPROP_CAN_EXCLUDE 
AMPROP_CAN_INCLUDE 

Definition at line 36 of file amapi.h.

37{
38 AMPROP_UNKNOWN = 0, /* anything not known to core code */
39 AMPROP_ASC, /* column properties */
40 AMPROP_DESC,
41 AMPROP_NULLS_FIRST,
42 AMPROP_NULLS_LAST,
43 AMPROP_ORDERABLE,
44 AMPROP_DISTANCE_ORDERABLE,
45 AMPROP_RETURNABLE,
46 AMPROP_SEARCH_ARRAY,
47 AMPROP_SEARCH_NULLS,
48 AMPROP_CLUSTERABLE, /* index properties */
49 AMPROP_INDEX_SCAN,
50 AMPROP_BITMAP_SCAN,
51 AMPROP_BACKWARD_SCAN,
52 AMPROP_CAN_ORDER, /* AM properties */
53 AMPROP_CAN_UNIQUE,
54 AMPROP_CAN_MULTI_COL,
55 AMPROP_CAN_EXCLUDE,
56 AMPROP_CAN_INCLUDE,
57} IndexAMProperty;
IndexAMProperty
IndexAMProperty
Definition: amapi.h:37
AMPROP_BACKWARD_SCAN
@ AMPROP_BACKWARD_SCAN
Definition: amapi.h:51
AMPROP_SEARCH_ARRAY
@ AMPROP_SEARCH_ARRAY
Definition: amapi.h:46
AMPROP_CAN_MULTI_COL
@ AMPROP_CAN_MULTI_COL
Definition: amapi.h:54
AMPROP_CAN_ORDER
@ AMPROP_CAN_ORDER
Definition: amapi.h:52
AMPROP_ORDERABLE
@ AMPROP_ORDERABLE
Definition: amapi.h:43
AMPROP_ASC
@ AMPROP_ASC
Definition: amapi.h:39
AMPROP_DISTANCE_ORDERABLE
@ AMPROP_DISTANCE_ORDERABLE
Definition: amapi.h:44
AMPROP_CAN_INCLUDE
@ AMPROP_CAN_INCLUDE
Definition: amapi.h:56
AMPROP_SEARCH_NULLS
@ AMPROP_SEARCH_NULLS
Definition: amapi.h:47
AMPROP_CAN_EXCLUDE
@ AMPROP_CAN_EXCLUDE
Definition: amapi.h:55
AMPROP_UNKNOWN
@ AMPROP_UNKNOWN
Definition: amapi.h:38
AMPROP_CAN_UNIQUE
@ AMPROP_CAN_UNIQUE
Definition: amapi.h:53
AMPROP_DESC
@ AMPROP_DESC
Definition: amapi.h:40
AMPROP_NULLS_LAST
@ AMPROP_NULLS_LAST
Definition: amapi.h:42
AMPROP_INDEX_SCAN
@ AMPROP_INDEX_SCAN
Definition: amapi.h:49
AMPROP_NULLS_FIRST
@ AMPROP_NULLS_FIRST
Definition: amapi.h:41
AMPROP_CLUSTERABLE
@ AMPROP_CLUSTERABLE
Definition: amapi.h:48
AMPROP_RETURNABLE
@ AMPROP_RETURNABLE
Definition: amapi.h:45
AMPROP_BITMAP_SCAN
@ AMPROP_BITMAP_SCAN
Definition: amapi.h:50

Function Documentation

◆ GetIndexAmRoutine()

IndexAmRoutine * GetIndexAmRoutine ( Oid  amhandler)

Definition at line 33 of file amapi.c.

34{
35 Datum datum;
36 IndexAmRoutine *routine;
37
38 datum = OidFunctionCall0(amhandler);
39 routine = (IndexAmRoutine *) DatumGetPointer(datum);
40
41 if (routine == NULL || !IsA(routine, IndexAmRoutine))
42 elog(ERROR, "index access method handler function %u did not return an IndexAmRoutine struct",
43 amhandler);
44
45 return routine;
46}
ERROR
#define ERROR
Definition: elog.h:39
elog
#define elog(elevel,...)
Definition: elog.h:226
OidFunctionCall0
#define OidFunctionCall0(functionId)
Definition: fmgr.h:718
IsA
#define IsA(nodeptr, _type_)
Definition: nodes.h:164
Datum
uintptr_t Datum
Definition: postgres.h:69
DatumGetPointer
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:317

References DatumGetPointer(), elog, ERROR, IsA, and OidFunctionCall0.

Referenced by CheckIndexCompatible(), DefineIndex(), GetIndexAmRoutineByAmId(), InitIndexAmRoutine(), and pg_get_indexdef_worker().

◆ GetIndexAmRoutineByAmId()

IndexAmRoutine * GetIndexAmRoutineByAmId ( Oid  amoid,
bool  noerror 
)

Definition at line 56 of file amapi.c.

57{
58 HeapTuple tuple;
59 Form_pg_am amform;
60 regproc amhandler;
61
62 /* Get handler function OID for the access method */
63 tuple = SearchSysCache1(AMOID, ObjectIdGetDatum(amoid));
64 if (!HeapTupleIsValid(tuple))
65 {
66 if (noerror)
67 return NULL;
68 elog(ERROR, "cache lookup failed for access method %u",
69 amoid);
70 }
71 amform = (Form_pg_am) GETSTRUCT(tuple);
72
73 /* Check if it's an index access method as opposed to some other AM */
74 if (amform->amtype != AMTYPE_INDEX)
75 {
76 if (noerror)
77 {
78 ReleaseSysCache(tuple);
79 return NULL;
80 }
81 ereport(ERROR,
82 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
83 errmsg("access method \"%s\" is not of type %s",
84 NameStr(amform->amname), "INDEX")));
85 }
86
87 amhandler = amform->amhandler;
88
89 /* Complain if handler OID is invalid */
90 if (!RegProcedureIsValid(amhandler))
91 {
92 if (noerror)
93 {
94 ReleaseSysCache(tuple);
95 return NULL;
96 }
97 ereport(ERROR,
98 (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
99 errmsg("index access method \"%s\" does not have a handler",
100 NameStr(amform->amname))));
101 }
102
103 ReleaseSysCache(tuple);
104
105 /* And finally, call the handler function to get the API struct. */
106 return GetIndexAmRoutine(amhandler);
107}
GetIndexAmRoutine
IndexAmRoutine * GetIndexAmRoutine(Oid amhandler)
Definition: amapi.c:33
NameStr
#define NameStr(name)
Definition: c.h:717
RegProcedureIsValid
#define RegProcedureIsValid(p)
Definition: c.h:748
regproc
Oid regproc
Definition: c.h:620
errcode
int errcode(int sqlerrcode)
Definition: elog.c:854
errmsg
int errmsg(const char *fmt,...)
Definition: elog.c:1071
ereport
#define ereport(elevel,...)
Definition: elog.h:149
HeapTupleIsValid
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
GETSTRUCT
static void * GETSTRUCT(const HeapTupleData *tuple)
Definition: htup_details.h:728
Form_pg_am
FormData_pg_am * Form_pg_am
Definition: pg_am.h:48
ObjectIdGetDatum
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:257
ReleaseSysCache
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:269
SearchSysCache1
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:221

References elog, ereport, errcode(), errmsg(), ERROR, GetIndexAmRoutine(), GETSTRUCT(), HeapTupleIsValid, NameStr, ObjectIdGetDatum(), RegProcedureIsValid, ReleaseSysCache(), and SearchSysCache1().

Referenced by AlterOpFamily(), AlterOpFamilyAdd(), amvalidate(), assignOperTypes(), assignProcTypes(), comparison_ops_are_compatible(), ConstructTupleDescriptor(), DefineOpClass(), equality_ops_are_compatible(), get_op_index_interpretation(), get_opmethod_canorder(), indexam_property(), IndexAmTranslateCompareType(), IndexAmTranslateStrategy(), IndexSupportsBackwardScan(), IsIndexUsableForReplicaIdentityFull(), and pg_indexam_progress_phasename().

◆ IndexAmTranslateCompareType()

StrategyNumber IndexAmTranslateCompareType ( CompareType  cmptype,
Oid  amoid,
Oid  opfamily,
bool  missing_ok 
)

Definition at line 148 of file amapi.c.

149{
150 StrategyNumber result;
151 IndexAmRoutine *amroutine;
152
153 /* shortcut for common case */
154 if (amoid == BTREE_AM_OID &&
155 (cmptype > COMPARE_INVALID && cmptype <= COMPARE_GT))
156 return (StrategyNumber) cmptype;
157
158 amroutine = GetIndexAmRoutineByAmId(amoid, false);
159 if (amroutine->amtranslatecmptype)
160 result = amroutine->amtranslatecmptype(cmptype, opfamily);
161 else
162 result = InvalidStrategy;
163
164 if (!missing_ok && result == InvalidStrategy)
165 elog(ERROR, "could not translate compare type %u for index AM %u", cmptype, amoid);
166
167 return result;
168}
GetIndexAmRoutineByAmId
IndexAmRoutine * GetIndexAmRoutineByAmId(Oid amoid, bool noerror)
Definition: amapi.c:56
COMPARE_INVALID
@ COMPARE_INVALID
Definition: cmptype.h:33
COMPARE_GT
@ COMPARE_GT
Definition: cmptype.h:38
StrategyNumber
uint16 StrategyNumber
Definition: stratnum.h:22
InvalidStrategy
#define InvalidStrategy
Definition: stratnum.h:24
IndexAmRoutine::amtranslatecmptype
amtranslate_cmptype_function amtranslatecmptype
Definition: amapi.h:322

References IndexAmRoutine::amtranslatecmptype, COMPARE_GT, COMPARE_INVALID, elog, ERROR, GetIndexAmRoutineByAmId(), and InvalidStrategy.

Referenced by ATAddForeignKeyConstraint(), build_replindex_scan_key(), BuildSpeculativeIndexInfo(), get_opfamily_member_for_cmptype(), GetOperatorFromCompareType(), IsIndexUsableForReplicaIdentityFull(), and mergejoinscansel().

◆ IndexAmTranslateStrategy()

CompareType IndexAmTranslateStrategy ( StrategyNumber  strategy,
Oid  amoid,
Oid  opfamily,
bool  missing_ok 
)

Definition at line 118 of file amapi.c.

119{
120 CompareType result;
121 IndexAmRoutine *amroutine;
122
123 /* shortcut for common case */
124 if (amoid == BTREE_AM_OID &&
125 (strategy > InvalidStrategy && strategy <= BTMaxStrategyNumber))
126 return (CompareType) strategy;
127
128 amroutine = GetIndexAmRoutineByAmId(amoid, false);
129 if (amroutine->amtranslatestrategy)
130 result = amroutine->amtranslatestrategy(strategy, opfamily);
131 else
132 result = COMPARE_INVALID;
133
134 if (!missing_ok && result == COMPARE_INVALID)
135 elog(ERROR, "could not translate strategy number %d for index AM %u", strategy, amoid);
136
137 return result;
138}
CompareType
CompareType
Definition: cmptype.h:32
BTMaxStrategyNumber
#define BTMaxStrategyNumber
Definition: stratnum.h:35
IndexAmRoutine::amtranslatestrategy
amtranslate_strategy_function amtranslatestrategy
Definition: amapi.h:321

References IndexAmRoutine::amtranslatestrategy, BTMaxStrategyNumber, COMPARE_INVALID, elog, ERROR, GetIndexAmRoutineByAmId(), and InvalidStrategy.

Referenced by get_actual_variable_range(), get_mergejoin_opfamilies(), get_op_index_interpretation(), get_ordering_op_for_equality_op(), get_ordering_op_properties(), mergejoinscansel(), and MJExamineQuals().