16.20 - Procedure Parameter Attributes - Teradata Database - Teradata Vantage NewSQL Engine

Teradata Vantage™ SQL Data Definition Language Detailed Topics

Product
Teradata Database
Teradata Vantage NewSQL Engine
Release Number
16.20
Release Date
March 2019
Content Type
Programming Reference
Publication ID
B035-1184-162K
Language
English (United States)

The following attribute and format information is returned by HELP PROCEDURE for each parameter in the specified procedure.

If the specified procedure has no parameters, the system returns the “Empty help” message.

Attribute Data Type Nullable? Description
Parameter Name VARCHAR(30) No The name of a parameter in the specified procedure.
Data Type CHARACTER(2) Yes The data type for the parameter.

Always null for UDTs.

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 procedure, if a comment was created.
Nullable CHARACTER No Indicates whether the parameter can be NULL.
  • N specifies not null.
  • Y specifies can be null.
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.

Data type display formats are documented in “Data Type Formats and Format Phrases” in Teradata Vantage™ Data Types and Literals, B035-1143.

Title VARCHAR(60) Yes The title (if used) for the Parameter Name
Max Length INTEGER Yes Default output format is -(10)9.

Returns null for a UDT.

Decimal Total Digits SMALLINT

Formatted as -(5)9

Yes If type is DECIMAL.
Decimal Fractional Digits SMALLINT

Formatted as -(5)9

Yes If type is DECIMAL.
Uppercase CHARACTER Yes Returned if type is CHARACTER or VARCHAR.
  • B specifies that column attributes for both UPPERCASE and CASESPECIFIC are defined.
  • C specifies that the column attributes for CASESPECIFIC is defined.
  • N specifies that column attributes for neither UPPERCASE nor CASESPECIFIC are defined.
  • U specifies that the column attributes for UPPERCASE is defined.
TVM Kind CHARACTER No Indicates the type of procedure.
  • E specifies External procedure.
  • P specifies SQL procedure.
Default Value CHARACTER(255) Yes Returns the default value (as text) for the parameter.

The value is null if there is no default value.

Character Type SMALLINT Yes Returns a code specifying the character data type for each Parameter Name.
  • 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.
Parameter Type CHARACTER(2) No Indicates the type of parameter for the Parameter Name.
  • B specifies an INOUT parameter.
  • 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 qualified name of the UDT formatted X(61).
Parameter Dictionary Name VARCHAR(128) No The attributes shown in this section are derived from and supersede the corresponding older Parameter Name, Title, and UDT Name attributes, while providing additional functionality.

These attributes are returned for each parameter in the specified procedure.

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) No
Parameter Name UEscape VARCHAR(1) Yes
Dictionary Title VARCHAR(256) Yes
SQL Title VARCHAR(1256) Yes
Title UEscape VARCHAR(1) Yes
UDT Dictionary Name VARCHAR(128) No
UDT SQL Name VARCHAR(644) No
UDT Name UEscape VARCHAR(1) Yes