set_rel_pathlist_hook

Description

Hook for plugins to get control in set_rel_pathlist()

Interface type

set_rel_pathlist_hook_type

Header

src/include/optimizer/paths.h

Subsystem

Query planning

Initial value

NULL (no hook installed)

C interface

typedef void (*set_rel_pathlist_hook_type) (PlannerInfo *root, RelOptInfo *rel, Index rti, RangeTblEntry *rte);
extern PGDLLIMPORT set_rel_pathlist_hook_type set_rel_pathlist_hook;

Core source comments

Allow a plugin to editorialize on the set of Paths for this base relation. It could add new paths (such as CustomPaths) by calling add_path(), or add_partial_path() if parallel aware. It could also delete or modify paths added by the core code.

Call sites

src/backend/optimizer/path/allpaths.c:543

Core call context: src/backend/optimizer/path/allpaths.c:537–551

	 * Allow a plugin to editorialize on the set of Paths for this base
	 * relation.  It could add new paths (such as CustomPaths) by calling
	 * add_path(), or add_partial_path() if parallel aware.  It could also
	 * delete or modify paths added by the core code.
	 */
	if (set_rel_pathlist_hook)
		(*set_rel_pathlist_hook) (root, rel, rti, rte);

	/*
	 * If this is a baserel, we should normally consider gathering any partial
	 * paths we may have created for it.  We have to do this after calling the
	 * set_rel_pathlist_hook, else it cannot add partial paths to be included
	 * here.
	 *
	 * However, if this is an inheritance child, skip it.  Otherwise, we could

Related entries

• The Planner/Optimizer

Documentation and source

• Interface declaration
• Core definition
• Call sites

Related entries

• create_upper_paths_hookcreate_upper_paths_hook
• get_relation_info_hookget_relation_info_hook
• join_search_hookjoin_search_hook
• planner_hookplanner_hook
• set_join_pathlist_hookset_join_pathlist_hook