set_join_pathlist_hook

Description

Hook for plugins to get control in add_paths_to_joinrel()

Interface type

set_join_pathlist_hook_type

Header

src/include/optimizer/paths.h

Subsystem

Query planning

Initial value

NULL (no hook installed)

C interface

typedef void (*set_join_pathlist_hook_type) (PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra);
extern PGDLLIMPORT set_join_pathlist_hook_type set_join_pathlist_hook;

Core source comments

6. Finally, give extensions a chance to manipulate the path list. They could add new paths (such as CustomPaths) by calling add_path(), or add_partial_path() if parallel aware. They could also delete or modify paths added by the core code.

Call sites

src/backend/optimizer/path/joinpath.c:343

Core call context: src/backend/optimizer/path/joinpath.c:337–351

	 * 6. Finally, give extensions a chance to manipulate the path list.  They
	 * could add new paths (such as CustomPaths) by calling add_path(), or
	 * add_partial_path() if parallel aware.  They could also delete or modify
	 * paths added by the core code.
	 */
	if (set_join_pathlist_hook)
		set_join_pathlist_hook(root, joinrel, outerrel, innerrel,
							   jointype, &extra);
}

/*
 * We override the param_source_rels heuristic to accept nestloop paths in
 * which the outer rel satisfies some but not all of the inner path's
 * parameterization.  This is necessary to get good plans for star-schema
 * scenarios, in which a parameterized path for a large table may require

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_rel_pathlist_hookset_rel_pathlist_hook