ADMIN_IS_INLINED function - Determine if data is inlined

The ADMIN_IS_INLINED function retrieves state information about inline data for an XML column, BLOB column, CLOB column, or DBCLOB column.

Syntax

The schema is SYSIBM.

Return value

This function returns one of the following values of type SMALLINT, or the null value:

1: Indicates that the data is inlined.
0: Indicates that the data is not inlined.
NULL: Indicates that the inputs are NULL.

Function parameters

column-name: Identifies a column of the base table with a data type of XML, BLOB, CLOB, or DBCLOB (SQLSTATE 42884). The column must directly or indirectly reference the column of a base table that is not generated based on an expression (SQLSTATE 42815).

Example

Example 1: The following example indicates whether the three XML documents in the XML column xml_doc1 of the TAB1 table are inlined:

db2 => SELECT PK, ADMIN_IS_INLINED(xml_doc1) as IS_INLINED
       from TAB1

This query results in the following output:

PK          IS_INLINED
----------- -------------------
          1                   1
          2                   0
          3                   0

   3 record(s) selected.

Example 2: The following example indicates whether one of the XML documents in the XML column xml_doc1 of the TAB1 table is inlined:

db2 => SELECT PK, ADMIN_IS_INLINED(xml_doc1) as IS_INLINED 
       from TAB1 where PK=1

This query results in the following output:

PK          IS_INLINED
----------- -------------------
          1                   1
 
  1 record(s) selected.

Example 3: The following example indicates whether the three CLOB data contained in the CLOB column clob_1 of the TAB1 table are inlined:

db2 => SELECT PK, ADMIN_IS_INLINED(clob_1) as IS_INLINED
       from TAB1

This query results in the following output:

PK          IS_INLINED
----------- -------------------
          1                   0
          2                   0
          3                   1

   3 record(s) selected.