PostgreSQL 9.0.0文書
前のページ | 巻戻し |  | 早送り | 次のページ

# 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_HOLD`は無視される点に注意してください。

前のページ | ホーム | 次のページ
SPI_prepare | 上に戻る | SPI_prepare_params