Postgresql 中文操作指南

SPI_prepare_cursor

SPI_prepare_cursor — 准备一个语句，但不执行它

Synopsis

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

Description

SPI_prepare_cursor 与 SPI_prepare 相同，区别在于它还允许指定计划程序的“游标选项”参数。这是一种位掩码，它具有 nodes/parsenodes.h 中所示的值，用于 DeclareCursorStmt 的 options 字段。 SPI_prepare 始终将游标选项视为零。

此函数现已弃用，建议使用 SPI_prepare_extended 。

Arguments

  • const char * _command_

    • command string

  • int _nargs_

    • 输入参数数（ $1 、 $2 等）

  • Oid * _argtypes_

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

  • int _cursorOptions_

    • 游标选项的整数位掩码；零产生默认行为

Return Value

SPI_prepare_cursor 具有与 SPI_prepare 相同的返回约定。

Notes

方便设置在 cursorOptions 中的位包括 CURSOR_OPT_SCROLL 、 CURSOR_OPT_NO_SCROLL 、 CURSOR_OPT_FAST_PLAN 、 CURSOR_OPT_GENERIC_PLAN 和 CURSOR_OPT_CUSTOM_PLAN 。特别是，请注意 CURSOR_OPT_HOLD 已被忽略。