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

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 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4
开发快照。 PostgreSQL 20devel 尚未正式发布,内容仍可能变化。

SPI_cursor_open

SPI_cursor_open — 使用由 SPI_prepare 创建的语句建立一个游标

大纲

Portal SPI_cursor_open(const char * name, SPIPlanPtr plan,
                       const Datum * values, const char * nulls,
                       bool read_only)

描述

SPI_cursor_open 建立一个游标(在内部是一个 portal),该游标将执行由 SPI_prepare 准备好的一个语句。参数具有和 SPI_execute_plan 的相应参数相同的含义。

使用游标而不是直接执行该语句有两个好处。首先,可以一次只取出少量结果行,从而避免对返回大量行的查询耗尽内存。其次,一个 portal 可以比当前的 C 函数存活更久(实际上,它可以一直存活到当前事务结束)。把 portal 的名称返回给该 C 函数的调用者,就提供了一种把行集作为结果返回的方法。

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

参数

const char * name

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

SPIPlanPtr plan

预备语句(由 SPI_prepare 返回)

Datum * values

一个实际参数值的数组。必须和语句的参数数量等长。

const char * nulls

一个描述哪些参数为空值的数组。必须和语句的参数数量等长。

如果 nulls 为 NULL,则 SPI_cursor_open 会假定没有参数为空值。否则,如果对应参数值非空值,则 nulls 数组中的对应项应为 ' ';如果对应参数值为空值,则对应项应为 'n'。(后一种情况下,对应 values 项中的实际值无关紧要。)注意,nulls 不是文本字符串,而只是一个数组,因此不需要 '\0' 终止符。

bool read_only

true 表示只读执行

返回值

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

报告文档问题

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