SPI_prepare_extended <refpurpose>prepare a statement, without executing it yet</refpurpose> — 文を準備する。文の実行はまだ行わない
SPIPlanPtr SPI_prepare_extended(const char *command, const SPIPrepareOptions *options)
<function>SPI_prepare_extended</function> creates and returns a prepared
statement for the specified command, but doesn't execute the command.
This function is equivalent to <function>SPI_prepare</function>,
with the addition that the caller can specify options to control
the parsing of external parameter references, as well as other facets
of query parsing and planning.
SPI_prepare_extendedは指定したコマンド用の準備済み文を作成し、それを返します。しかし、そのコマンドは実行しません。
この関数は、呼び出し元が、問い合わせの解析や計画のその他の面だけでなく、外部のパラメータ参照の解析も制御するオプションを指定できる追加機能のあるSPI_prepareと等価です。
const char * commandcommand string コマンド文字列
const SPIPrepareOptions * optionsstruct containing optional arguments オプションの引数を含む構造体
Callers should always zero out the entire <parameter>options</parameter>
struct, then fill whichever fields they want to set. This ensures forward
compatibility of code, since any fields that are added to the struct in
future will be defined to behave backwards-compatibly if they are zero.
The currently available <parameter>options</parameter> fields are:
呼び出し元は、必ずoptions構造体全体をゼロクリアしてから、設定したいフィールドを埋めるべきです。
構造体に将来追加されるフィールドは、ゼロであれば後方互換性があるように振る舞うよう定義されますので、これはコードの将来の互換性を確実にします。
現在利用可能なoptionsフィールドは以下の通りです。
ParserSetupHook parserSetupParser hook setup function パーサフック設定関数
void * parserSetupArg
pass-through argument for <parameter>parserSetup</parameter>
parserSetupに渡される引数
RawParseMode parseMode
mode for raw parsing; <literal>RAW_PARSE_DEFAULT</literal> (zero)
produces default behavior
raw解析のモード。
RAW_PARSE_DEFAULT(ゼロ)はデフォルトの振舞いになります
int cursorOptionsinteger bit mask of cursor options; zero produces default behavior カーソルオプションの整数ビットマスク。ゼロはデフォルトの振舞いになります
<function>SPI_prepare_extended</function> has the same return conventions as
<function>SPI_prepare</function>.
SPI_prepare_extendedはSPI_prepareと同じ戻り値の規則を持ちます。