2025年9月25日: PostgreSQL 18 发布!
支持的版本: 当前 (18) / 17 / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0

SPI_cursor_open_with_paramlist

SPI_cursor_open_with_paramlist — 使用参数设置游标

概要

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 报告。

提交更正

如果您在文档中发现任何不正确之处、与您对特定功能的实际体验不符之处,或需要进一步说明之处,请使用 此表单 报告文档问题。