ora-lob-erase Function

Summary

Erases part of an internal LOB.

Package

sql

Signature

ora-lob-erase lob-locator offset amount &key errorp => erased

Arguments

lob-locator⇩	A LOB locator.
offset⇩	A non-negative integer.
amount⇩	A non-negative integer.
errorp⇩	A generalized boolean.

Values

erased⇩

A non-negative integer.

Description

The function ora-lob-erase erases part of the LOB pointed to by lob-locator. That is, it fills part of the LOB with 0 for BLOBs or spaces for CLOBs.

The operation starts from offset offset into the LOB and erases amount of data in the LOB, or to the end of the LOB. Note that the offset starts from 1, and that offset and amount are in characters for CLOBs and bytes for BLOB.

Erasing does not extend beyond the end of the LOB. The return value erased is the number of characters or bytes erased. erased will be smaller than amount if the sum of offset and amount is greater than the length of the LOB.

ora-lob-erase is applicable to internal LOBs only.

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 OCILobErase.
2. ora-lob-erase is available only when the "oracle" module is loaded. See the section 23.11 Oracle LOB interface for more information.