User-Defined Function Attributes | HELP FUNCTION | Teradata Vantage - User-Defined Function Attributes - Analytics Database - Teradata Vantage

SQL Data Definition Language Detailed Topics
Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2024-10-04
dita:mapPath
vuk1628111288877.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
jbg1472252759029
lifecycle
latest
Product Category
Teradata Vantage™

The following attributes and format information are returned for each parameter in a user-defined function (UDF). The report returned for external functions and SQL functions is the same.

For a table function defined with a dynamic row result specification, HELP FUNCTION returns only input parameters because the maximum number of output parameters for the function cannot be known before it runs. Because of this, the names and data types for the output parameters also cannot be defined until run time.
Attribute Data Type Nullable? Description
Parameter Name VARCHAR(30) No The name of a parameter defined for the UDF specified in the HELP Function request.

A parameter name and set of attributes is returned for each parameter in the specified UDF.

The word RETURN0 is a system-generated return parameter name.
Type CHARACTER(2) No The data for the reporting parameter.

See Data Type Codes for a list of the data type codes and their meanings.
Comment CHARACTER(255) Yes The contents of the optional comment field for the function, if a comment was created.
Nullable CHARACTER(1) No Specifies whether the parameter is nullable.
  • N specifies NOT NULL.
  • Y specifies nullable.
Format CHARACTER(30) Yes Display format for the data type.

For a UDT, the displayed format is the format associated with the external type of the UDT.

For data type display formats, see Teradata Vantage™ - Data Types and Literals, B035-1143.
Max Length INTEGER No The column format is -(10)9.

When the parameter data type is a UDT, this column is 0.
Decimal Total Digits SMALLINT Yes If type is DECIMAL.
Decimal Fractional Digits SMALLINT Yes If type is DECIMAL.
Table/View? CHARACTER(1) No The function type:
  • A specifies Aggregate function.
  • B specifies a combined Aggregate and Statistical function.
  • E specifies external procedure.
  • F specifies Scalar function.
  • M specifies Function used as a method.
  • R specifies Table function.
  • S specifies Statistical function.
Character Type SMALLINT Yes Returns a code identifying the character data type for the parameter.
  • 1 specifies LATIN server character data type columns.
  • 2 specifies UNICODE server character data type columns.
  • 3 specifies KANJISJIS server character data type columns.
  • 4 specifies GRAPHIC server character data type columns.
  • 5 specifies KANJI1 server character data type columns.

If the data type of the column is not character, returns null.
Parameter Type CHARACTER(2) No The type of parameter specified by the Parameter Name field.
  • C specifies a Return column of a function table.
  • E specifies an External OUT parameter.
  • I specifies an IN parameter.
  • O specifies an OUT parameter.
  • UT specifies UDT parameter
UDT Name VARCHAR(61) Yes Returns the unqualified name of the UDT for the Parameter Name.

If a UDT does not exist, the parameter is NULL.
Parameter Dictionary Name VARCHAR(128) No The attributes shown in this section are derived from and supersede the corresponding older Parameter Name and UDT Name attributes, while providing additional functionality.

The older attributes are retained for compatibility with legacy applications.

For details on the new attributes, see the topics beginning with Object Name and Title Data in HELP Reports.
Parameter SQL Name VARCHAR(644)
Parameter Name UEscape VARCHAR(1) Yes
UDT Dictionary Name VARCHAR(128) Yes
UDT SQL Name VARCHAR(644) Yes
UDT Name UEscape VARCHAR(1) Yes