get_index_stats_hook

Description

get_index_stats_hook: core extension hook declared in src/include/utils/selfuncs.h. The exact interface and call sites are recorded below.

Interface type

get_index_stats_hook_type

Header

src/include/utils/selfuncs.h

Subsystem

Statistics and estimation

Initial value

NULL (no hook installed)

C interface

typedef bool (*get_index_stats_hook_type) (PlannerInfo *root, Oid indexOid, AttrNumber indexattnum, VariableStatData *vardata);
extern PGDLLIMPORT get_index_stats_hook_type get_index_stats_hook;

Call sites

src/backend/utils/adt/selfuncs.c:5488

src/backend/utils/adt/selfuncs.c:6224

src/backend/utils/adt/selfuncs.c:8783

Core call context: src/backend/utils/adt/selfuncs.c:5482–5496

						 * a partial index.
						 *
						 * An index stats hook, however, must make its own
						 * decisions about what to do with partial indexes.
						 */
						if (get_index_stats_hook &&
							(*get_index_stats_hook) (root, index->indexoid,
													 pos + 1, vardata))
						{
							/*
							 * The hook took control of acquiring a stats
							 * tuple.  If it did supply a tuple, it'd better
							 * have supplied a freefunc.
							 */
							if (HeapTupleIsValid(vardata->statsTuple) &&

Core call context: src/backend/utils/adt/selfuncs.c:6218–6232

	{
		/* Expression --- maybe there are stats for the index itself */
		relid = index->indexoid;
		colnum = indexcol + 1;

		if (get_index_stats_hook &&
			(*get_index_stats_hook) (root, relid, colnum, vardata))
		{
			/*
			 * The hook took control of acquiring a stats tuple.  If it did
			 * supply a tuple, it'd better have supplied a freefunc.
			 */
			if (HeapTupleIsValid(vardata->statsTuple) &&
				!vardata->freefunc)
				elog(ERROR, "no function provided to release variable stats with");

Core call context: src/backend/utils/adt/selfuncs.c:8777–8791

			 */

			/* get the attnum from the 0-based index. */
			attnum = iclause->indexcol + 1;

			if (get_index_stats_hook &&
				(*get_index_stats_hook) (root, index->indexoid, attnum, &vardata))
			{
				/*
				 * The hook took control of acquiring a stats tuple.  If it
				 * did supply a tuple, it'd better have supplied a freefunc.
				 */
				if (HeapTupleIsValid(vardata.statsTuple) &&
					!vardata.freefunc)
					elog(ERROR, "no function provided to release variable stats with");

Related entries

• The Planner/Optimizer

Documentation and source

• Interface declaration
• Core definition
• Call sites

Related entries

• get_attavgwidth_hookget_attavgwidth_hook
• get_relation_stats_hookget_relation_stats_hook