SPI_execute_plan_with

PostgreSQL 17.0文書
		45.1. インタフェース関数	誤訳等の報告
前へ	上へ	SPI_execute_plan_with_paramlist	次へ

SPI_execute_plan_with_paramlist

SPI_execute_plan_with_paramlist <refpurpose>execute a statement prepared by <function>SPI_prepare</function></refpurpose> — SPI_prepareで準備された文を実行する

概要

int SPI_execute_plan_with_paramlist(SPIPlanPtr plan,
                                    ParamListInfo params,
                                    bool read_only,
                                    long count)

説明

<title>Description</title>

<function>SPI_execute_plan_with_paramlist</function> executes a statement prepared by <function>SPI_prepare</function>. This function is equivalent to <function>SPI_execute_plan</function> except that information about the parameter values to be passed to the query is presented differently. The <literal>ParamListInfo</literal> representation can be convenient for passing down values that are already available in that format. It also supports use of dynamic parameter sets via hook functions specified in <literal>ParamListInfo</literal>. SPI_execute_plan_with_paramlistはSPI_prepareで準備された文を実行します。この関数はSPI_execute_planと同じですが、問い合わせに渡されるパラメータ値に関する情報が別途存在する点が異なります。 ParamListInfo表現は、すでに利用可能な形式で値を渡すために便利です。またParamListInfoで指定されたフック関数経由での動的なパラメータ群の使用をサポートします。

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

引数

<title>Arguments</title>

SPIPlanPtr plan: prepared statement (returned by <function>SPI_prepare</function>) （SPI_prepareで返される）準備済み文
ParamListInfo params: data structure containing parameter types and values; NULL if none パラメータの型と値からなるデータ構造。なければNULL。
bool read_only: <para><literal>true</literal> for read-only execution</para>
読み取りのみの実行の場合true
long count: maximum number of rows to return, or <literal>0</literal> for no limit 返される行の最大数。無制限なら0。

戻り値

<title>Return Value</title>

The return value is the same as for <function>SPI_execute_plan</function>. 戻り値はSPI_execute_planと同じです。

<varname>SPI_processed</varname> and <varname>SPI_tuptable</varname> are set as in <function>SPI_execute_plan</function> if successful. 成功時、SPI_processedとSPI_tuptableがSPI_execute_plan同様に設定されます。

前へ	上へ	次へ
SPI_execute_plan_extended	ホーム	SPI_execp