★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_execute_with_args

名前

SPI_execute_with_args -- 外部からパラメータを渡してコマンドを実行します。

概要

int SPI_execute_with_args(const char *command,
                          int nargs, Oid *argtypes,
                          Datum *values, const char *nulls,
                          bool read_only, long count)

説明

SPI_execute_with_argsは外部から渡されるパラメータの参照を含むコマンドを実行します。 コマンドテキストはパラメータを$nとして参照し、呼び出しはそれぞれのそのような標識のデータ型と値を特定します。read_onlycountSPI_executeにおけるのと同じ解釈をします。

SPI_executeと比較して、このルーチンの主たる優位性は、データ値を面倒な引用やエスケープを要せずコマンドに埋め込むことができることで、従ってSQLインジェクション攻撃のリスクを少なくします。

後にSPI_execute_planが続いたSPI_prepareでも同様の結果が得られますが、この関数を使用するときには、提供された特定のパラメータ値に対して問い合わせ計画がカスタマイズされます。1回限りの問い合わせ実行に対しては、この関数を選ぶべきです。多くの異なったパラメータを持つ同一のコマンドが実行されると、再計画対独自計画による利益のコストに依存して、どちらか一方の方法がより早くなります。

引数

const char * command

コマンド文字列

int nargs

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

Oid * argtypes

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

Datum * values

実パラメータ値の配列

const char * nulls

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

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

bool read_only

読み出し専用実行では

long count

処理または返す行の最大数

Return Value

戻り値はSPI_executeと同じ

成功した場合SPI_processedSPI_tuptableSPI_executeでのように設定される