amapi.c File Reference

#include "postgres.h"
#include "access/amapi.h"
#include "access/htup_details.h"
#include "catalog/pg_am.h"
#include "catalog/pg_opclass.h"
#include "utils/fmgrprotos.h"
#include "utils/syscache.h"

Include dependency graph for amapi.c:

Go to the source code of this file.

Functions
const IndexAmRoutine *	GetIndexAmRoutine (Oid amhandler)
const 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)
Datum	amvalidate (PG_FUNCTION_ARGS)

Function Documentation

amvalidate()

Datum amvalidate

(

PG_FUNCTION_ARGS

)

Definition at line 187 of file amapi.c.

{
    Oid         opclassoid = PG_GETARG_OID(0);
    bool        result;
    HeapTuple   classtup;
    Form_pg_opclass classform;
    Oid         amoid;
    const IndexAmRoutine *amroutine;
 
    classtup = SearchSysCache1(CLAOID, ObjectIdGetDatum(opclassoid));
    if (!HeapTupleIsValid(classtup))
        elog(ERROR, "cache lookup failed for operator class %u", opclassoid);
    classform = (Form_pg_opclass) GETSTRUCT(classtup);
 
    amoid = classform->opcmethod;
 
    ReleaseSysCache(classtup);
 
    amroutine = GetIndexAmRoutineByAmId(amoid, false);
 
    if (amroutine->amvalidate == NULL)
        elog(ERROR, "function amvalidate is not defined for index access method %u",
             amoid);
 
    result = amroutine->amvalidate(opclassoid);
 
    PG_RETURN_BOOL(result);
}

References elog, ERROR, fb(), GetIndexAmRoutineByAmId(), GETSTRUCT(), HeapTupleIsValid, ObjectIdGetDatum(), PG_GETARG_OID, PG_RETURN_BOOL, ReleaseSysCache(), and SearchSysCache1().

GetIndexAmRoutine()

const IndexAmRoutine * GetIndexAmRoutine

(

Oid

amhandler

)

Definition at line 33 of file amapi.c.

{
    Datum       datum;
    const IndexAmRoutine *routine;
 
    datum = OidFunctionCall0(amhandler);
    routine = (const 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, fb(), IsA, and OidFunctionCall0.

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

GetIndexAmRoutineByAmId()

const 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, fb(), 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;
    const 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 COMPARE_GT, COMPARE_INVALID, elog, ERROR, fb(), 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;
    const 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 BTMaxStrategyNumber, COMPARE_INVALID, elog, ERROR, fb(), 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().