16.20 - InputInfo Methods - 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)

getAsName(int)

public String getAsName(int  StreamNo)
Parameter Name Description
StreamNo The stream number.

Returns the name associated with an input stream.

getCustom()

public java.util.Map<java.lang.String,java.lang.Object> getCustom()

Returns a Map object containing the custom clause information for the table operator in the form of name-value pairs. If there is no custom clause specified for the table operator, the method returns a non-null empty Map object.

getFormat(int, InputInfo.StreamDir)

public java.util.Map<StreamFormat.FormatAttribute,java.lang.Object>
   getFormat(int  streamno, InputInfo.StreamDir  dir)
Parameter Name Description
streamno The stream number.
dir The direction of the stream (input or output).

Returns a Map of the format settings.

getFunctionInfo()

public java.util.Map<java.lang.String,java.lang.Object>
   getFunctionInfo()

Returns a Map of the function information. This includes the function name, the execution mode, case sensitivity, and character type.

getHashBy(int)

public java.util.List<ColumnDefinition> getHashBy(int  StreamNo)
Parameter Name Description
StreamNo The stream number.

Returns a List of the HASH BY columns (names only).

getIncount()

public int getIncount()

Returns the number of input streams.

getisDimension(int)

public boolean  getisDimension(int  StreamNo)
Parameter Name Description
StreamNo The stream number.

Returns true if the input stream is a DIMENSION input; otherwise, it returns false.

getOrderBy(int)

public java.util.List<ColumnDefinition> getOrderBy(int  StreamNo)
Parameter Name Description
StreamNo The stream number.

Returns a List of the ORDER BY columns (names only).

getOutcount()

public int getOutcount()

Returns the number of output streams.

getUDTMetadata(int)

UDTBaseInfo[] getUDTMetadata(int  StreamNo)
Parameter Name Description
StreamNo The stream number.

Retrieves the UDT metadata for a particular stream. The method returns an array of UDTBaseInfo objects that contain the UDT metadata for each column in the input stream.

Inherited Methods

The following methods are inherited from class java.lang.Object:
  • equals
  • getClass
  • hashCode
  • notify
  • notifyAll
  • toString
  • wait, wait, wait