SPI_execute_extended — 行外のパラメータを持つコマンドを実行する
int SPI_execute_extended(const char *command, const SPIExecuteOptions *options)
SPI_execute_extendedは外部から供給されるパラメータへの参照を含むコマンドを実行します。
コマンドテキストはパラメータを$として参照し、noptions->paramsオブジェクトは(供給されれば)こうしたシンボル毎にデータ型と値を提供します。
様々な実行オプションをoptions構造体にも指定できます。
その問い合わせに対しては一度限りの計画が必ず使われますので、options->paramsオブジェクトは通常各パラメータにPARAM_FLAG_CONSTフラグをつけるべきです。
options->destがNULLでなければ、結果タプルは、SPI_tuptableに蓄積される代わりに、エグゼキュータにより生成された時にそのオブジェクトに渡されます。
データがメモリに蓄積される代わりにその場で処理されるので、呼び出し元が提供するDestReceiverオブジェクトを使うことは、多数のタプルを生成する問い合わせに対して特に有用です。
const char * commandコマンド文字列
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のように、結果タプルはSPI_tuptable構造体に蓄積されます。
ResourceOwner owner
このフィールドはSPI_execute_plan_extendedとの一貫性のために存在しますが、無視されます。SPI_execute_extendedが使う計画は決して保存されないからです。
戻り値はSPI_executeと同じです。
options->destがNULLであれば、SPI_processedとSPI_tuptableはSPI_executeと同様に設定されます。
options->destがNULLでなければ、SPI_processedはゼロに設定され、SPI_tuptableはNULLに設定されます。
タプルの集計が必要なら、呼び出し元のDestReceiverオブジェクトが計算しなければなりません。