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

SPI_prepare_cursor

SPI_prepare_cursor — 准备一个语句,但暂不执行

Synopsis

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

描述

SPI_prepare_cursorSPI_prepare 相同,但额外允许指定规划器的 游标选项参数。该参数是一个位掩码,其可取值对应于 nodes/parsenodes.hDeclareCursorStmtoptions 字段。SPI_prepare 总是把游标选项设为零。

此函数现已废弃,推荐改用 SPI_prepare_extended

参数

const char * command

命令字符串

int nargs

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

Oid * argtypes

指向数组的指针,该数组包含参数数据类型的 OID

int cursorOptions

整数形式的游标选项位掩码,零会导致默认行为

返回值

SPI_prepare_cursor 的返回约定与 SPI_prepare 相同。

注解

适合在 cursorOptions 中设置的位包括 CURSOR_OPT_SCROLLCURSOR_OPT_NO_SCROLLCURSOR_OPT_FAST_PLANCURSOR_OPT_GENERIC_PLANCURSOR_OPT_CUSTOM_PLAN。需要特别注意的是, CURSOR_OPT_HOLD 会被忽略。