受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: devel

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 相同。

提交更正

如果您发现文档中有不正确的内容、与您使用特定功能的经验不符或需要进一步说明,请使用此表单来报告文档问题。