pg_lo_unlink

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

pg_lo_unlink — ラージオブジェクトを削除する

説明

pg_lo_unlink(PgSql\Connection $connection, int $oid): bool

pg_lo_unlink()は、oidで関連付けられたラージオブジェクトを削除します。成功した場合に true を、失敗した場合に false を返します。

ラージオブジェクトインターフェイスは、トランザクションブロックの中で使用する必要があります。

注意:
この関数は、以前は pg_lounlink() と呼ばれていました。

パラメータ

connection

PgSql\Connection クラスのインスタンス。 connection が指定されない場合は、デフォルトの接続を使います。デフォルトの接続とは、pg_connect() または pg_pconnect() によって確立された直近の接続です。

警告

PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。

oid

データベース内のラージオブジェクトの OID 。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン	説明
8.1.0	`connection` は、PgSql\Connection クラスのインスタンスを期待するようになりました。これより前のバージョンでは、リソースを期待していました。

例

例1 pg_lo_unlink() の例

<?php
   // 削除するラージオブジェクトの OID
   $doc_oid = 189762345;
   $database = pg_connect("dbname=jacarta");
   pg_query($database, "begin");
   pg_lo_unlink($database, $doc_oid);
   pg_query($database, "commit");
?>

参考

pg_lo_create() - ラージオブジェクトを生成する
pg_lo_import() - ファイルからラージオブジェクトをインポートする