★PostgreSQLカンファレンス2021 11月12日開催/チケット販売中★
他のバージョンの文書 13 | 12 | 11 | 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_cursor_open_with_args

名前

SPI_cursor_open_with_args -- 問い合わせとパラメータを使ってカーソルを設定

概要

Portal SPI_cursor_open_with_args(const char *name,
                                 const char *command,
                                 int nargs, Oid *argtypes,
                                 Datum *values, const char *nulls,
                                 bool read_only, int cursorOptions)

説明

SPI_cursor_open_with_argsは特定の問い合わせを実行するカーソル(内部的にはポータル)を設定します。殆んどのパラメータには、SPI_prepare_cursorSPI_cursor_openに関連したパラメータと同じ意味を持っています。

1回限りの問い合わせ実行に対しては、後にSPI_cursor_openが続いたSPI_prepare_cursorに対し、この関数を選ぶべきです。多くの異なったパラメータを持つ同一のコマンドが実行されると、再計画対独自計画による利益のコストに依存して、どちらか一方の方法がより早くなります。

渡されたデータはカーソルのポータルに複写されるので、カーソルが存在している間は開放することができます。

引数

const char * name

ポータルの名前、またはシステムに名前を選択させるNULL

const char * command

コマンド文字列

int nargs

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

Oid * argtypes

パラメータのデータ型のOIDを含む配列

Datum * values

実パラメータ値の配列

const char * nulls

どのパラメータがnullかを記述する配列

nullsNULLであれば、SPI_cursor_open_with_argsはどのパラメータもnullでないと看做す

bool read_only

読み出し専用実行では

int cursorOptions

カーソル位置の整数ビットマスク。ゼロの場合はデフォルトの動作

戻り値

カーソルを含んだポータルへのポインタ。エラーを返す慣例がないことに注意。すべてのエラーはelogで報告。