php8.5
Home/ Manual/ pgsql / functions/ pg_lo_export

pg_lo_export

PHP function Edit on GitHub ✎

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

Export a large object to file

Description

pg_lo_export([PgSql\Connection $connection], int $oid, string $filename): bool

pg_lo_export() takes a large object in a PostgreSQL database and saves its contents to a file on the local filesystem.

To use the large object interface, it is necessary to enclose it within a transaction block.

Note

This function used to be called pg_loexport().

Parameters

connection

Connection-with-unspecified-default

oid

The OID of the large object in the database.

filename

The full path and file name of the file in which to write the large object on the client filesystem.

Return Values

Success

Changelog

VersionDescription

Examples

pg_lo_export() example

php
<?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");
?>

See Also

Source: reference/pgsql/functions/pg-lo-export.xml · from the official PHP manual (php/doc-en)