| PostgreSQL 9.6.0 手册 | |||
|---|---|---|---|
| 上一页 | 上一级 | 章 57. 编写一个自定义扫描提供者 | 下一页 |
在执行一个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 (*InitializeWorkerCustomScan) (CustomScanState *node,
shm_toc *toc,
void *coordinate);基于领导者中由InitializeDSMCustomScan设置的共享状态初始化并行工作者的自定义状态。这个回调是可选的，只有在这个自定义扫描提供者支持并行执行时才必须提供这个回调。
void (*ExplainCustomScan) (CustomScanState *node,
List *ancestors,
ExplainState *es);为一个自定义扫描计划节点的EXPLAIN输出额外的信息。这个回调函数是可选的。即使没有这个回调函数，被存储在ScanState中的公共的数据（例如目标列表和扫描关系）也将被显示，但是该回调函数允许显示额外的信息（例如私有状态）。