2024年9月26日: PostgreSQL 17 发布!
支持的版本:当前 (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

命令字符串

const SPIPrepareOptions * options

包含可选参数的结构体

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

ParserSetupHook parserSetup

解析器钩子设置函数

void * parserSetupArg

传递给 parserSetup 的参数

RawParseMode parseMode

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

int cursorOptions

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

返回值

SPI_prepare_extendedSPI_prepare 具有相同的返回值约定。

提交更正

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