pg_lo_write

pg_lo_write — Write to a large object

Synopsis

pg_lo_write conn descriptor buf len

Description

pg_lo_write writes at most len bytes from a variable buf to a large object.

Arguments

conn

The handle of the connection.

descriptor

A descriptor for the large object from pg_lo_open.

buf

The string to write to the large object (not a variable name, but the value itself).

len

The maximum number of bytes to write. The number written will be the smaller of this value and the length of the string.

Return Value

The number of bytes actually written is returned; this will ordinarily be the same as the number requested.

If an error occurs writing to the large object, a negative number will be returned. Other errors result in a Tcl error being thrown. Note that error handling for this command is different from most of the other Large Object commands.

Notes

All large object manipulation must take place within an SQL transaction block.

This command uses or emulates the PostgreSQL libpq function lo_write.

SourceForge.net Logo

This version of the manual was produced for the Pgtcl-ng Sourceforge project web service site, which requires the logo on each page.

To download a logo-free copy of the manual, see the Pgtcl-ng project downloads area.