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

SPI_cursor_parse_open

SPI_cursor_parse_open — 使用查询字符串和参数设置游标

概要

Portal SPI_cursor_parse_open(const char *name,
                             const char *command,
                             const SPIParseOpenOptions * options)

描述

SPI_cursor_parse_open 设置一个游标(在内部,一个门户),它将执行指定的查询字符串。这类似于 SPI_prepare_cursor 后跟 SPI_cursor_open_with_paramlist,除了查询字符串中的参数引用完全由提供 ParamListInfo 对象来处理。

对于一次性查询执行,此函数应优先于 SPI_prepare_cursor 后跟 SPI_cursor_open_with_paramlist。如果要使用许多不同的参数执行相同的命令,则两种方法可能都更快,具体取决于重新规划的成本与自定义计划的好处的权衡。

options->params 对象通常应使用 PARAM_FLAG_CONST 标志标记每个参数,因为查询始终使用一次性计划。

传递的参数数据将被复制到游标的门户中,因此在游标仍然存在时可以释放它。

参数

const char * name

门户名称,或 NULL 让系统选择一个名称

const char * command

命令字符串

const SPIParseOpenOptions * options

包含可选参数的结构体

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

ParamListInfo params

包含查询参数类型和值的数据结构;如果无则为 NULL

int cursorOptions

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

bool read_only

true 表示只读执行

返回值

指向包含游标的门户的指针。请注意,没有错误返回约定;任何错误都将通过 elog 报告。

提交更正

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