Function

Summary

Writes the contents of a LOB into a file.

Package

sql

Signature

ora-lob-read-into-plain-file lob-locator file-name &key offset file-offset if-exists

Arguments

lob-locator

A LOB locator.

file-name

A pathname designator.

offset

A non-negative integer, or nil.

file-offset

A non-negative integer, or nil.

if-exists

A keyword or nil.

Description

The function ora-lob-read-into-plain-file writes the contents of a LOB into a file.

file-name specifies the file to write, which should be a standard file. The file is always opened in a binary mode, so if the LOB is a CLOB, the file will be generated in the right format when reading it from the LOB.

offset is the offset into the LOB from where to start reading. It starts from 1, counts characters in a CLOB, and if it is nil then the operation starts from the end of the previous read operation. The default value of offset is nil.

file-offset specifies the offset into the file to start the operation from. If file-offset is nil then it starts writing at the start of the file. The default value of file-offset is nil.

if-exists is passed to open when opening the file, with the standard Common Lisp meaning. The default value of if-exists is :error.

Notes

ora-lob-read-into-plain-file is available only when the "oracle" module is loaded. See the section Oracle LOB interface for more information.

See also

ora-lob-write-from-plain-file