他のバージョンの文書 15 | 14 | 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_execute_plan

名前

SPI_execute_plan -- SPI_prepareで準備された文を実行する

概要

int SPI_execute_plan(SPIPlanPtr plan, Datum * values, const char * nulls,
                     bool read_only, long count)

説明

SPI_execute_planは、SPI_prepareもしくは類似の関数で準備された文を実行します。 read_onlycountSPI_executeと同様の解釈がなされます。

引数

SPIPlanPtr plan

SPI_prepareで返される)準備済み文

Datum * values

実パラメータ値の配列。 文の引数の数と同じ長さでなければなりません

const char * nulls

どのパラメータがNULLであるかを示す配列。 文の引数の数と同じ長さでなければなりません。

nullsNULLの場合、SPI_execute_planは全てのパラメータがNULLではないとみなします。 さもなければ、nulls配列の各項目は、対応するパラメータが非NULLならば' '、対応するパラメータがNULLならば'n'です。 (後者の場合、values内の対応する値は注意されません。) nullsはテキスト文字列ではなく単なる配列であることに注意してください。 '\0'終端は必要ありません。

bool read_only

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

long count

返される行の最大数。無制限なら0。

戻り値

戻り値は、SPI_execute同様のものに加え、以下のエラー(負)の結果を取ることがあります。

SPI_ERROR_ARGUMENT

planNULLまたは無効、あるいは、countが0未満の場合

SPI_ERROR_PARAM

valuesNULL、かつ、planがパラメータ付きで準備された場合

成功時、SPI_processedSPI_tuptableSPI_execute同様に設定されます。