SPI_execute_plan_extended — 执行由
SPI_prepare 预备的语句
int SPI_execute_plan_extended(SPIPlanPtrplan, const SPIExecuteOptions *options)
SPI_execute_plan_extended 执行由
SPI_prepare 或其同类函数预备的
语句。
这个函数等价于
SPI_execute_plan,
只是关于要传给查询的参数值的信息以不同的方式呈现,
并且可以传入额外的控制执行的选项。
查询参数值用一个
ParamListInfo 结构表示,
这便于传递已经以该格式可用的值。
也可以通过在
ParamListInfo 中指定的钩子函数使用动态
参数集。
此外,与总是把结果元组累积到
SPI_tuptable 结构不同,
元组可以在执行器生成它们时被传给一个调用者提供的
DestReceiver 对象。
这对可能生成许多元组的查询特别有帮助,
因为数据可以被即时处理而不必在内存中累积。
SPIPlanPtr plan
预备语句(由
SPI_prepare 返回)
const SPIExecuteOptions * options包含可选参数的结构
调用者应当始终把整个
options
结构清零,然后填入想设置的字段。
这确保代码的前向兼容性,因为将来加入该结构的任何字段
都会被定义为在为零时以向后兼容的方式行事。
当前可用的
options 字段有:
ParamListInfo params包含查询参数类型和值的数据结构;没有则为 NULL
bool read_onlytrue 表示只读执行
bool allow_nonatomic
为
true 允许以非原子方式执行 CALL 和 DO
语句(但除非把
SPI_OPT_NONATOMIC 标志传给了
SPI_connect_ext,否则此字段会被
忽略)
bool must_return_tuples
如果为
true,当查询不是会返回元组的种类时抛出
错误(这不禁止它恰好返回零个元组的情形)
uint64 tcount
要返回的最大行数,
0 表示没有限制
DestReceiver * dest
将接收查询发出的任何元组的
DestReceiver 对象;如果为 NULL,
结果元组会像在
SPI_execute_plan 中那样被累积到一个
SPI_tuptable 结构中
ResourceOwner owner将在计划执行期间持有该计划引用计数的资源所有者。 如果为 NULL,使用 CurrentResourceOwner。 对非保存的计划忽略此项,因为 SPI 不会为它们获取引用 计数。
返回值与
SPI_execute_plan 相同。
当
options->dest 为 NULL 时,
SPI_processed 和
SPI_tuptable 的设置方式与
SPI_execute_plan 相同。
当
options->dest 不为 NULL 时,
SPI_processed 被设为零,
SPI_tuptable 被设为 NULL。
如果需要元组计数,调用者的
DestReceiver 对象必须自行计算。