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

SPI_prepare_extended — 文を準備する。文の実行はまだ行わない

概要

SPIPlanPtr SPI_prepare_extended(const char * command,
                                const SPIPrepareOptions * options)

説明

SPI_prepare_extendedは指定したコマンド用の準備済み文を作成し、それを返します。しかし、そのコマンドは実行しません。 この関数は、呼び出し元が、問い合わせの解析や計画のその他の面だけでなく、外部のパラメータ参照の解析も制御するオプションを指定できる追加機能のあるSPI_prepareと等価です。

引数

const char * command

コマンド文字列

const SPIPrepareOptions * options

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

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

ParserSetupHook parserSetup

パーサフック設定関数

void * parserSetupArg

parserSetupに渡される引数

RawParseMode parseMode

raw解析のモード。 RAW_PARSE_DEFAULT(ゼロ)はデフォルトの振舞いになります

int cursorOptions

カーソルオプションの整数ビットマスク。ゼロはデフォルトの振舞いになります

戻り値

SPI_prepare_extendedSPI_prepareと同じ戻り値の規則を持ちます。