受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: devel

SPI_cursor_open

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

Synopsis

Portal SPI_cursor_open(const char * name, SPIPlanPtr plan,
                       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

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

如果nullsNULL, 那么SPI_cursor_open会假设没有参数 为空值。否则,如果对应的参数值为非空, nulls 数组的每一个项都应该是' ';如果对应参数值为空, nulls数组的项应为'n'(在后 面的情况中,对应的values项中的值没有 关系)。注意nulls不是一个文本字符串, 它只是一个数组:它不需要一个'\0'终止符。

bool read_only

true 表示只读执行

返回值

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

提交更正

如果您发现文档中有不正确的内容、与您使用特定功能的经验不符或需要进一步说明,请使用此表单来报告文档问题。