DB2 10.5 for Linux, UNIX, and Windows

SUBSTR function - Return a portion of a large object

The SUBSTR function provides the capability to return a portion of a large object.

The function returns a BLOB(32767) (for a BLOB) or VARCHAR (for a CLOB) value for the returned portion of the large object read by the function.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-DBMS_LOB.SUBSTR--(--lob_loc--+--------------------------+---->
                                '-,--amount--+-----------+-'   
                                             '-,--offset-'     

>--)-----------------------------------------------------------><

Parameters

lob_loc
An input argument of type BLOB(10M) or CLOB(10M) that specifies the large object locator of the large object to be read.
amount
An optional input argument of type INTEGER that specifies the number of bytes or characters to be returned. The default value is 32,767.
offset
An optional input argument of type INTEGER that specifies the position within the large object to begin returning data. The first byte or character is at position 1. The default value is 1.

Authorization

EXECUTE privilege on the DBMS_LOB module.