SPI_cursor_open
SPI_cursor_open — 使用由 SPI_prepare 创建的语句建立一个游标
大纲
Portal SPI_cursor_open(const char *name, SPIPlanPtrplan, Datum *values, const char *nulls, boolread_only)
描述
SPI_cursor_open 建立一个游标(在内部是一个
portal),该游标将执行由 SPI_prepare 准备好的一个语句。参数具有和 SPI_execute_plan 的相应参数相同的含义。
使用游标而不是直接执行该语句有两个好处。首先,可以一次只取出少量结果行,从而避免对返回大量行的查询耗尽内存。其次,一个 portal 可以比当前的过程存活更久(实际上,它可以一直存活到当前事务结束)。把 portal 的名称返回给该过程的调用者,就提供了一种把行集作为结果返回的方法。
传入的参数数据会被复制到该游标的 portal 中,因此即使该游标仍然存在,也可以释放这些参数数据。
参数
const char *nameportal 的名称,或为
NULL以让系统选择名称SPIPlanPtrplan预备语句(由
SPI_prepare返回)Datum *values一个实际参数值的数组。必须和语句的参数数量等长。
const char *nulls一个描述哪些参数为空值的数组。必须和语句的参数数量等长。
如果
nulls为NULL,则SPI_cursor_open会假定没有参数为空值。否则,如果对应参数值非空值,则nulls数组中的对应项应为' ';如果对应参数值为空值,则对应项应为'n'。(后一种情况下,对应values项中的实际值无关紧要。)注意,nulls不是文本字符串,而只是一个数组,因此不需要'\0'终止符。boolread_onlytrue表示只读执行
返回值
指向包含该游标的 portal 的指针。注意这里没有错误返回约定,任何错误都将通过 elog 报告。