#include "access/genam.h"

Include dependency graph for amapi.h:

This graph shows which files directly or indirectly include 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 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

Functions
IndexAmRoutine *	GetIndexAmRoutine (Oid amhandler)

IndexAmRoutine *	GetIndexAmRoutineByAmId (Oid amoid, bool noerror)

Typedef Documentation

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

Definition at line 114 of file amapi.h.

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

Definition at line 62 of file amapi.h.

typedef void(* ambuildempty_function)(Relation indexRelation)

Definition at line 67 of file amapi.h.

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

Definition at line 79 of file amapi.h.

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

Definition at line 89 of file amapi.h.

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

typedef void(* amendscan_function)(IndexScanDesc scan)

Definition at line 134 of file amapi.h.

typedef Size(* amestimateparallelscan_function)(void)

Definition at line 147 of file amapi.h.

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

Definition at line 130 of file amapi.h.

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

Definition at line 126 of file amapi.h.

typedef void(* aminitparallelscan_function)(void *target)

Definition at line 150 of file amapi.h.

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

Definition at line 70 of file amapi.h.

typedef void(* ammarkpos_function)(IndexScanDesc scan)

Definition at line 137 of file amapi.h.

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

Definition at line 102 of file amapi.h.

typedef void(* amparallelrescan_function)(IndexScanDesc scan)

Definition at line 153 of file amapi.h.

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

Definition at line 106 of file amapi.h.

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

Definition at line 119 of file amapi.h.

typedef void(* amrestrpos_function)(IndexScanDesc scan)

Definition at line 140 of file amapi.h.

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

Definition at line 85 of file amapi.h.

typedef bool(* amvalidate_function)(Oid opclassoid)

Definition at line 111 of file amapi.h.

typedef enum IndexAMProperty IndexAMProperty

typedef struct IndexAmRoutine IndexAmRoutine

Enumeration Type Documentation

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

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
 } IndexAMProperty;

Function Documentation

IndexAmRoutine* GetIndexAmRoutine ( Oid amhandler )

Definition at line 33 of file amapi.c.

References DatumGetPointer, elog, ERROR, IsA, NULL, 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;
 }

IndexAmRoutine* GetIndexAmRoutineByAmId	(	Oid	amoid,
		bool	noerror
	)

Definition at line 56 of file amapi.c.

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

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

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

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 }

Data Structures

Typedefs

Enumerations

Functions

Typedef Documentation

Enumeration Type Documentation

Function Documentation