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

# 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_cursor`と`SPI_cursor_open`に対応するパラメータと同じ意味を持っています。

１回限りの問い合わせ実行に対しては、後に`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かを記述する配列

  `nulls`が`NULL`であれば、`SPI_cursor_open_with_args`はどのパラメータもnullでないとみなします。

`bool `read_only``

  読み取りのみの実行の場合`true`

`int `cursorOptions``

  カーソルオプションの整数ビットマスク。ゼロの場合はデフォルトの動作

## 戻り値

カーソルを含んだポータルへのポインタ。 エラーを返す規約がないことに注意してください。 すべてのエラーは`elog`で報告されます。

前のページ | ホーム | 次のページ
SPI_cursor_open | 上に戻る | SPI_cursor_open_with_paramlist