Postgresql 中文操作指南

SPI_prepare_extended

SPI_prepare_extended — 准备语句而不执行

Synopsis

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

Description

SPI_prepare_extended 针对指定命令创建并返回一个已准备的语句，但不会执行该命令。此函数相当于 SPI_prepare ，此外，调用方还可以指定选项来控制对外部参数引用的解析以及查询解析和规划的其他方面。

Arguments

  • const char * _command_

    • command string

  • const SPIPrepareOptions * _options_

    • struct containing optional arguments

调用者应始终将整个 options 结构清零，然后填写任何他们想要设置的字段。这样可以确保代码的前向兼容性，因为将来添加到结构中的任何字段都被定义为在为零时向后兼容地工作。当前可用的 options 字段为：

  • ParserSetupHook _parserSetup_

    • Parser hook setup function

  • void * _parserSetupArg_

    • pass-through argument for parserSetup

  • RawParseMode _parseMode_

    • 用于原始解析的模式； RAW_PARSE_DEFAULT （零）产生默认行为

  • int _cursorOptions_

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

Return Value

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