他のバージョンの文書10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

SPI_prepare_cursor

名前

SPI_prepare_cursor -- 文を準備する。まだ実行は行わない

概要

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

説明

SPI_prepare_cursorは、プランナの"カーソルオプション"パラメータを指定できる点を除き、SPI_prepareと同じです。 これはDeclareCursorStmtoptionsフィールド用にnodes/parsenodes.hで示された値を持つビットマスクです。 SPI_prepareでは常にカーソルオプションをゼロとして扱います。

引数

const char * command

コマンド文字列

int nargs

$1$2など)入力パラメータ数

Oid * argtypes

パラメータのデータ型のOIDを持つ配列へのポインタ

int cursorOptions

カーソルオプションの整数ビットマスク。 ゼロはデフォルトの動作を引き起こします

戻り値

SPI_prepare_cursorSPI_prepareと同じ戻り値の規則を持ちます。

注釈

cursorOptionsに指定できるビットには、CURSOR_OPT_SCROLLCURSOR_OPT_NO_SCROLLCURSOR_OPT_FAST_PLANCURSOR_OPT_GENERIC_PLANCURSOR_OPT_CUSTOM_PLANがあります。 特にCURSOR_OPT_HOLDは無視される点に注意してください。