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

pg_lo_import

PHP function Edit on GitHub ✎

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

Import a large object from file

Description

pg_lo_import([PgSql\Connection $connection], string $filename, [int|string $oid]): int|string|false

pg_lo_import() creates a new large object in the database using a file on the filesystem as its data source.

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

Note

This function used to be called pg_loimport().

Parameters

connection

Connection-with-unspecified-default

filename

The full path and file name of the file on the client filesystem from which to read the large object data.

oid

If an oid is given the function will try to create a large object with this id, else a free object id is assigned by the server. The parameter relies on functionality that first appeared in PostgreSQL 8.1.

Return Values

The OID of the newly created large object, Falseforfailure.

Changelog

VersionDescription

Examples

pg_lo_import() example

php
<?php
   $database = pg_connect("dbname=jacarta");
   pg_query($database, "begin");
   $oid = pg_lo_import($database, '/tmp/lob.dat');
   pg_query($database, "commit");
?>

See Also

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