16.20 - com.teradata.fnc.operator.MetaData - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
16.20
Release Date
April 2020
Content Type
Programming Reference
Publication ID
B035-1147-162K
Language
English (United States)

Purpose

The com.teradata.fnc.operator.MetaData class provides a means to describe metadata information about all of the columns in an input stream to a table operator.

Methods

The com.teradata.fnc.operator.MetaData class implements the methods of the java.sql.ResultSetMetaData interface. It also provides the additional four methods.

getJSONFormat(int)

byte getJSONFormat(int  column)
   throws SQL Exception

Returns the storage format of the JSON column.

getPeriodType(int)

int getPeriodType(int  column)
   throws SQL Exception
Returns the Period value for the column. The following are the valid values for the Period type value:
NOT_PERIOD = 0
    PERIOD_DATE = 1
    PERIOD_TIME = 2
    PERIOD_TIME_WTZ =3
    PERIOD_TIMESTAMP = 4
    PERIOD_TIMESTAMP_WTZ = 5

The method throws SQLException if an error occurs while attempting to access the Period type information.

getTeradataColumnType(int)

int getTeradataColumnType(int  column)
   throws SQL Exception

Returns the data type of the column.

getUdtTypeName(int)

String getUdtTypeName(int  column)
   throws SQL Exception

Returns a String value that is the UDT name of the column if it is a UDT column.

The method throws SQLException if an error occurs while attempting to access the UDT name information.