SPI_cursor_open

SPI_cursor_open — 使用SPI_prepare创建的语句设置游标

语法

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

说明

SPI_cursor_open设置一个游标（在内部，一个门户），它将执行由SPI_prepare准备的语句。这些参数与SPI_execute_plan的相应参数具有相同的含义。

使用游标而不是直接执行语句有两个好处。首先，可以一次检索几行结果，避免为返回多行的查询造成内存溢出。其次，一个门户可以比当前 C 函数存活更长时间（事实上，它可以一直存活到当前事务结束）。将门户名称返回给 C 函数的调用者提供了一种将行集作为结果返回的方法。

传入的参数数据将复制到游标的门户中，因此在游标仍然存在时可以释放它。

参数

const char * name

门户名称，或 NULL 以便让系统选择一个名称

SPIPlanPtr plan

已准备的语句（由 SPI_prepare 返回）

Datum * values

实际参数值数组。必须与语句的参数数量相同。

const char * nulls

描述哪些参数为空的数组。必须与语句的参数数量相同。

如果 nulls 为 NULL，则 SPI_cursor_open 假设没有参数为空。否则，如果相应的参数值不为空，则 nulls 数组的每个条目应为 ' '；如果相应的参数值为空，则应为 'n'。（在后一种情况下，相应的 values 条目中的实际值无关紧要。）请注意，nulls 不是文本字符串，而只是一个数组：它不需要 '\0' 终止符。

bool read_only

true 表示只读执行

返回值

包含游标的门户指针。请注意，没有错误返回约定；任何错误都将通过elog报告。