amapi.h File Reference

#include "access/cmptype.h"
#include "access/genam.h"
#include "access/stratnum.h"
#include "nodes/nodes.h"
#include "nodes/pg_list.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 struct PlannerInfo	PlannerInfo
typedef struct IndexPath	IndexPath
typedef struct IndexInfo	IndexInfo
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, 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, IndexInfo *indexInfo)
typedef void(*	aminsertcleanup_function) (Relation indexRelation, 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) (PlannerInfo *root, 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 180 of file amapi.h.

ambeginscan_function

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

Definition at line 186 of file amapi.h.

ambuild_function

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

Definition at line 113 of file amapi.h.

ambuildempty_function

typedef void(* ambuildempty_function) (Relation indexRelation)

Definition at line 118 of file amapi.h.

ambuildphasename_function

typedef char *(* ambuildphasename_function) (int64 phasenum)

Definition at line 174 of file amapi.h.

ambulkdelete_function

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

Definition at line 135 of file amapi.h.

amcanreturn_function

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

Definition at line 145 of file amapi.h.

amcostestimate_function

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

Definition at line 148 of file amapi.h.

amendscan_function

typedef void(* amendscan_function) (IndexScanDesc scan)

Definition at line 206 of file amapi.h.

amestimateparallelscan_function

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

Definition at line 219 of file amapi.h.

amgetbitmap_function

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

Definition at line 202 of file amapi.h.

amgettreeheight_function

typedef int(* amgettreeheight_function) (Relation rel)

Definition at line 162 of file amapi.h.

amgettuple_function

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

Definition at line 198 of file amapi.h.

aminitparallelscan_function

typedef void(* aminitparallelscan_function) (void *target)

Definition at line 223 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, IndexInfo *indexInfo)

Definition at line 121 of file amapi.h.

aminsertcleanup_function

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

Definition at line 131 of file amapi.h.

ammarkpos_function

typedef void(* ammarkpos_function) (IndexScanDesc scan)

Definition at line 209 of file amapi.h.

amoptions_function

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

Definition at line 165 of file amapi.h.

amparallelrescan_function

typedef void(* amparallelrescan_function) (IndexScanDesc scan)

Definition at line 226 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 169 of file amapi.h.

amrescan_function

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

Definition at line 191 of file amapi.h.

amrestrpos_function

typedef void(* amrestrpos_function) (IndexScanDesc scan)

Definition at line 212 of file amapi.h.

amtranslate_cmptype_function

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

Definition at line 110 of file amapi.h.

amtranslate_strategy_function

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

Definition at line 107 of file amapi.h.

amvacuumcleanup_function

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

Definition at line 141 of file amapi.h.

amvalidate_function

typedef bool(* amvalidate_function) (Oid opclassoid)

Definition at line 177 of file amapi.h.

IndexAMProperty

typedef enum IndexAMProperty IndexAMProperty

IndexAmRoutine

typedef struct IndexAmRoutine IndexAmRoutine

IndexInfo

typedef struct IndexInfo IndexInfo

Definition at line 30 of file amapi.h.

IndexPath

typedef struct IndexPath IndexPath

Definition at line 27 of file amapi.h.

OpFamilyMember

typedef struct OpFamilyMember OpFamilyMember

PlannerInfo

typedef struct PlannerInfo PlannerInfo

Definition at line 26 of file amapi.h.

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 38 of file amapi.h.

{
    AMPROP_UNKNOWN = 0,         /* anything not known to core code */
    AMPROP_ASC,                 /* column properties */
    AMPROP_DESC,
    AMPROP_NULLS_FIRST,
    AMPROP_NULLS_LAST,
    AMPROP_ORDERABLE,
    AMPROP_DISTANCE_ORDERABLE,
    AMPROP_RETURNABLE,
    AMPROP_SEARCH_ARRAY,
    AMPROP_SEARCH_NULLS,
    AMPROP_CLUSTERABLE,         /* index properties */
    AMPROP_INDEX_SCAN,
    AMPROP_BITMAP_SCAN,
    AMPROP_BACKWARD_SCAN,
    AMPROP_CAN_ORDER,           /* AM properties */
    AMPROP_CAN_UNIQUE,
    AMPROP_CAN_MULTI_COL,
    AMPROP_CAN_EXCLUDE,
    AMPROP_CAN_INCLUDE,
} IndexAMProperty;

Function Documentation

GetIndexAmRoutine()

IndexAmRoutine * GetIndexAmRoutine

(

Oid

amhandler

)

Definition at line 33 of file amapi.c.

{
    Datum       datum;
    IndexAmRoutine *routine;
 
    datum = OidFunctionCall0(amhandler);
    routine = (IndexAmRoutine *) DatumGetPointer(datum);
 
    if (routine == NULL || !IsA(routine, IndexAmRoutine))
        elog(ERROR, "index access method handler function %u did not return an IndexAmRoutine struct",
             amhandler);
 
    /* Assert that all required callbacks are present. */
    Assert(routine->ambuild != NULL);
    Assert(routine->ambuildempty != NULL);
    Assert(routine->aminsert != NULL);
    Assert(routine->ambulkdelete != NULL);
    Assert(routine->amvacuumcleanup != NULL);
    Assert(routine->amcostestimate != NULL);
    Assert(routine->amoptions != NULL);
    Assert(routine->amvalidate != NULL);
    Assert(routine->ambeginscan != NULL);
    Assert(routine->amrescan != NULL);
    Assert(routine->amendscan != NULL);
 
    return routine;
}

References IndexAmRoutine::ambeginscan, IndexAmRoutine::ambuild, IndexAmRoutine::ambuildempty, IndexAmRoutine::ambulkdelete, IndexAmRoutine::amcostestimate, IndexAmRoutine::amendscan, IndexAmRoutine::aminsert, IndexAmRoutine::amoptions, IndexAmRoutine::amrescan, IndexAmRoutine::amvacuumcleanup, IndexAmRoutine::amvalidate, Assert(), 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 69 of file amapi.c.

{
    HeapTuple   tuple;
    Form_pg_am  amform;
    regproc     amhandler;
 
    /* Get handler function OID for the access method */
    tuple = SearchSysCache1(AMOID, ObjectIdGetDatum(amoid));
    if (!HeapTupleIsValid(tuple))
    {
        if (noerror)
            return NULL;
        elog(ERROR, "cache lookup failed for access method %u",
             amoid);
    }
    amform = (Form_pg_am) GETSTRUCT(tuple);
 
    /* Check if it's an index access method as opposed to some other AM */
    if (amform->amtype != AMTYPE_INDEX)
    {
        if (noerror)
        {
            ReleaseSysCache(tuple);
            return NULL;
        }
        ereport(ERROR,
                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                 errmsg("access method \"%s\" is not of type %s",
                        NameStr(amform->amname), "INDEX")));
    }
 
    amhandler = amform->amhandler;
 
    /* Complain if handler OID is invalid */
    if (!RegProcedureIsValid(amhandler))
    {
        if (noerror)
        {
            ReleaseSysCache(tuple);
            return NULL;
        }
        ereport(ERROR,
                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                 errmsg("index access method \"%s\" does not have a handler",
                        NameStr(amform->amname))));
    }
 
    ReleaseSysCache(tuple);
 
    /* And finally, call the handler function to get the API struct. */
    return GetIndexAmRoutine(amhandler);
}

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 161 of file amapi.c.

{
    StrategyNumber result;
    IndexAmRoutine *amroutine;
 
    /* shortcut for common case */
    if (amoid == BTREE_AM_OID &&
        (cmptype > COMPARE_INVALID && cmptype <= COMPARE_GT))
        return (StrategyNumber) cmptype;
 
    amroutine = GetIndexAmRoutineByAmId(amoid, false);
    if (amroutine->amtranslatecmptype)
        result = amroutine->amtranslatecmptype(cmptype, opfamily);
    else
        result = InvalidStrategy;
 
    if (!missing_ok && result == InvalidStrategy)
        elog(ERROR, "could not translate compare type %u for index AM %u", cmptype, amoid);
 
    return result;
}

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 131 of file amapi.c.

{
    CompareType result;
    IndexAmRoutine *amroutine;
 
    /* shortcut for common case */
    if (amoid == BTREE_AM_OID &&
        (strategy > InvalidStrategy && strategy <= BTMaxStrategyNumber))
        return (CompareType) strategy;
 
    amroutine = GetIndexAmRoutineByAmId(amoid, false);
    if (amroutine->amtranslatestrategy)
        result = amroutine->amtranslatestrategy(strategy, opfamily);
    else
        result = COMPARE_INVALID;
 
    if (!missing_ok && result == COMPARE_INVALID)
        elog(ERROR, "could not translate strategy number %d for index AM %u", strategy, amoid);
 
    return result;
}

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().