tdr.GetFormat Function | R Table Operators | Teradata Vantage - tdr.GetFormat - Analytics Database - Teradata Vantage

SQL External Routine Programming
Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
ft:locale
en-US
ft:lastEdition
2025-03-30
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
qnu1472247494689
lifecycle
latest
Product Category
Teradata Vantage™
Returns an integer that indicates the record format attribute for the given stream as follows:
  • 1 for IndicData with row separator sentinels
  • 2 for IndicData with no row or partition separator sentinels

Syntax

tdr.GetFormat(  attribute,  streamno,  direction  )

Syntax Elements

attribute
Parameter type: character

The format attribute to be retrieved.

Currently, the only valid value for attribute is "RECFMT", which defines the input/output record format.

streamno
Parameter type: integer

The stream number.

direction
Parameter type: character
Valid values are as follows:
  • "R" (input)
  • "W" (output)

Usage Notes

This function can be called from the table operator as well as the contract function.

Example: Print the Record Format of an Input Stream

The following statement prints the record format of input stream 0:

print(tdr.GetFormat("RECFMT", 0, "R"))