SPI_cursor_open_with_args

Name

SPI_cursor_open_with_args -- 使用查询和参数设置一个游标

Synopsis

Portal SPI_cursor_open_with_args(const char *name,
                                 const char *command,
                                 int nargs, Oid *argtypes,
                                 Datum *values, const char *nulls,
                                 bool read_only, int cursorOptions)

描述

SPI_cursor_open_with_args设置一个游标（内部的，一个入口）， 该游标将执行指定的查询。大多数参数和SPI_prepare_cursor 和SPI_cursor_open的对应参数有相同的含义。

对于一次性查询执行，跟着SPI_cursor_open的 SPI_prepare_cursor应该会偏爱这个函数。 如果相同的命令用不同的参数执行，哪种方法可能更快， 取决于重新规划的开销和自定义规划的益处的比较。

传入参数数据将被拷贝到游标的入口，所以它在游标仍然存在时可以被释放。

参数

const char * name

入口的名字，或NULL让系统选择一个名字

const char * command

命令字符串

int nargs

输入参数的个数 ($1, $2等等)

Oid * argtypes

长度nargs的一个数组，包括参数数据类型的OID

Datum * values

长度nargs的一个数组，包括实际的参数值

const char * nulls

长度nargs的一个数组，描述哪个参数为空

如果nulls是NULL，那么SPI_cursor_open_with_args 假设没有参数为空。否则，如果对应的参数值是非空的，那么nulls 数组的每一项都应该是' '，或者如果对应的参数值为空，那么 nulls数组的每一项都是'n'。 （在后面这种情况下，对应的values项中的实际值无关紧要。） 请注意，nulls不是文本字符串，只是一个数组： 它不需要'\0'终止符。

bool read_only

true用于只读的执行

int cursorOptions

游标选项的整型位标记；零表示缺省行为

返回值

指向包含游标入口的指针。请注意，这里没有错误返回约定； 任何错误都将通过elog报告。