↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16
开发中的版本: 19 / 20devel

61.1. 创建自定义扫描路径 #

自定义扫描提供者通常通过设置下面的钩子,为基本关系添加路径。核心代码为该关系生成所有可生成的访问路径之后,会调用此钩子(Gather 路径除外,它们会在本次调用之后生成,以便使用钩子添加的部分路径):

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;

虽然此钩子函数可用于检查、修改或删除核心系统生成的路径,但自定义扫描提供者通常只生成 CustomPath 对象,并将它们添加到 rel,所用函数是 add_path。自定义扫描提供者负责初始化 CustomPath 对象,其声明如下:

typedef struct CustomPath
{
    Path      path;
    uint32    flags;
    List     *custom_paths;
    List     *custom_private;
    const CustomPathMethods *methods;
} CustomPath;

path 必须像其他任何路径一样完成初始化,包括行数估计、启动代价和总代价,以及该路径提供的排序顺序。flags 是一个位掩码,用于指明扫描提供者是否支持某些可选能力。如果自定义路径支持反向扫描,flags 就应包含 CUSTOMPATH_SUPPORT_BACKWARD_SCAN;如果支持标记和恢复,就应包含 CUSTOMPATH_SUPPORT_MARK_RESTORE;如果能够执行投影,就应包含 CUSTOMPATH_SUPPORT_PROJECTION。(如果未设置 CUSTOMPATH_SUPPORT_PROJECTION,则只会要求扫描节点生成被扫描关系的 Var;而如果设置了该标志,扫描节点就必须能够对这些 Var 上的标量表达式求值。)可选字段 custom_paths 是该自定义路径节点所使用的 Path 节点列表;规划器会把它们转换成 Plan 节点。custom_private 可用于存储自定义路径的私有数据。私有数据应以 nodeToString 能够处理的形式存储,这样尝试打印该自定义路径的调试例程才能按预期工作。methods 必须指向一个实现了所需自定义路径方法的对象(通常是静态分配的),下文会进一步说明。

自定义扫描提供者也可以提供连接路径。与基本关系一样,这种路径也必须产生与它所替代连接通常会产生的相同输出。为此,连接提供者应设置下列钩子,并在该钩子函数内部为连接关系创建 CustomPath 路径。

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;

对于同一个连接关系,这个钩子会针对不同的内外关系组合重复调用;如何尽量减少重复工作,是该钩子的职责。

61.1.1. 自定义扫描路径回调 #

Plan *(*PlanCustomPath) (PlannerInfo *root,
                         RelOptInfo *rel,
                         CustomPath *best_path,
                         List *tlist,
                         List *clauses,
                         List *custom_plans);

将自定义路径转换为完成的计划。返回值通常是一个 CustomScan 对象,回调函数必须负责分配并初始化该对象。详见第 61.2 节。

List *(*ReparameterizeCustomPathByChild) (PlannerInfo *root,
                                          List *custom_private,
                                          RelOptInfo *child_rel);

在把由给定子关系 child_rel 的最顶层父关系参数化的路径,转换为由该子关系参数化的路径时,会调用此回调。该回调用于重新参数化保存在 CustomPath 的给定 custom_private 成员中的任何路径,或者转换其中保存的任何表达式节点。该回调可根据需要使用 reparameterize_path_by_child、adjust_appendrel_attrs 或 adjust_appendrel_attrs_multilevel。

报告文档问题

阅读 上游文档. 通过 PostgreSQL 文档反馈表单.