pg_lo_export

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

pg_lo_export — ラージオブジェクトをファイルにエクスポートする

説明

function pg_lo_export(PgSql\Connection $connection = ?, int $oid, string $filename): bool

pg_lo_export() は PostgreSQL データベースからラージオブジェクトを取得し、その内容をローカルファイルシステム上のファイルに保存します。

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

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

パラメータ

connection

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

警告

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

oid

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

filename

ラージオブジェクトをクライアントのファイルシステムに書き込む際のフルパスとファイル名。

戻り値

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

変更履歴

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

例

例1 pg_lo_export() の例

<?php
   $database = pg_connect("dbname=jacarta");
   pg_query($database, "begin");
   $oid = pg_lo_create($database);
   $handle = pg_lo_open($database, $oid, "w");
   pg_lo_write($handle, "large object data");
   pg_lo_close($handle);
   pg_lo_export($database, $oid, '/tmp/lob.dat');
   pg_query($database, "commit");
?>

参考

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

関連キーワード:

ラージ export database connection 接続エクスポート PgSql Connection handle create import PostgreSQL filename データベースファイルシステムインスタンス connect 期待 query ローカルインターフェイストランザクションブロック loexport pconnect