# SPI_光标_打开

SPI_光标_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 函数的调用者提供了一种将行集作为结果返回的方法。

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

# 论据

常量字符 * *姓名*

门户名称,或空值让系统选择一个名字

SPIPlanPtr *计划*

准备好的语句(由SPI_prepare)

基准 * *价值观*

一组实际参数值。必须具有与语句的参数数量相同的长度。

常量字符 * *空值*

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

如果*空值空值然后SPI_cursor_open假定没有参数为空。否则,每个条目空值数组应该是' '如果相应的参数值不为空,或者'n'如果对应的参数值为空。(在后一种情况下,对应的实际值价值观输入无关紧要。)请注意空值*不是文本字符串,只是一个数组:它不需要'\0'终结者。

布尔 *只读*

真的用于只读执行

# 返回值

指向包含光标的门户的指针。注意没有错误返回约定;任何错误都会通过elog.