PostgreSQL 中文参考文档
🌐 英文原版 官方 ↗

SPI_cursor_open_with_paramlist

SPI_cursor_open_with_paramlist — 用参数建立一个游标

Synopsis

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