历史版本。 PostgreSQL 8.1 已结束支持。 请参阅 当前版本手册.
SPI_cursor_open
SPI_cursor_open — 使用由 SPI_prepare 创建的计划建立一个游标
大纲
Portal SPI_cursor_open(const char *name, void *plan, Datum *values, const char *nulls, boolread_only)
描述
SPI_cursor_open 建立一个游标(在内部是一个
portal),该游标将执行由 SPI_prepare 准备好的一个计划。参数具有和 SPI_execute_plan 的相应参数相同的含义。
使用游标而不是直接执行该计划有两个好处。首先,可以一次只取出少量结果行,从而避免对返回大量行的查询耗尽内存。其次,一个 portal 可以比当前的过程存活更久(实际上,它可以一直存活到当前事务结束)。把 portal 的名称返回给该过程的调用者,就提供了一种把行集作为结果返回的方法。
参数
const char *nameportal 的名称,或为
NULL以让系统选择名称void *plan执行计划(由
SPI_prepare返回)Datum *values一个实际参数值的数组。必须与该计划的参数个数等长。
const char *nulls一个描述哪些参数为空值的数组。必须与该计划的参数个数等长。
n表示空值(values中的对应项会被忽略);空格表示非空值(values中的对应项有效)。如果
nulls为NULL,则SPI_cursor_open假定没有参数为空值。boolread_onlytrue表示只读执行
返回值
指向包含该游标的 portal 的指针;出错时为NULL。