PostgreSQL 中文参考文档
🌐 英文原版 官方 ↗

SPI_prepare_extended

SPI_prepare_extended — 准备一条语句,但还不执行它

Synopsis

SPIPlanPtr SPI_prepare_extended(const char * command,
                                const SPIPrepareOptions * options)

描述

SPI_prepare_extended 为指定的命令创建并 返回一个预备语句,但不执行该命令。 这个函数等价于 SPI_prepare, 此外调用者还可以指定选项来控制对外部参数引用的解析, 以及查询解析和规划的其他方面。

参数

const char * command

命令字符串

const SPIPrepareOptions * options

包含可选参数的结构

调用者应当始终把整个 options 结构清零,然后填入想设置的字段。 这确保代码的前向兼容性,因为将来加入该结构的任何字段 都会被定义为在为零时以向后兼容的方式行事。 当前可用的 options 字段有:

ParserSetupHook parserSetup

解析器钩子建立函数

void * parserSetupArg

传给 parserSetup 的透传参数

RawParseMode parseMode

原始解析模式; RAW_PARSE_DEFAULT(零) 产生默认行为

int cursorOptions

游标选项的整数位掩码;零产生默认行为

返回值

SPI_prepare_extended 具有与 SPI_prepare 相同的返回约定。