amapi.h File Reference

#include "access/genam.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	IndexAmRoutine

Typedefs
typedef enum IndexAMProperty	IndexAMProperty
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, 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 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 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) (void)
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)

Typedef Documentation

ambeginscan_function

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

Definition at line 118 of file amapi.h.

ambuild_function

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

Definition at line 63 of file amapi.h.

ambuildempty_function

typedef void(* ambuildempty_function) (Relation indexRelation)

Definition at line 68 of file amapi.h.

ambuildphasename_function

typedef char*(* ambuildphasename_function) (int64 phasenum)

Definition at line 112 of file amapi.h.

ambulkdelete_function

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

Definition at line 80 of file amapi.h.

amcanreturn_function

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

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

amendscan_function

typedef void(* amendscan_function) (IndexScanDesc scan)

Definition at line 138 of file amapi.h.

amestimateparallelscan_function

typedef Size(* amestimateparallelscan_function) (void)

Definition at line 151 of file amapi.h.

amgetbitmap_function

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

Definition at line 134 of file amapi.h.

amgettuple_function

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

Definition at line 130 of file amapi.h.

aminitparallelscan_function

typedef void(* aminitparallelscan_function) (void *target)

Definition at line 154 of file amapi.h.

aminsert_function

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

Definition at line 71 of file amapi.h.

ammarkpos_function

typedef void(* ammarkpos_function) (IndexScanDesc scan)

Definition at line 141 of file amapi.h.

amoptions_function

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

Definition at line 103 of file amapi.h.

amparallelrescan_function

typedef void(* amparallelrescan_function) (IndexScanDesc scan)

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

amrescan_function

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

Definition at line 123 of file amapi.h.

amrestrpos_function

typedef void(* amrestrpos_function) (IndexScanDesc scan)

Definition at line 144 of file amapi.h.

amvacuumcleanup_function

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

Definition at line 86 of file amapi.h.

amvalidate_function

typedef bool(* amvalidate_function) (Oid opclassoid)

Definition at line 115 of file amapi.h.

IndexAMProperty

typedef enum IndexAMProperty IndexAMProperty

IndexAmRoutine

typedef struct IndexAmRoutine IndexAmRoutine

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 34 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.

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

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

{
    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);

    return routine;
}

GetIndexAmRoutineByAmId()

IndexAmRoutine* GetIndexAmRoutineByAmId	(	Oid	amoid,
		bool	noerror
	)

Definition at line 56 of file amapi.c.

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

Referenced by AlterOpFamily(), amvalidate(), assignOperTypes(), ConstructTupleDescriptor(), DefineOpClass(), indexam_property(), IndexSupportsBackwardScan(), and pg_indexam_progress_phasename().

{
    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);
}