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 可以比当前的 C 函数存活更长时间(实际上,它可以存活到当前事务结束)。将 portal 名称返回给 C 函数的调用者,提供了一种将行集作为结果返回的方式。
传入的参数数据将被复制到游标的 portal 中,因此可以在游标仍然存在时释放这些数据。
const char * nameportal 的名称,如果为 NULL,则由系统选择名称
SPIPlanPtr plan已准备好的语句(由 SPI_prepare 返回)
Datum * values实际参数值的数组。长度必须与语句的参数数量相同。
const char * nulls描述哪些参数为 NULL 的数组。长度必须与语句的参数数量相同。
如果 nulls 为 NULL,则 SPI_cursor_open 假定没有参数为 NULL。否则,nulls 数组的每个条目如果对应的参数值非 NULL,则应为 ' ',如果对应的参数值为 NULL,则应为 'n'。(后一种情况,values 中对应条目的实际值无关紧要。)请注意,nulls 不是一个文本字符串,而只是一个数组:它不需要 '\0' 终止符。
bool read_only只读执行时为 true
指向包含游标的 portal 的指针。请注意,没有错误返回约定;任何错误都将通过 elog 报告。