September 26, 2024: PostgreSQL 17 Released!
Unsupported versions: 7.4 / 7.3 / 7.2 / 7.1
This documentation is for an unsupported version of PostgreSQL.
You may want to view the same page for the current version, or one of the other supported versions listed above instead.

pg_lo_read

Name

pg_lo_read -- read from a large object

Synopsis

pg_lo_read conn descriptor bufVar len

Description

pg_lo_read reads at most len bytes from a large object into a variable named bufVar.

Arguments

conn

The handle of a connection to the database in which the large object exists.

descriptor

A descriptor for the large object from pg_lo_open.

bufVar

The name of a buffer variable to contain the large object segment.

len

The maximum number of bytes to read.

Return Value

The number of bytes actually read is returned; this could be less than the number requested if the end of the large object is reached first. In event of an error, the return value is negative.