2025年9月25日: PostgreSQL 18 发布!
支持的版本:当前18)/ 17 / 16 / 15 / 14 / 13
开发版本:devel
不支持的版本:12 / 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

command string

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 被忽略。

提交更正

如果您在文档中发现任何不正确之处、与您对特定功能的体验不符之处或需要进一步澄清之处,请使用此表格报告文档问题。