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

SPI_execute_plan_extendedSPI_prepareで準備された文を実行する

概要

int SPI_execute_plan_extended(SPIPlanPtr plan,
                              const SPIExecuteOptions * options)

説明

SPI_execute_plan_extendedSPI_prepareもしくは類似の関数で準備された文を実行します。 この関数は、問い合わせに渡すパラメータ値に関する情報が異なる形で存在する点と追加の実行制御オプションを渡せる点を除いてSPI_execute_planと等価です。

問い合わせパラメータ値はParamListInfo構造体で表現されていますので、既にその形で利用可能な値を渡すには便利です。 ParamListInfoで指定されたフック関数経由で、動的なパラメータ群も使うことができます。

また、結果タプルを必ずSPI_tuptable構造体に蓄積する代わりに、エクゼキュータにより生成された時にタプルを呼び出し元が提供するDestReceiverオブジェクトに渡すことができます。 データがメモリに蓄積される代わりにその場で処理されるので、多数のタプルを生成する問い合わせに対して特に有用です。

引数

SPIPlanPtr plan

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

const SPIExecuteOptions * options

オプションの引数を含む構造体

呼び出し元は、必ずoptions構造体全体をゼロクリアしてから、設定したいフィールドを埋めるべきです。 構造体に将来追加されるフィールドは、ゼロであれば後方互換性があるように振る舞うよう定義されますので、これはコードの将来の互換性を確実にします。 現在利用可能なoptionsフィールドは以下の通りです。

ParamListInfo params

問い合わせパラメータの型と値を含むデータ構造。なければNULL

bool read_only

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

bool allow_nonatomic

trueでCALLとDO文の非原子的実行を許可します

bool must_return_tuples

trueであれば、問い合わせがタプルを返す種類のものでない場合にエラーを発生します(これはたまたま0個のタプルを返す場合を禁止しません)

uint64 tcount

返される行の最大数、無制限の場合には0

DestReceiver * dest

問い合わせが出すタプルを受け取るDestReceiverオブジェクト。 NULLなら、SPI_execute_planのように、結果タプルはSPI_tuptable構造体に蓄積されます。

ResourceOwner owner

実行中、計画の参照カウントを保持するリソース所有者。 NULLならCurrentResourceOwnerが使われます。 SPIは保存されない計画の参照カウントを取得しませんので、保存されない計画に対しては無視されます。

戻り値

戻り値はSPI_execute_planと同じです。

options->destがNULLであれば、SPI_processedSPI_tuptableSPI_execute_planと同様に設定されます。 options->destがNULLでなければ、SPI_processedはゼロに設定され、SPI_tuptableはNULLに設定されます。 タプルの集計が必要なら、呼び出し元のDestReceiverオブジェクトが計算しなければなりません。