↑↓ 选择 ↵ 打开 ⌫ 改范围 完整检索页

pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。

百科 / 扩展钩子 / 查询规划

planner_hook

查询规划入口

供插件在 planner() 中接管处理的钩子。

当前查看 PostgreSQL 18。

中文定义与说明

供插件在 planner() 中接管处理的钩子。

以下中文为本站依据所列 PostgreSQL 源码注释编译的说明。

接口声明

typedef PlannedStmt *(*planner_hook_type) (Query *parse, const char *query_string, int cursorOptions, ParamListInfo boundParams);
extern PGDLLIMPORT planner_hook_type planner_hook;

调用位置

  • src/backend/optimizer/plan/planner.c:316

核心调用上下文:src/backend/optimizer/plan/planner.c:310–324

planner(Query *parse, const char *query_string, int cursorOptions,
		ParamListInfo boundParams)
{
	PlannedStmt *result;

	if (planner_hook)
		result = (*planner_hook) (parse, query_string, cursorOptions, boundParams);
	else
		result = standard_planner(parse, query_string, cursorOptions, boundParams);

	pgstat_report_plan_id(result->planId, false);

	return result;
}

说明

供插件在 planner() 中接管处理的钩子。

接口类型
planner_hook_type
声明头文件
src/include/optimizer/planner.h
调用阶段
查询规划
初始值
NULL(未安装钩子)

接口签名

typedef PlannedStmt *(*planner_hook_type) (Query *parse, const char *query_string, int cursorOptions, ParamListInfo boundParams);
extern PGDLLIMPORT planner_hook_type planner_hook;

串接已有钩子

钩子变量只保存一个函数指针。扩展安装时应保存旧值;需要保留原行为时先调用旧钩子,旧值为空则调用相应的 standard_ 实现。直接再次调用同名公共入口可能重新进入自己的钩子。

调用位置

src/backend/optimizer/plan/planner.c:316

相关条目

文档与源码

查看来源构建
版本
18
构建
REL_18_STABLE
来源指纹
753057e340da8f22e57c9a409ea7a235fd6a46bd

同类条目

返回扩展钩子 · 此条目的收录范围为 PostgreSQL 10 至 20;起点不一定是实际引入版本。