当执行 CustomScan
时,其执行状态由 CustomScanState
表示,声明如下
typedef struct CustomScanState { ScanState ss; uint32 flags; const CustomExecMethods *methods; } CustomScanState;
ss
的初始化与其他任何扫描状态一样,除非扫描是用于连接而不是基本关系,否则 ss.ss_currentRelation
将保留为 NULL。flags
是一个位掩码,其含义与 CustomPath
和 CustomScan
中相同。methods
必须指向一个(通常是静态分配的)对象,该对象实现所需的自定义扫描状态方法,下面将详细介绍这些方法。通常,一个 CustomScanState
,不需要支持 copyObject
,实际上是一个更大的结构,将上述结构作为其第一个成员嵌入。
void (*BeginCustomScan) (CustomScanState *node, EState *estate, int eflags);
完成提供的 CustomScanState
的初始化。标准字段已由 ExecInitCustomScan
初始化,但任何私有字段都应在此处初始化。
TupleTableSlot *(*ExecCustomScan) (CustomScanState *node);
获取下一个扫描元组。如果还有任何元组剩余,它应该用当前扫描方向的下一个元组填充 ps_ResultTupleSlot
,然后返回元组槽。如果不是,则应返回 NULL
或一个空槽。
void (*EndCustomScan) (CustomScanState *node);
清除与 CustomScanState
关联的任何私有数据。此方法是必需的,但如果没有关联的数据或将自动清除数据,则不需要执行任何操作。
void (*ReScanCustomScan) (CustomScanState *node);
将当前扫描倒回开头,并准备重新扫描关系。
void (*MarkPosCustomScan) (CustomScanState *node);
保存当前扫描位置,以便后续可以由 RestrPosCustomScan
回调恢复。此回调是可选的,仅当设置了 CUSTOMPATH_SUPPORT_MARK_RESTORE
标志时才需要提供。
void (*RestrPosCustomScan) (CustomScanState *node);
恢复由 MarkPosCustomScan
回调保存的先前扫描位置。此回调是可选的,仅当设置了 CUSTOMPATH_SUPPORT_MARK_RESTORE
标志时才需要提供。
Size (*EstimateDSMCustomScan) (CustomScanState *node, ParallelContext *pcxt);
估计并行操作所需的动态共享内存量。这可能高于实际使用的数量,但不能低于实际使用的数量。返回值以字节为单位。此回调是可选的,仅当此自定义扫描提供程序支持并行执行时才需要提供。
void (*InitializeDSMCustomScan) (CustomScanState *node, ParallelContext *pcxt, void *coordinate);
初始化并行操作所需的动态共享内存。coordinate
指向一个大小等于 EstimateDSMCustomScan
返回值的共享内存区域。此回调是可选的,仅当此自定义扫描提供程序支持并行执行时才需要提供。
void (*ReInitializeDSMCustomScan) (CustomScanState *node, ParallelContext *pcxt, void *coordinate);
当自定义扫描计划节点即将重新扫描时,重新初始化并行操作所需的动态共享内存。此回调是可选的,仅当此自定义扫描提供程序支持并行执行时才需要提供。建议的做法是此回调仅重置共享状态,而 ReScanCustomScan
回调仅重置本地状态。目前,此回调将在 ReScanCustomScan
之前被调用,但最好不要依赖该顺序。
void (*InitializeWorkerCustomScan) (CustomScanState *node, shm_toc *toc, void *coordinate);
基于领导者在 InitializeDSMCustomScan
期间设置的共享状态,初始化并行工作程序的本地状态。此回调是可选的,仅当此自定义扫描提供程序支持并行执行时才需要提供。
void (*ShutdownCustomScan) (CustomScanState *node);
当预计节点不会执行完成时,释放资源。并非在所有情况下都会调用此方法;有时,可能会在没有先调用此函数的情况下调用 EndCustomScan
。由于并行查询使用的 DSM 段在调用此回调后立即销毁,因此希望在 DSM 段消失之前采取一些操作的自定义扫描提供程序应实现此方法。
void (*ExplainCustomScan) (CustomScanState *node, List *ancestors, ExplainState *es);
为自定义扫描计划节点的 EXPLAIN
输出附加信息。此回调是可选的。即使没有此回调,也会显示存储在 ScanState
中的常见数据,例如目标列表和扫描关系,但是此回调允许显示额外的私有状态。
如果您在文档中看到任何不正确、与特定功能的体验不符或需要进一步澄清的内容,请使用此表单报告文档问题。