SPI_cursor_open_with

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

SPI_cursor_open_with_paramlist

SPI_cursor_open_with_paramlist <refpurpose>set up a cursor using parameters</refpurpose> — パラメータを使ってカーソルを設定する

概要

Portal SPI_cursor_open_with_paramlist(const char *name,
                                      SPIPlanPtr plan,
                                      ParamListInfo params,
                                      bool read_only)

説明

<title>Description</title>

<function>SPI_cursor_open_with_paramlist</function> sets up a cursor (internally, a portal) that will execute a statement prepared by <function>SPI_prepare</function>. This function is equivalent to <function>SPI_cursor_open</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_cursor_open_with_paramlistはSPI_prepareで準備された文を実行するカーソル(内部的にはポータル)を設定します。この関数はSPI_cursor_openと同じですが、問い合わせに渡されるパラメータ値に関する情報が別途存在することが異なります。 ParamListInfo表現は、すでに利用可能な形式で値を渡すために便利です。またParamListInfoで指定されたフック関数経由での動的なパラメータ群の使用をサポートします。

The passed-in parameter data will be copied into the cursor's portal, so it can be freed while the cursor still exists. 渡されるパラメータデータはカーソルのポータルにコピーされます。そのため、カーソルが存在している間にそのデータを解放することができます。

引数

<title>Arguments</title>

const char * name: name for portal, or <symbol>NULL</symbol> to let the system select a name ポータルの名前、あるいはシステムに名前を決定させる場合はNULL
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

戻り値

<title>Return Value</title>

Pointer to portal containing the cursor. Note there is no error return convention; any error will be reported via <function>elog</function>. カーソルを含むポータルへのポインタ。戻り値の規約にはエラーを表すものがないことに注意してください。エラーはすべてelog経由で報告されます。

前へ	上へ	次へ
SPI_cursor_open_with_args	ホーム	SPI_cursor_parse_open