PostgreSQL 9.4.4 中文手册
上一页 | 上一级 |  | 下一页

# SPI_prepare_cursor

## 名称

SPI_prepare_cursor -- 准备一个语句但不立即执行它

## 大纲

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

## 描述

`SPI_prepare_cursor`和`SPI_prepare`相同， 除了它也允许说明规划器的"游标选项"参数。这是一个位掩码， 让`DeclareCursorStmt`的`options`字段拥有 `nodes/parsenodes.h`中显示的值。`SPI_prepare` 总是将游标选项看做零。

## 参数

`const char * `command``

  命令字符串

`int `nargs``

  输入参数的个数(`$1`, `$2`等等)

`Oid * `argtypes``

  一个指针，指向一个包含参数数据类型的OID的数组

`int `cursorOptions``

  游标选项的整数位标记；零表示缺省行为

## 返回值

`SPI_prepare_cursor`有和`SPI_prepare` 一样的返回约定。

## 注意

`cursorOptions`中的有效位包括`CURSOR_OPT_SCROLL`、 `CURSOR_OPT_NO_SCROLL`、`CURSOR_OPT_FAST_PLAN`、 `CURSOR_OPT_GENERIC_PLAN`和`CURSOR_OPT_CUSTOM_PLAN`。 特别要注意忽略了`CURSOR_OPT_HOLD`。

上一页 | 起始页 | 下一页
SPI_prepare | 上一级 | SPI_prepare_params