17.10 - getLength(int index) - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)

If a table function with dynamic result row specification calls Tbl.getColDef(), and the value of an element in the resulting array corresponds to a CHAR, BYTE, CHARACTER CHARACTER SET GRAPHIC, VARCHAR CHARACTER SET GRAPHIC, VARCHAR, VARBYTE or NUMBER data type, the table function can use getLength() to get the length of the data type.

Syntax

getLength(int index)

Syntax Elements

index
Index of array element whose length is to be returned.

Exceptions

If the index argument specifies an array element that is not a CHAR, BYTE, CHARACTER CHARACTER SET GRAPHIC, VARCHAR CHARACTER SET GRAPHIC, VARCHAR, VARBYTE or NUMBER column, getLength() throws an SQLException to indicate that Tbl.getLength(int) is invalid for the type of column intended, setting the SQLException fields as follows.

SQLState Field vendorCode Field
“TS000” 7848