2024年9月26日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3

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的数组的指针

int cursorOptions

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

返回值

SPI_prepare_cursorSPI_prepare 具有相同的返回值约定。

注意

cursorOptions 中设置的有用位包括 CURSOR_OPT_SCROLL, CURSOR_OPT_NO_SCROLL, CURSOR_OPT_FAST_PLAN, CURSOR_OPT_GENERIC_PLANCURSOR_OPT_CUSTOM_PLAN。特别注意 CURSOR_OPT_HOLD 被忽略。

提交更正

如果您在文档中看到任何不正确的内容,与您对特定功能的体验不符或需要进一步说明,请使用 此表格 报告文档问题。