ExplainOneQuery_hook

Description

Hook for plugins to get control in ExplainOneQuery()

Interface type

ExplainOneQuery_hook_type

Header

src/include/commands/explain.h

Subsystem

EXPLAIN

Initial value

NULL (no hook installed)

C interface

typedef void (*ExplainOneQuery_hook_type) (Query *query, int cursorOptions, IntoClause *into, struct ExplainState *es, const char *queryString, ParamListInfo params, QueryEnvironment *queryEnv);
extern PGDLLIMPORT ExplainOneQuery_hook_type ExplainOneQuery_hook;

Core source comments

if an advisor plugin is present, let it manage things

Call sites

src/backend/commands/explain.c:306

Core call context: src/backend/commands/explain.c:300–314

		ExplainOneUtility(query->utilityStmt, into, es, pstate, params);
		return;
	}

	/* if an advisor plugin is present, let it manage things */
	if (ExplainOneQuery_hook)
		(*ExplainOneQuery_hook) (query, cursorOptions, into, es,
								 pstate->p_sourcetext, params, pstate->p_queryEnv);
	else
		standard_ExplainOneQuery(query, cursorOptions, into, es,
								 pstate->p_sourcetext, params, pstate->p_queryEnv);
}

/*
 * standard_ExplainOneQuery -

Related entries

• EXPLAIN

Documentation and source

• Interface declaration
• Core definition
• Call sites

Related entries

• explain_get_index_name_hookexplain_get_index_name_hook
• explain_per_node_hookexplain_per_node_hook
• explain_per_plan_hookexplain_per_plan_hook
• explain_validate_options_hookexplain_validate_options_hook