Home/ Manual/ pgsql / functions/ pg_lo_open

pg_lo_open

PHP function Edit on GitHub ✎

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

Open a large object

Description

pg_lo_open(PgSql\Connection $connection, int $oid, string $mode): PgSql\Lob|false

pg_lo_open() opens a large object in the database and returns an PgSql\Lob instance so that it can be manipulated.

Warning

Do not close the database connection before closing the PgSql\Lob instance.

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

Note

This function used to be called pg_loopen().

Parameters

connection: Connection-with-unspecified-default
oid: The OID of the large object in the database.
mode: Can be either "r" for read-only, "w" for write only or "rw" for read and write.

Return Values

An PgSql\Lob instance, Falseforfailure.

Changelog

Version	Description
8.1.0	Returns an `PgSql\Lob` instance now; previously, a Resource was returned.

Examples

pg_lo_open() example

php

<?php
   $database = pg_connect("dbname=jacarta");
   pg_query($database, "begin");
   $oid = pg_lo_create($database);
   echo "$oid\n";
   $handle = pg_lo_open($database, $oid, "w");
   echo "$handle\n";
   pg_lo_write($handle, "large object data");
   pg_lo_close($handle);
   pg_query($database, "commit");
?>