↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发中的版本: 19 / 20devel
已结束支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0
历史版本。 PostgreSQL 9.1 已结束支持。 2016-10-27. 请参阅 当前版本手册.

SPI_cursor_open_with_paramlist

SPI_cursor_open_with_paramlist — set up a cursor using parameters

大纲

Portal SPI_cursor_open_with_paramlist(const char *name,
                                      SPIPlanPtr plan,
                                      ParamListInfo params,
                                      bool read_only)

描述

SPI_cursor_open_with_paramlist 建立一个游标(在内部是一个 portal),该游标将执行由 SPI_prepare 准备好的计划。该函数等价于 SPI_cursor_open,只是向查询传递参数值信息的形式不同。ParamListInfo 表示形式便于传递已经按这种格式存在的值,也支持通过 ParamListInfo 中指定的钩子函数使用动态参数集。

传入的参数数据会被复制到该游标的 portal 中,因此即使该游标仍然存在,也可以释放这些参数数据。

参数

const char * name

portal 的名称,或为NULL以让系统选择名称

SPIPlanPtr plan

执行计划(由 SPI_prepare 返回)

ParamListInfo params

包含参数类型和值的数据结构;没有参数时为 NULL

bool read_only

true 表示只读执行

返回值

指向包含该游标的 portal 的指针。注意这里没有错误返回约定,任何错误都将通过elog报告。

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.