join_search_hook

Description

Hook for plugins to replace standard_join_search()

Interface type

join_search_hook_type

Header

src/include/optimizer/paths.h

Subsystem

Query planning

Initial value

NULL (no hook installed)

C interface

typedef RelOptInfo *(*join_search_hook_type) (PlannerInfo *root, int levels_needed, List *initial_rels);
extern PGDLLIMPORT join_search_hook_type join_search_hook;

Call sites

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

Core call context: src/backend/optimizer/path/allpaths.c:3417–3431

		 * We put the initial_rels list into a PlannerInfo field because
		 * has_legal_joinclause() needs to look at it (ugly :-().
		 */
		root->initial_rels = initial_rels;

		if (join_search_hook)
			return (*join_search_hook) (root, levels_needed, initial_rels);
		else if (enable_geqo && levels_needed >= geqo_threshold)
			return geqo(root, levels_needed, initial_rels);
		else
			return standard_join_search(root, levels_needed, initial_rels);
	}
}

/*

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
• planner_hookplanner_hook
• set_join_pathlist_hookset_join_pathlist_hook
• set_rel_pathlist_hookset_rel_pathlist_hook