Idris2Doc : Oracle.FFI.Lob

Oracle.FFI.Lob

(source)

Definitions

prim__dataLob : AnyPtr -> PrimIO AnyPtr
  Retrieve the LOB handle stored inside a dpiData value.

Parameters:
- dpiData pointer

Returns:
- dpiLob pointer.
- NULL if no LOB is present.

The returned LOB handle is owned by the statement row and must not be released with `oracle_lob_release`.
prim__lobSize : AnyPtr -> PrimIO Int64
  Retrieve the byte size of a LOB.

Returns:
- Size of the LOB.
- Negative value on failure.
prim__lobRead : AnyPtr -> Int64 -> Int64 -> PrimIO String
  Read bytes from a BLOB.

Parameters:
- LOB handle
- offset
- length

Returns:
- Allocated buffer containing the data.

The returned buffer must be released with `oracle_lob_free_buffer`.
prim__clobRead : AnyPtr -> PrimIO String
  Read a CLOB as UTF-8 text.

The returned string is allocated by the C layer and must be released.
prim__lobRelease : AnyPtr -> PrimIO ()
  Release a LOB handle.