pg_lo_write
(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)
pg_lo_write — Write to a large object
Description
pg_lo_write() writes data into a large object at the current seek position.
To use the large object interface, it is necessary to enclose it within a transaction block.
Note:
This function used to be called pg_lowrite().
Parameters
-
lob -
An PgSql\Lob instance, returned by pg_lo_open().
-
data -
The data to be written to the large object. If
lengthis an int and is less than the length ofdata, onlylengthbytes will be written. -
length -
An optional maximum number of bytes to write. Must be greater than zero and no greater than the length of
data. Defaults to the length ofdata.
Return Values
The number of bytes written to the large object, or false on error.
Changelog
| Version | Description |
|---|---|
| 8.1.0 |
The lob parameter expects an PgSql\Lob
instance now; previously, a resource was expected.
|
| 8.0.0 |
length is now nullable.
|
Examples
Example #1 pg_lo_write() example
<?php
$doc_oid = 189762345;
$data = "This will overwrite the start of the large object.";
$database = pg_connect("dbname=jacarta");
pg_query($database, "begin");
$handle = pg_lo_open($database, $doc_oid, "w");
$data = pg_lo_write($handle, $data);
pg_query($database, "commit");
?>
