pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
SPI_cursor_open — 使用由 SPI_prepare 创建的语句建立一个游标
Portal SPI_cursor_open(const char *name, SPIPlanPtrplan, const Datum *values, const char *nulls, boolread_only)
SPI_cursor_open 建立一个游标(在内部是一个 portal),该游标将执行由 SPI_prepare 准备好的一个语句。参数具有和 SPI_execute_plan 的相应参数相同的含义。
使用游标而不是直接执行该语句有两个好处。首先,可以一次只取出少量结果行,从而避免对返回大量行的查询耗尽内存。其次,一个 portal 可以比当前的 C 函数存活更久(实际上,它可以一直存活到当前事务结束)。把 portal 的名称返回给该 C 函数的调用者,就提供了一种把行集作为结果返回的方法。
传入的参数数据会被复制到该游标的 portal 中,因此即使该游标仍然存在,也可以释放这些参数数据。
const char * nameportal 的名称,或为 NULL 以让系统选择名称
SPIPlanPtr plan预备语句(由 SPI_prepare 返回)
Datum * values一个实际参数值的数组。必须和语句的参数数量等长。
const char * nulls一个描述哪些参数为空值的数组。必须和语句的参数数量等长。
如果 nulls 为 NULL,则 SPI_cursor_open 会假定没有参数为空值。否则,如果对应参数值非空值,则 nulls 数组中的对应项应为 ' ';如果对应参数值为空值,则对应项应为 'n'。(后一种情况下,对应 values 项中的实际值无关紧要。)注意,nulls 不是文本字符串,而只是一个数组,因此不需要 '\0' 终止符。
bool read_onlytrue 表示只读执行
指向包含该游标的 portal 的指针。注意这里没有错误返回约定,任何错误都将通过 elog 报告。
译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游会在正式发布前持续修订。