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