2025年9月25日: PostgreSQL 18 发布!
支持的版本: 当前 (18) / 17 / 16 / 15 / 14
开发版本: devel

SPI_prepare_extended

SPI_prepare_extended — 准备一个语句,但暂不执行

概要

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

描述

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

参数

const char * command

command string

const SPIPrepareOptions * options

包含可选参数的结构体

调用者应始终将整个 options 结构体清零,然后填充他们想要设置的字段。这确保了代码的向前兼容性,因为在未来添加到该结构体中的任何字段都将被定义为如果它们为零时,则以向后兼容的方式运行。目前可用的 options 字段有:

ParserSetupHook parserSetup

解析器钩子设置函数

void * parserSetupArg

传递给 parserSetup 的透传参数

RawParseMode parseMode

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

int cursorOptions

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

返回值

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

提交更正

如果您在文档中看到任何不正确、与您对特定功能的体验不符或需要进一步澄清的内容,请使用 此表单 报告文档问题。