16.20 - Maximum-LOB-bytes-per-field - Teradata Tools and Utilities

Teradata® Call-Level Interface Version 2 Reference for Mainframe-Attached Systems

prodname
Teradata Tools and Utilities
vrm_release
16.20
created_date
September 2019
category
Programming Reference
featnum
B035-2417-108K

Maximum-LOB-bytes-per-field is an eight-byte unsigned integer that specifies the maximum sized Large-object, in bytes, selected from a row for which Teradata Database is permitted to return data inline, overriding a DBCAREA Return-objects-as option to defer data by returning a locator. Whether Teradata Database supports this feature can be ascertained using the DBCHQE Integrated-LOB query QERILSU value. The Maximum-LOB-bytes-per-field value does not include the length of the standard 8-byte Database prefix for LOB datatypes: only the actual amount of data should be included.

Maximum-LOB-bytes-per-field exists only when DBCHINI had been called for a DBCAREA with Total-length set to at least 1024 (that is, the returned DBCAREA Level value is at least 2). For a smaller DBCAREA, Maximum-LOB-bytes-per-field is taken to be zero.

Language Maximum-LOB-bytes-per-field
COBOL LOB-FIELD-LIMIT
C, C++ lobFieldLimit
PL/I LOB_Field_Limit
IBM Assembler DBRIMLSZ
Routine Action for Maximum LOB Bytes
DBCHINI writes
DBCHCL reads (IRQ;IWPF)
Maximum-LOB-bytes-per-field is used by... To...
applications read

If Maximum-LOB-bytes-per-field is zero, no additional limit is placed on the length of the field. The limit will instead be the Row Limit (if specified), the limit of a message size, or other DBS limit.

If Maximum-LOB-bytes-per-field exceeds a database server limit, an error will be issued by the server.

If both Maximum-LOB-bytes-per-row and Maximum-LOB-bytes-per-field are zero, the specified DBCAREA Return-objects-as option will determine how Large-objects are returned.

Even when Teradata Database supports this feature and all limits are satisfied, Teradata Database may still elect not to override a DBCAREA Return-objects-as specification to defer Large-object data by returning a locator.