SPI_prepare

PostgreSQL 16.0文書
		47.1. インタフェース関数	誤訳等の報告
前へ	上へ	SPI_prepare_params	次へ

SPI_prepare_params

SPI_prepare_params <refpurpose>prepare a statement, without executing it yet</refpurpose> — 文を準備する。まだ実行は行わない

概要

SPIPlanPtr SPI_prepare_params(const char * command,
                              ParserSetupHook parserSetup,
                              void * parserSetupArg,
                              int cursorOptions)

説明

<title>Description</title>

<function>SPI_prepare_params</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_cursor</function>, with the addition that the caller can specify parser hook functions to control the parsing of external parameter references. SPI_prepare_paramsは指定したコマンドの準備済み文を作成し返します。しかしそのコマンドを実行しません。この関数はSPI_prepare_cursorと同じですが、呼び出し元が外部パラメータ参照の解析を制御するパーサフック関数を指定できる点が追加されています。

This function is now deprecated in favor of <function>SPI_prepare_extended</function>. この関数はSPI_prepare_extendedのため現在では廃止予定です。

引数

<title>Arguments</title>

const char * command: command string コマンド文字列
ParserSetupHook parserSetup: Parser hook setup function パーサフック設定関数
void * parserSetupArg: pass-through argument for <parameter>parserSetup</parameter> parserSetupに渡される引数
int cursorOptions: integer bit mask of cursor options; zero produces default behavior カーソルオプションの整数ビットマスク。ゼロはデフォルトの動作を引き起こします

戻り値

<title>Return Value</title>

<function>SPI_prepare_params</function> has the same return conventions as <function>SPI_prepare</function>. SPI_prepare_paramsはSPI_prepareと同じ戻り値の規則を持ちます。

前へ	上へ	次へ
SPI_prepare_extended	ホーム	SPI_getargcount