dblink_close
名前
dblink_close -- リモートデータベースでカーソルを閉ざします
概要
dblink_close(text cursorname [, bool fail_on_error]) returns text
dblink_close(text connname, text cursorname [, bool fail_on_error]) returns text
説明
dblink_close
は前もってdblink_open
で開かれたカーソルを閉ざします。
引数
- conname
使用する接続の名前です。
無名の接続を使用する場合はこのパラメータを省略します。
- cursorname
閉ざすカーソルの名前です。
- fail_on_error
真(省略時のデフォルト)の場合、接続のリモート側で発生したエラーによりローカル側でもエラーが発生します。
偽の場合リモート側のエラーはローカル側にはNOTICEとして報告され、この関数の戻り値はERRORになります。
戻り値
状態、つまりOKまたはERRORを返します。
注釈
dblink_open
が明示的なトランザクションブロックを開始し、これが接続上で最後まで開き続けているカーソルであった場合、dblink_close
は対応するCOMMITを発行します。
例
SELECT dblink_connect('dbname=postgres');
dblink_connect
----------------
OK
(1 row)
SELECT dblink_open('foo', 'select proname, prosrc from pg_proc');
dblink_open
-------------
OK
(1 row)
SELECT dblink_close('foo');
dblink_close
--------------
OK
(1 row)