历史版本。 PostgreSQL 8.4 已结束支持。 请参阅 当前版本手册.
SPI_cursor_open_with_args
SPI_cursor_open_with_args — 使用一个查询和参数建立一个游标
大纲
Portal SPI_cursor_open_with_args(const char *name, const char *command, intnargs, Oid *argtypes, Datum *values, const char *nulls, boolread_only, intcursorOptions)
描述
SPI_cursor_open_with_args建立一个将执行指定查询的游标(在内部是一个 portal)。大部分参数具有和
SPI_prepare_cursor
和SPI_cursor_open中相应参数相同的含义。
对于一次性查询执行,应优先使用此函数,而不是先调用
SPI_prepare_cursor 再调用
SPI_cursor_open。如果同一条命令要用许多不同参数执行,哪种方法更快取决于重新规划的代价与定制计划收益之间的权衡。
传入的参数数据会被复制到该游标的 portal 中,因此即使该游标仍然存在,也可以释放这些参数数据。
参数
const char *nameportal 的名称,或为
NULL以让系统选择名称const char *command命令字符串
intnargs输入参数的数量(
$1、$2等)Oid *argtypes一个数组,包含各参数数据类型的 OID
Datum *values一个实际参数值的数组
const char *nulls一个描述哪些参数为空值的数组
如果
nulls为NULL,则SPI_cursor_open_with_args假定没有参数为空值。boolread_onlytrue表示只读执行intcursorOptions整数形式的游标选项位掩码,零会导致默认行为
返回值
指向包含该游标的 portal 的指针。注意这里没有错误返回约定,任何错误都将通过elog报告。