SPI_connect

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

SPI_connect, SPI_connect_ext <refpurpose>connect a C function to the SPI manager</refpurpose> — SPIマネージャにC関数を接続する

概要

int SPI_connect(void)

int SPI_connect_ext(int options)

説明

<title>Description</title>

<function>SPI_connect</function> opens a connection from a C function invocation to the SPI manager. You must call this function if you want to execute commands through SPI. Some utility SPI functions can be called from unconnected C functions. SPI_connectはC関数の呼び出しからSPIマネージャへの接続を開きます。 SPIを経由してコマンドを実行させる場合、この関数を呼び出さなければなりません。 SPIユーティリティ関数の中には、未接続のC関数から呼び出し可能なものがあります。

<function>SPI_connect_ext</function> does the same but has an argument that allows passing option flags. Currently, the following option values are available: SPI_connect_extは同様に動作しますが、オプションフラグを渡せる引数を一つもちます。今のところ以下のオプション値が使えます。

SPI_OPT_NONATOMIC: Sets the SPI connection to be <firstterm>nonatomic</firstterm>, which means that transaction control calls (<function>SPI_commit</function>, <function>SPI_rollback</function>) are allowed. Otherwise, calling those functions will result in an immediate error. SPI接続を非原子的になるように設定します。これはトランザクション制御呼び出し(SPI_commit、SPI_rollback)が可能であることを意味します。このフラグなしで、これら関数を呼び出すと即座にエラーになります。

<literal>SPI_connect()</literal> is equivalent to <literal>SPI_connect_ext(0)</literal>. SPI_connect()はSPI_connect_ext(0)と同義です。

戻り値

<title>Return Value</title>

SPI_OK_CONNECT: on success 成功した場合。
SPI_ERROR_CONNECT: on error エラーが発生した場合。