lob-stream Class

Summary

The LOB stream class.

Package

sql

Superclasses

buffered-stream

Initargs

:lob-locator	A LOB locator.
:direction	One of :input or:output.
:free-lob-locator-on-close
	A generalized boolean.

Accessors

lob-stream-lob-locator

Description

The class lob-stream implements LOB streams in the Oracle LOB interface.

A lob-stream for input can be returned from select or query by specifying :input-stream as the type to return for the LOB column.

A lob-stream for output can be returned from select or query by specifying :output-stream as the type to return for the LOB column.

A lob-stream can be attached to an existing LOB locator by creating the stream explicitly.

direction specifies whether the stream is for input or output. The default value of direction is :input.

By default, if the stream is closed the LOB locator is freed, unless free-lob-locator-on-close is passed as nil. The default value of free-lob-locator-on-close is t.

Examples

This creates an input stream connected to the LOB locator lob-locator:

(make-instance 'lob-stream :lob-locator lob-locator)

See also

query
select