explain_get_index_name_hook

Description

Hook for plugins to get control in explain_get_index_name()

Interface type

explain_get_index_name_hook_type

Header

src/include/commands/explain.h

Subsystem

EXPLAIN

Initial value

NULL (no hook installed)

C interface

typedef const char *(*explain_get_index_name_hook_type) (Oid indexId);
extern PGDLLIMPORT explain_get_index_name_hook_type explain_get_index_name_hook;

Call sites

src/backend/commands/explain.c:4027

Core call context: src/backend/commands/explain.c:4021–4035

static const char *
explain_get_index_name(Oid indexId)
{
	const char *result;

	if (explain_get_index_name_hook)
		result = (*explain_get_index_name_hook) (indexId);
	else
		result = NULL;
	if (result == NULL)
	{
		/* default behavior: look it up in the catalogs */
		result = get_rel_name(indexId);
		if (result == NULL)
			elog(ERROR, "cache lookup failed for index %u", indexId);

Related entries

• EXPLAIN

Documentation and source

• Interface declaration
• Core definition
• Call sites

Related entries

• ExplainOneQuery_hookExplainOneQuery_hook
• explain_per_node_hookexplain_per_node_hook
• explain_per_plan_hookexplain_per_plan_hook
• explain_validate_options_hookexplain_validate_options_hook