15.00 - HELP MACRO - Teradata Database

Teradata Database SQL Data Definition Language Detailed Topics

Product
Teradata Database
Release Number
15.00
Content Type
Programming Reference
Publication ID
B035-1184-015K
Language
English (United States)

HELP MACRO

Macro Attributes

The columns or parameters are listed in the order in which they were defined.

The attributes are returned as shown in the following table.

 

Attribute

Data Type

Nullable?

Description

Parameter Name

VARCHAR(30)

No

The name of a parameter in the macro.

The system returns the set of attributes shown in this attribute table for each column or parameter.

Note: The following characteristics also apply:

Host Data Characteristics: Interpret as the equivalent of CF, or CHARACTER(n) data type.

Host Data Characteristics: When DATEFORM=ANSIDATE, this column should be described externally as CHARACTER(10).

Format Characteristics: With an explicit format, DATE.

With an implicit format created in ANSIDATE mode, ‘YYYY/MM/DD’.

Data Type

CHARACTER(2)

Yes

The data type for the Parameter Name.

See “Data Type Codes” on page 901 for a list of the data type codes and their meanings

The server character data types LATIN, UNICODE, GRAPHIC, KANJISJIS, and KANJI1 are distinguished with respect to CF and CV by their respective value for the Character Type column.

Comment

VARCHAR (255)

Yes

The contents of the optional comment field for the macro, if a comment was created.

Nullable

CHARACTER

Yes

Indicates whether the macro parameter specified in the Parameter Name field is nullable.

  • N specifies nullable.
  • Y specifies not 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.

    Data type display formats are documented in “Data Type Formats and Format Phrases” in SQL Data Types and Literals.

    Title

    VARCHAR (60)

    Yes

    The title for Parameter Name, if used.

    Max Length

    INTEGER

    Yes

    Return the length in bytes for the macro parameters specified in Parameter Name.

    MaxLength is the length of the external CharFix representation of the parameter, defined as CHARACTER(MaxLength) in USING clauses and any other place this needs to be specified.

    Note that while MaxLength is usually expressed as the internal size, presentation of the external size is more appropriate for these data types.

    For the DATE type MaxLength is 4, representing the internal storage size.

    For CHARACTER data, Max Length is the length of the parameter declaration in bytes.

    For HELP MACRO, requests return the length of the macro parameter.

    For UDTs, Max Length is the maximum length of the external type associated with the UDT formatted as -(10)9.

    See the external representation for each individual DateTime and Interval type in SQL Data Types and Literals to determine the MaxLength values.

    You can use the StatementInfo parcel to return the description of items within the Data Field of the corresponding indicator mode Record parcels.

    For example, the FastLoad .TABLE command can be executed in Indicator Mode to get the additional information of data type and length of all attributes. That information can then be used to fetch the data correctly in any release of Teradata Database.

    Decimal Total Digits

    SMALLINT

    Yes

    Indicates the total number of digits for decimal data.

    For INTERVAL types, returns a value from 1–4 representing the number of digits in the leading field of the interval (number of non-fractional digits for INTERVAL SECOND).

    This column is null for other TIME and TIMESTAMP data types.

    Decimal Fractional Digits

    SMALLINT

    Yes

    Indicates the decimal precision of the parameter in Parameter Name.

    If the Type is TIME or TIMESTAMP types, or any INTERVAL type with a SECOND field, this column returns a value of 0–6, indicating the fractional precision of seconds.

    For INTERVAL types without a SECOND field, the column returns null.

    Null for other data types.

    Range Low

    FLOAT

    Yes

    Always null. BETWEEN clause is included in column constraint.

    Range High

    FLOAT

    Yes

    Always null. BETWEEN clause is included in column constraint.

    Uppercase

    CHARACTER

    Yes

    Applies if the 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.
  • Table/View?

    CHARACTER

    No

    The object type. See “TVM Kind Codes” on page 903.

    HELP MACRO requests always return a code of M for macro.

    Default Value

    VARCHAR (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 identifying the character data type for the parameter shown in 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.
  • If the data type of the column is not character, returns null.

    IDCol Type

    CHARACTER(2)

    Yes

    Returns a code for the type of identity column.

  • GA specifies Generated Always.
  • GD specifies Generated by Default.
  • UDT Name

    VARCHAR(61)

    Yes

    Returns the unqualified name of the UDT.

    If a UDT does not exist, the parameter is NULL.

    Temporal Column

    CHARACTER(2)

    Yes

    Reports whether a column is temporal or not and if it is part of a Temporal Relationship constraint.

  • Null specifies that the column is non‑temporal.
  • R specifies that the column is part of a temporal relationship constraint.
  • T specifies that the column has TRANSACTIONTIME column.
  • V specifies that the column has VALIDTIME column.
  • For information about temporal columns, see ANSI Temporal Table Support and Temporal Table Support.

    Current ValidTime Unique?

    CHARACTER(2)

    Yes

    Reports whether a column is a UNIQUE Current VALIDTIME column or not.

    For information about temporal columns, see ANSI Temporal Table Support and Temporal Table Support.

    Sequenced ValidTime Unique?

    CHARACTER(2)

    Yes

    Reports whether a column is a UNIQUE Sequenced VALIDTIME column or not.

    For information about temporal columns, see ANSI Temporal Table Support and Temporal Table Support.

    NonSequenced ValidTime Unique?

    CHARACTER(2)

    Yes

    Reports whether a column is a UNIQUE Nonsequenced VALIDTIME column or not.

    For information about temporal columns, see ANSI Temporal Table Support and Temporal Table Support.

    Current TransactionTime Unique?

    CHARACTER(2)

    Yes

    Reports whether a column is a UNIQUE Current TRANSACTIONTIME column or not.

    For information about temporal columns, see ANSI Temporal Table Support and Temporal Table Support.

    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 method.

    The older attributes are retained for compatibility with legacy applications.

    For details on the new attributes, see the topics beginning with “Working with Object Name and Title Data in HELP Reports” on page 896.

    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)

    Yes

    UDT SQL Name

    VARCHAR(644)

    Yes

    UDT Name Uescape

    VARCHAR(1)

    Yes