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
设置一个游标(内部是一个门户),它将执行指定的查询。大多数参数的含义与 SPI_prepare_cursor
和 SPI_cursor_open
的相应参数相同。
对于一次性查询执行,此函数应优先于 SPI_prepare_cursor
后跟 SPI_cursor_open
。如果要使用许多不同的参数执行相同的命令,则这两种方法中的任何一种都可能更快,具体取决于重新规划的成本与自定义计划的好处。
传入的参数数据将被复制到游标的门户中,因此可以在游标仍然存在时释放它。
此函数现在已弃用,建议使用 SPI_cursor_parse_open
,它使用更现代的 API 来处理查询参数,提供等效的功能。
const char * name
门户的名称,如果为 NULL
,则让系统选择一个名称
const char * command
命令字符串
int nargs
输入参数的数量($1
、$2
等)
Oid * argtypes
长度为 nargs
的数组,包含参数的数据类型的OIDs
Datum * values
长度为 nargs
的数组,包含实际的参数值
const char * nulls
长度为 nargs
的数组,描述哪些参数为空
如果 nulls
为 NULL
,则 SPI_cursor_open_with_args
假设没有参数为空。否则,nulls
数组的每个条目都应为 ' '
如果相应的参数值不为空,或者 'n'
如果相应的参数值为空。(在后一种情况下,相应 values
条目中的实际值无关紧要。)请注意,nulls
不是文本字符串,而只是一个数组:它不需要 '\0'
终止符。
bool read_only
对于只读执行,为 true
int cursorOptions
游标选项的整数位掩码;零产生默认行为
指向包含游标的门户的指针。请注意,没有错误返回约定;任何错误都将通过 elog
报告。
如果您在文档中发现任何不正确、与您使用特定功能的经验不符或需要进一步澄清的内容,请使用此表单报告文档问题。