dummy_index_am.c File Reference

#include "postgres.h"
#include "access/amapi.h"
#include "access/reloptions.h"
#include "catalog/index.h"
#include "commands/vacuum.h"
#include "nodes/pathnodes.h"
#include "utils/guc.h"
#include "utils/rel.h"

Include dependency graph for dummy_index_am.c:

Go to the source code of this file.

Data Structures
struct	DummyIndexOptions

Typedefs
typedef enum DummyAmEnum	DummyAmEnum
typedef struct DummyIndexOptions	DummyIndexOptions

Enumerations
enum	DummyAmEnum { DUMMY_AM_ENUM_ONE , DUMMY_AM_ENUM_TWO }

Functions
	PG_FUNCTION_INFO_V1 (dihandler)
static void	validate_string_option (const char *value)
static void	create_reloptions_table (void)
static IndexBuildResult *	dibuild (Relation heap, Relation index, IndexInfo *indexInfo)
static void	dibuildempty (Relation index)
static bool	diinsert (Relation index, Datum *values, bool *isnull, ItemPointer ht_ctid, Relation heapRel, IndexUniqueCheck checkUnique, bool indexUnchanged, IndexInfo *indexInfo)
static IndexBulkDeleteResult *	dibulkdelete (IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
static IndexBulkDeleteResult *	divacuumcleanup (IndexVacuumInfo *info, IndexBulkDeleteResult *stats)
static void	dicostestimate (PlannerInfo *root, IndexPath *path, double loop_count, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, double *indexCorrelation, double *indexPages)
static bytea *	dioptions (Datum reloptions, bool validate)
static bool	divalidate (Oid opclassoid)
static IndexScanDesc	dibeginscan (Relation r, int nkeys, int norderbys)
static void	direscan (IndexScanDesc scan, ScanKey scankey, int nscankeys, ScanKey orderbys, int norderbys)
static void	diendscan (IndexScanDesc scan)
Datum	dihandler (PG_FUNCTION_ARGS)
void	_PG_init (void)

Variables
	PG_MODULE_MAGIC
relopt_parse_elt	di_relopt_tab [6]
relopt_kind	di_relopt_kind
relopt_enum_elt_def	dummyAmEnumValues []

Typedef Documentation

DummyAmEnum

typedef enum DummyAmEnum DummyAmEnum

DummyIndexOptions

typedef struct DummyIndexOptions DummyIndexOptions

Enumeration Type Documentation

DummyAmEnum

enum DummyAmEnum

Enumerator
DUMMY_AM_ENUM_ONE
DUMMY_AM_ENUM_TWO

Definition at line 32 of file dummy_index_am.c.

{
    DUMMY_AM_ENUM_ONE,
    DUMMY_AM_ENUM_TWO,
}           DummyAmEnum;

Function Documentation

_PG_init()

void _PG_init

(

void

)

Definition at line 330 of file dummy_index_am.c.

{
    create_reloptions_table();
}

References create_reloptions_table().

create_reloptions_table()

static void create_reloptions_table ( void  )

static

Definition at line 76 of file dummy_index_am.c.

{
    di_relopt_kind = add_reloption_kind();
 
    add_int_reloption(di_relopt_kind, "option_int",
                      "Integer option for dummy_index_am",
                      10, -10, 100, AccessExclusiveLock);
    di_relopt_tab[0].optname = "option_int";
    di_relopt_tab[0].opttype = RELOPT_TYPE_INT;
    di_relopt_tab[0].offset = offsetof(DummyIndexOptions, option_int);
 
    add_real_reloption(di_relopt_kind, "option_real",
                       "Real option for dummy_index_am",
                       3.1415, -10, 100, AccessExclusiveLock);
    di_relopt_tab[1].optname = "option_real";
    di_relopt_tab[1].opttype = RELOPT_TYPE_REAL;
    di_relopt_tab[1].offset = offsetof(DummyIndexOptions, option_real);
 
    add_bool_reloption(di_relopt_kind, "option_bool",
                       "Boolean option for dummy_index_am",
                       true, AccessExclusiveLock);
    di_relopt_tab[2].optname = "option_bool";
    di_relopt_tab[2].opttype = RELOPT_TYPE_BOOL;
    di_relopt_tab[2].offset = offsetof(DummyIndexOptions, option_bool);
 
    add_enum_reloption(di_relopt_kind, "option_enum",
                       "Enum option for dummy_index_am",
                       dummyAmEnumValues,
                       DUMMY_AM_ENUM_ONE,
                       "Valid values are \"one\" and \"two\".",
                       AccessExclusiveLock);
    di_relopt_tab[3].optname = "option_enum";
    di_relopt_tab[3].opttype = RELOPT_TYPE_ENUM;
    di_relopt_tab[3].offset = offsetof(DummyIndexOptions, option_enum);
 
    add_string_reloption(di_relopt_kind, "option_string_val",
                         "String option for dummy_index_am with non-NULL default",
                         "DefaultValue", &validate_string_option,
                         AccessExclusiveLock);
    di_relopt_tab[4].optname = "option_string_val";
    di_relopt_tab[4].opttype = RELOPT_TYPE_STRING;
    di_relopt_tab[4].offset = offsetof(DummyIndexOptions,
                                       option_string_val_offset);
 
    /*
     * String option for dummy_index_am with NULL default, and without
     * description.
     */
    add_string_reloption(di_relopt_kind, "option_string_null",
                         NULL,  /* description */
                         NULL, &validate_string_option,
                         AccessExclusiveLock);
    di_relopt_tab[5].optname = "option_string_null";
    di_relopt_tab[5].opttype = RELOPT_TYPE_STRING;
    di_relopt_tab[5].offset = offsetof(DummyIndexOptions,
                                       option_string_null_offset);
}

References AccessExclusiveLock, add_bool_reloption(), add_enum_reloption(), add_int_reloption(), add_real_reloption(), add_reloption_kind(), add_string_reloption(), di_relopt_kind, di_relopt_tab, DUMMY_AM_ENUM_ONE, dummyAmEnumValues, relopt_parse_elt::offset, relopt_parse_elt::optname, relopt_parse_elt::opttype, RELOPT_TYPE_BOOL, RELOPT_TYPE_ENUM, RELOPT_TYPE_INT, RELOPT_TYPE_REAL, RELOPT_TYPE_STRING, and validate_string_option().

Referenced by _PG_init().

dibeginscan()

static IndexScanDesc dibeginscan ( Relation  r, int  nkeys, int  norderbys  )

static

Definition at line 246 of file dummy_index_am.c.

{
    IndexScanDesc scan;
 
    /* Let's pretend we are doing something */
    scan = RelationGetIndexScan(r, nkeys, norderbys);
    return scan;
}

References RelationGetIndexScan().

Referenced by dihandler().

dibuild()

static IndexBuildResult* dibuild ( Relation  heap, Relation  index, IndexInfo *  indexInfo  )

static

Definition at line 139 of file dummy_index_am.c.

{
    IndexBuildResult *result;
 
    result = (IndexBuildResult *) palloc(sizeof(IndexBuildResult));
 
    /* let's pretend that no tuples were scanned */
    result->heap_tuples = 0;
    /* and no index tuples were created (that is true) */
    result->index_tuples = 0;
 
    return result;
}

References IndexBuildResult::heap_tuples, IndexBuildResult::index_tuples, and palloc().

Referenced by dihandler().

dibuildempty()

static void dibuildempty ( Relation  index )

static

Definition at line 157 of file dummy_index_am.c.

{
    /* No need to build an init fork for a dummy index */
}

Referenced by dihandler().

dibulkdelete()

static IndexBulkDeleteResult* dibulkdelete ( IndexVacuumInfo *  info, IndexBulkDeleteResult *  stats, IndexBulkDeleteCallback  callback, void *  callback_state  )

static

Definition at line 180 of file dummy_index_am.c.

{
    /*
     * There is nothing to delete.  Return NULL as there is nothing to pass to
     * amvacuumcleanup.
     */
    return NULL;
}

Referenced by dihandler().

dicostestimate()

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

static

Definition at line 204 of file dummy_index_am.c.

{
    /* Tell planner to never use this index! */
    *indexStartupCost = 1.0e10;
    *indexTotalCost = 1.0e10;
 
    /* Do not care about the rest */
    *indexSelectivity = 1;
    *indexCorrelation = 0;
    *indexPages = 1;
}

Referenced by dihandler().

diendscan()

static void diendscan ( IndexScanDesc  scan )

static

Definition at line 269 of file dummy_index_am.c.

{
    /* nothing to do */
}

Referenced by dihandler().

dihandler()

Datum dihandler

(

PG_FUNCTION_ARGS

)

Definition at line 279 of file dummy_index_am.c.

{
    IndexAmRoutine *amroutine = makeNode(IndexAmRoutine);
 
    amroutine->amstrategies = 0;
    amroutine->amsupport = 1;
    amroutine->amcanorder = false;
    amroutine->amcanorderbyop = false;
    amroutine->amcanbackward = false;
    amroutine->amcanunique = false;
    amroutine->amcanmulticol = false;
    amroutine->amoptionalkey = false;
    amroutine->amsearcharray = false;
    amroutine->amsearchnulls = false;
    amroutine->amstorage = false;
    amroutine->amclusterable = false;
    amroutine->ampredlocks = false;
    amroutine->amcanparallel = false;
    amroutine->amcanbuildparallel = false;
    amroutine->amcaninclude = false;
    amroutine->amusemaintenanceworkmem = false;
    amroutine->amsummarizing = false;
    amroutine->amparallelvacuumoptions = VACUUM_OPTION_NO_PARALLEL;
    amroutine->amkeytype = InvalidOid;
 
    amroutine->ambuild = dibuild;
    amroutine->ambuildempty = dibuildempty;
    amroutine->aminsert = diinsert;
    amroutine->ambulkdelete = dibulkdelete;
    amroutine->amvacuumcleanup = divacuumcleanup;
    amroutine->amcanreturn = NULL;
    amroutine->amcostestimate = dicostestimate;
    amroutine->amoptions = dioptions;
    amroutine->amproperty = NULL;
    amroutine->ambuildphasename = NULL;
    amroutine->amvalidate = divalidate;
    amroutine->ambeginscan = dibeginscan;
    amroutine->amrescan = direscan;
    amroutine->amgettuple = NULL;
    amroutine->amgetbitmap = NULL;
    amroutine->amendscan = diendscan;
    amroutine->ammarkpos = NULL;
    amroutine->amrestrpos = NULL;
    amroutine->amestimateparallelscan = NULL;
    amroutine->aminitparallelscan = NULL;
    amroutine->amparallelrescan = NULL;
 
    PG_RETURN_POINTER(amroutine);
}

References IndexAmRoutine::ambeginscan, IndexAmRoutine::ambuild, IndexAmRoutine::ambuildempty, IndexAmRoutine::ambuildphasename, IndexAmRoutine::ambulkdelete, IndexAmRoutine::amcanbackward, IndexAmRoutine::amcanbuildparallel, IndexAmRoutine::amcaninclude, IndexAmRoutine::amcanmulticol, IndexAmRoutine::amcanorder, IndexAmRoutine::amcanorderbyop, IndexAmRoutine::amcanparallel, IndexAmRoutine::amcanreturn, IndexAmRoutine::amcanunique, IndexAmRoutine::amclusterable, IndexAmRoutine::amcostestimate, IndexAmRoutine::amendscan, IndexAmRoutine::amestimateparallelscan, IndexAmRoutine::amgetbitmap, IndexAmRoutine::amgettuple, IndexAmRoutine::aminitparallelscan, IndexAmRoutine::aminsert, IndexAmRoutine::amkeytype, IndexAmRoutine::ammarkpos, IndexAmRoutine::amoptionalkey, IndexAmRoutine::amoptions, IndexAmRoutine::amparallelrescan, IndexAmRoutine::amparallelvacuumoptions, IndexAmRoutine::ampredlocks, IndexAmRoutine::amproperty, IndexAmRoutine::amrescan, IndexAmRoutine::amrestrpos, IndexAmRoutine::amsearcharray, IndexAmRoutine::amsearchnulls, IndexAmRoutine::amstorage, IndexAmRoutine::amstrategies, IndexAmRoutine::amsummarizing, IndexAmRoutine::amsupport, IndexAmRoutine::amusemaintenanceworkmem, IndexAmRoutine::amvacuumcleanup, IndexAmRoutine::amvalidate, dibeginscan(), dibuild(), dibuildempty(), dibulkdelete(), dicostestimate(), diendscan(), diinsert(), dioptions(), direscan(), divacuumcleanup(), divalidate(), InvalidOid, makeNode, PG_RETURN_POINTER, and VACUUM_OPTION_NO_PARALLEL.

diinsert()

static bool diinsert ( Relation  index, Datum *  values, bool *  isnull, ItemPointer  ht_ctid, Relation  heapRel, IndexUniqueCheck  checkUnique, bool  indexUnchanged, IndexInfo *  indexInfo  )

static

Definition at line 166 of file dummy_index_am.c.

{
    /* nothing to do */
    return false;
}

Referenced by dihandler().

dioptions()

static bytea* dioptions ( Datum  reloptions, bool  validate  )

static

Definition at line 224 of file dummy_index_am.c.

{
    return (bytea *) build_reloptions(reloptions, validate,
                                      di_relopt_kind,
                                      sizeof(DummyIndexOptions),
                                      di_relopt_tab, lengthof(di_relopt_tab));
}

References build_reloptions(), di_relopt_kind, di_relopt_tab, and lengthof.

Referenced by dihandler().

direscan()

static void direscan ( IndexScanDesc  scan, ScanKey  scankey, int  nscankeys, ScanKey  orderbys, int  norderbys  )

static

Definition at line 259 of file dummy_index_am.c.

{
    /* nothing to do */
}

Referenced by dihandler().

divacuumcleanup()

static IndexBulkDeleteResult* divacuumcleanup ( IndexVacuumInfo *  info, IndexBulkDeleteResult *  stats  )

static

Definition at line 194 of file dummy_index_am.c.

{
    /* Index has not been modified, so returning NULL is fine */
    return NULL;
}

Referenced by dihandler().

divalidate()

static bool divalidate ( Oid  opclassoid )

static

Definition at line 236 of file dummy_index_am.c.

{
    /* Index is dummy so we are happy with any opclass */
    return true;
}

Referenced by dihandler().

PG_FUNCTION_INFO_V1()

PG_FUNCTION_INFO_V1

(

dihandler

)

validate_string_option()

static void validate_string_option ( const char *  value )

static

Definition at line 64 of file dummy_index_am.c.

{
    ereport(NOTICE,
            (errmsg("new option value for string parameter %s",
                    value ? value : "NULL")));
}

References ereport, errmsg(), NOTICE, and value.

Referenced by create_reloptions_table().

Variable Documentation

di_relopt_kind

relopt_kind di_relopt_kind

Definition at line 30 of file dummy_index_am.c.

Referenced by create_reloptions_table(), and dioptions().

di_relopt_tab

relopt_parse_elt di_relopt_tab[6]

Definition at line 27 of file dummy_index_am.c.

Referenced by create_reloptions_table(), and dioptions().

dummyAmEnumValues

relopt_enum_elt_def dummyAmEnumValues[]

Initial value:

=
{
    {"one", DUMMY_AM_ENUM_ONE},
    {"two", DUMMY_AM_ENUM_TWO},
    {(const char *) NULL}       
}

Definition at line 50 of file dummy_index_am.c.

Referenced by create_reloptions_table().

PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 24 of file dummy_index_am.c.