ora-lob-load-from-file Function

Summary

Loads data from a file LOB into a LOB.

Package

sql

Signature

ora-lob-load-from-file dest-lob-locator src-lob-file amount &key src-offset dest-offset errorp

Arguments

dest-lob-locator⇩	An internal LOB locator.
src-lob-file⇩	A file LOB locator.
amount⇩	A non-negative integer.
src-offset⇩	A non-negative integer.
dest-offset⇩	A non-negative integer.
errorp⇩	A generalized boolean.

Description

The function ora-lob-load-from-file loads the data from src-lob-file into the destination LOB pointed to by dest-lob-locator.

The source LOB must be a BFILE and the destination must be an internal LOB.

The details of the operation are determined by amount, src-offset and dest-offset. amount and dest-offset are in characters for CLOB/NCLOB and are in bytes for BLOB. src-offset is in bytes. The offsets start from 1. The default value of dest-offset is 1 and the default value of src-offset is 1.

No conversion is performed by ora-lob-load-from-file, so if the destination is a CLOB/NCLOB, the source must already be in the right format.

If an error occurs and errorp is true, an error is signaled. If errorp is false, the function returns an object of type sql-database-error. The default value of errorp is nil.

Notes

1. This is a direct call to OCILobLoadFromFile. The Oracle documentation is ambiguous on whether it is mandatory to open the source LOB before calling this function.
2. ora-lob-load-from-file is available only when the "oracle" module is loaded. See the section 23.11 Oracle LOB interface for more information.

See also

ora-lob-copy