explain_validate_options_hook

Description

Hook to perform additional EXPLAIN options validation

Interface type

explain_validate_options_hook_type

Header

src/include/commands/explain_state.h

Subsystem

EXPLAIN

Initial value

NULL (no hook installed)

C interface

typedef void (*explain_validate_options_hook_type) (struct ExplainState *es, List *options, ParseState *pstate);
extern PGDLLIMPORT explain_validate_options_hook_type explain_validate_options_hook;

Core source comments

plugin specific option validation

Call sites

src/backend/commands/explain_state.c:206

Core call context: src/backend/commands/explain_state.c:200–214

	/* if the summary was not set explicitly, set default value */
	es->summary = (summary_set) ? es->summary : es->analyze;

	/* plugin specific option validation */
	if (explain_validate_options_hook)
		(*explain_validate_options_hook) (es, options, pstate);
}

/*
 * Map the name of an EXPLAIN extension to an integer ID.
 *
 * Within the lifetime of a particular backend, the same name will be mapped
 * to the same ID every time. IDs are not stable across backends. Use the ID
 * that you get from this function to call GetExplainExtensionState and

Related entries

• EXPLAIN

Documentation and source

• Interface declaration
• Core definition
• Call sites

Related entries

• ExplainOneQuery_hookExplainOneQuery_hook
• explain_get_index_name_hookexplain_get_index_name_hook
• explain_per_node_hookexplain_per_node_hook
• explain_per_plan_hookexplain_per_plan_hook