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_only
只读执行时为true
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_tuptable
结构体中,如SPI_execute_plan
中一样
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
对象必须计算它。
如果您在文档中看到任何不正确的内容,与您对特定功能的体验不符,或者需要进一步澄清,请使用此表单报告文档问题。