DBMS_LOB v11
The DBMS_LOB package provides the capability to operate on large objects. The following table lists the supported functions and procedures:
| Function/Procedure | Return Type | Description |
|---|---|---|
APPEND(dest_lob IN OUT, src_lob) | n/a | Appends one large object to another. |
COMPARE(lob_1, lob_2 [, amount [, offset_1 [, offset_2 ]]]) | INTEGER | Compares two large objects. |
CONVERTOBLOB(dest_lob IN OUT, src_clob, amount, dest_offset IN OUT, src_offset IN OUT, blob_csid, lang_context IN OUT, warning OUT) | n/a | Converts character data to binary. |
CONVERTTOCLOB(dest_lob IN OUT, src_blob, amount, dest_offset IN OUT, src_offset IN OUT, blob_csid, lang_context IN OUT, warning OUT) | n/a | Converts binary data to character. |
COPY(dest_lob IN OUT, src_lob, amount [, dest_offset [, src_offset ]]) | n/a | Copies one large object to another. |
ERASE(lob_loc IN OUT, amount IN OUT [, offset ]) | n/a | Erase a large object. |
GET_STORAGE_LIMIT(lob_loc) | INTEGER | Get the storage limit for large objects. |
GETLENGTH(lob_loc) | INTEGER | Get the length of the large object. |
INSTR(lob_loc, pattern [, offset [, nth ]]) | INTEGER | Get the position of the nth occurrence of a pattern in the large object starting at offset |
READ(lob_loc, amount IN OUT, offset, buffer OUT) | n/a | Read a large object. |
SUBSTR(lob_loc [, amount [, offset ]]) | RAW, VARCHAR2 | Get part of a large object. |
TRIM(lob_loc IN OUT, newlen) | n/a | Trim a large object to the specified length. |
WRITE(lob_loc IN OUT, amount, offset, buffer) | n/a | Write data to a large object. |
WRITEAPPEND(lob_loc IN OUT, amount, buffer) | n/a | Write data from the buffer to the end of a large object. |
Advanced Server's implementation of DBMS_LOB is a partial implementation when compared to Oracle's version. Only those functions and procedures listed in the table above are supported.
The following table lists the public variables available in the package.
| Public Variables | Data Type | Value |
|---|---|---|
compress off | INTEGER | 0 |
compress_on | INTEGER | 1 |
deduplicate_off | INTEGER | 0 |
deduplicate_on | INTEGER | 4 |
default_csid | INTEGER | 0 |
default_lang_ctx | INTEGER | 0 |
encrypt_off | INTEGER | 0 |
encrypt_on | INTEGER | 1 |
file_readonly | INTEGER | 0 |
lobmaxsize | INTEGER | 1073741823 |
lob_readonly | INTEGER | 0 |
lob_readwrite | INTEGER | 1 |
no_warning | INTEGER | 0 |
opt_compress | INTEGER | 1 |
opt_deduplicate | INTEGER | 4 |
opt_encrypt | INTEGER | 2 |
warn_inconvertible_char | INTEGER | 1 |
In the following sections, lengths and offsets are measured in bytes if the large objects are BLOBs. Lengths and offsets are measured in characters if the large objects are CLOBs.
append compare converttoblob converttoclob copy erase get_storage_limit getlength instr read substr trim write writeappend