Redrock Postgres 搜索 英文
版本: 14 / 15 / 16

SPI_prepare_extended

SPI_prepare_extended — 准备语句,还没有执行它

大纲

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相同的返回约定。