#include "postgres.h"
#include "access/amapi.h"
#include "access/reloptions.h"
#include "catalog/index.h"
#include "commands/vacuum.h"
#include "nodes/pathnodes.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

static relopt_parse_elt	di_relopt_tab [8]

static relopt_kind	di_relopt_kind

static 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 30 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 350 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 75 of file dummy_index_am.c.

{
    int         i = 0;
 
    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[i].optname = "option_int";
    di_relopt_tab[i].opttype = RELOPT_TYPE_INT;
    di_relopt_tab[i].offset = offsetof(DummyIndexOptions, option_int);
    i++;
 
    add_real_reloption(di_relopt_kind, "option_real",
                       "Real option for dummy_index_am",
                       3.1415, -10, 100, AccessExclusiveLock);
    di_relopt_tab[i].optname = "option_real";
    di_relopt_tab[i].opttype = RELOPT_TYPE_REAL;
    di_relopt_tab[i].offset = offsetof(DummyIndexOptions, option_real);
    i++;
 
    add_bool_reloption(di_relopt_kind, "option_bool",
                       "Boolean option for dummy_index_am",
                       true, AccessExclusiveLock);
    di_relopt_tab[i].optname = "option_bool";
    di_relopt_tab[i].opttype = RELOPT_TYPE_BOOL;
    di_relopt_tab[i].offset = offsetof(DummyIndexOptions, option_bool);
    i++;
 
    add_ternary_reloption(di_relopt_kind, "option_ternary_1",
                          "One ternary option for dummy_index_am",
                          AccessExclusiveLock);
    di_relopt_tab[i].optname = "option_ternary_1";
    di_relopt_tab[i].opttype = RELOPT_TYPE_TERNARY;
    di_relopt_tab[i].offset = offsetof(DummyIndexOptions, option_ternary_1);
    i++;
 
    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[i].optname = "option_enum";
    di_relopt_tab[i].opttype = RELOPT_TYPE_ENUM;
    di_relopt_tab[i].offset = offsetof(DummyIndexOptions, option_enum);
    i++;
 
    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[i].optname = "option_string_val";
    di_relopt_tab[i].opttype = RELOPT_TYPE_STRING;
    di_relopt_tab[i].offset = offsetof(DummyIndexOptions,
                                       option_string_val_offset);
    i++;
 
    /*
     * 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[i].optname = "option_string_null";
    di_relopt_tab[i].opttype = RELOPT_TYPE_STRING;
    di_relopt_tab[i].offset = offsetof(DummyIndexOptions,
                                       option_string_null_offset);
    i++;
}

References AccessExclusiveLock, add_bool_reloption(), add_enum_reloption(), add_int_reloption(), add_real_reloption(), add_reloption_kind(), add_string_reloption(), add_ternary_reloption(), di_relopt_kind, di_relopt_tab, DUMMY_AM_ENUM_ONE, dummyAmEnumValues, fb(), i, 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, RELOPT_TYPE_TERNARY, and validate_string_option().

Referenced by _PG_init().

◆ dibeginscan()

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

static

Definition at line 261 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 154 of file dummy_index_am.c.

{
    IndexBuildResult *result;
 
    result = palloc_object(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_object.

Referenced by dihandler().

◆ dibuildempty()

static void dibuildempty ( Relation index )

static

Definition at line 172 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 195 of file dummy_index_am.c.

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

References fb().

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

References fb().

Referenced by dihandler().

◆ diendscan()

static void diendscan ( IndexScanDesc scan )

static

Definition at line 284 of file dummy_index_am.c.

{
    /* nothing to do */
}

Referenced by dihandler().

◆ dihandler()

Datum dihandler ( PG_FUNCTION_ARGS )

Definition at line 294 of file dummy_index_am.c.

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

References dibeginscan(), dibuild(), dibuildempty(), dibulkdelete(), dicostestimate(), diendscan(), diinsert(), dioptions(), direscan(), divacuumcleanup(), divalidate(), fb(), InvalidOid, PG_RETURN_POINTER, IndexAmRoutine::type, 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 181 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 239 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, lengthof, and validate().

Referenced by dihandler().

◆ direscan()

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

static

Definition at line 274 of file dummy_index_am.c.

{
    /* nothing to do */
}

Referenced by dihandler().

◆ divacuumcleanup()

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

static

Definition at line 209 of file dummy_index_am.c.

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

References fb().

Referenced by dihandler().

◆ divalidate()

static bool divalidate ( Oid opclassoid )

static

Definition at line 251 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 63 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

static

Definition at line 28 of file dummy_index_am.c.

Referenced by create_reloptions_table(), and dioptions().

◆ di_relopt_tab

relopt_parse_elt di_relopt_tab[8]

static

Definition at line 25 of file dummy_index_am.c.

Referenced by create_reloptions_table(), and dioptions().

◆ dummyAmEnumValues

relopt_enum_elt_def dummyAmEnumValues[]

static

Initial value:

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

Definition at line 49 of file dummy_index_am.c.

{
    {"one", DUMMY_AM_ENUM_ONE},
    {"two", DUMMY_AM_ENUM_TWO},
    {(const char *) NULL}       /* list terminator */
};

Referenced by create_reloptions_table().

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 22 of file dummy_index_am.c.

Data Structures

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ DummyAmEnum

◆ DummyIndexOptions

Enumeration Type Documentation

◆ DummyAmEnum

Function Documentation

◆ _PG_init()

◆ create_reloptions_table()

◆ dibeginscan()

◆ dibuild()

◆ dibuildempty()

◆ dibulkdelete()

◆ dicostestimate()

◆ diendscan()

◆ dihandler()

◆ diinsert()

◆ dioptions()

◆ direscan()

◆ divacuumcleanup()

◆ divalidate()

◆ PG_FUNCTION_INFO_V1()

◆ validate_string_option()

Variable Documentation

◆ di_relopt_kind

◆ di_relopt_tab

◆ dummyAmEnumValues

◆ PG_MODULE_MAGIC