Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16 / 17

SPI_prepare_cursor

SPI_prepare_cursor — 准备一条语句,而不执行它

语法

SPIPlanPtr SPI_prepare_cursor(const char * command, int nargs,
                              Oid * argtypes, int cursorOptions)

描述

SPI_prepare_cursorSPI_prepare 相同,只不过还可以指定计划程序的 游标选项 参数。这是一个位掩码,其值如 nodes/parsenodes.h 中所述,针对 DeclareCursorStmtoptions 字段。 SPI_prepare 总将游标选项设为零。

现在弃用这个函数,建议使用 SPI_prepare_extended

参数

const char * command

命令字符串

int nargs

输入参数数量($1$2 等)

Oid * argtypes

指向包含以下内容的数组的指针OID参数数据类型的 s

int cursorOptions

光标选项的整数位掩码;零产生默认行为

返回值

SPI_prepare_cursorSPI_prepare 具有相同的返回约定。

注释

可在 cursorOptions 中设置的实用位包括 CURSOR_OPT_SCROLLCURSOR_OPT_NO_SCROLLCURSOR_OPT_FAST_PLANCURSOR_OPT_GENERIC_PLANCURSOR_OPT_CUSTOM_PLAN。特别是,请注意会忽略 CURSOR_OPT_HOLD