PostgreSQL Programmer's Guide
PrevNext

SPI_finish

Name

SPI_finish — ユーザ手続きを SPI マネージャから切り離す。

SPI_finish(void)

入力

None

出力

int

SPI_OK_FINISH 正常に切り離された場合
SPI_ERROR_UNCONNECTED 未接続の手続きから呼ばれた場合

説明

SPI_finish は接続済の Postgres バックエンドへの 接続を切り離しします。 SPI マネージャを使った操作を終了したらこの関数を 呼ぶようにしてください。

有効な接続が存在しない状態でSPI_finish が 呼ばれた場合SPI_ERROR_UNCONNECTED が返ります。 このエラーコードについては特に問題はありません。 SPI マネージャは何もしなかったということです。

使い方

SPI_finish必ず 接続済の手続きの最後の段階で呼び出さなければなりません。 さもないと、予測不可能の結果が起きるかも知れません! ただし(elog(ERROR)によって)トランザクションをアボートした場合には 問題無くSPI_finish の呼び出しを 省略することができます。

アルゴリズム

SPI_finish は以下のことを行います。

ユーザ手続きを SPI マネージャから切り離し、その手続きが SPI_connect を呼び出して以来 palloc によって獲得したメモリを開放します。 このメモリはもはや使うことができません!メモリ管理の項を 御覧ください。


PrevHomeNext
SPI_connectUpSPI_exec