Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16 / 17

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

一个数组,描述哪些参数是 null。长度必须与语句的参数数量相同。

如果 nullsNULL ,则 SPI_cursor_open 假设没有参数为空。否则, nulls 数组中的每个条目如果对应的参数值不为空,则应为 ' ' ;如果对应的参数值为 null,则应为 'n' 。(在后一种情况下, values 条目中对应的实际值并不重要。)请注意, nulls 不是文本字符串,而只是一个数组:它不需要 '\0' 终止符。

bool read_only

true 适用于只读执行

返回值

指向包含游标的门户的指针。注意,没有错误返回惯例;任何错误都将通过 elog 报告。