Send feedback on this topic.
Teradata.Client.Provider
MacroParameters Schema Collection
.NET Data Provider for Teradata > Developer's Guide > Working with the Data Provider Features > Schema Collections > MacroParameters Schema Collection

MacroParameters schema collection returns information about the Parameters of MACRO objects by accessing the Advanced SQL Engine Data Dictionary views. It will access DBC.COLUMNS[V]X if UseXViews is set to true. It will access DBC.COLUMNS[V] Data Dictionary view if UseXViews is set to false.

Column Name Data Type Description
MACRO_CATALOG String This field is always set to EMPTY.
MACRO_SCHEMA String Returns the name of the DATABASE in which MACRO object resides.
MACRO_NAME String Returns the name of the MACRO object.
PARAMETER_NAME String Returns the name of the PARAMETER.
PARAMETER_HASDEFAULT Int32

Returns:

  • 0  indicating parameter does not have a default value.
  • -1 indicating parameter has a default value.
PARAMETER_DEFAULT String Returns any default value assigned to the parameter.
IS_NULLABLE String

Returns a code to indicate whether or not the parameter may have a null value:

  • Y indicating it may have a null value.
  • N indication it may not have a null value.
DATA_TYPE String Returns the SQL Data Type name. DATA_TYPE will return the User Defined Type name if column is a UDT.

See PROVIDERDBTYPE for the .NET Data Provider for Teradata data type corresponding to this SQL data type.
CHARACTER_MAXIMUM_LENGTH Int32

Returns the maximum length of the Column in characters for the following Data Types:

  • Char or VarChar
  • CLOB, JSON [TEXT] XML or Dataset CSV
  • All Interval data types

Returns the maximum length of the Column in bytes for the following Data Types:

  • Byte or VarByte
  • BLOB, JSON [BSON or UBJSON] or Dataset Avro
CHARACTER_OCTET_LENGTH Int32

Returns maximum length of the parameter in bytes for the following Data Types:

  • Byte or VarByte
  • Char or VarChar
  • BLOB, CLOB, JSON, XML or Dataset
  • All Interval data types
NUMERIC_PRECISION Int16

Returns information about the maximum number of digits (base 10) that can be stored in a numeric parameter data type:

  • ByteInt, SmallInt, Integer and BigInt
  • Decimal or Numeric
  • Float or Double Precision
NUMERIC_SCALE Int16 Returns information about the maximum number of fractional digits (base 10) to the right of decimal point for Decimal data type.
DESCRIPTION String Returns user-supplied text or commentary on the Parameter.
FORMAT String Returns the format of the Parameter.
DATETIME_PRECISION Int16

Returns information about the maximum number of fractional seconds to the right of decimal point for the following data types:

  • Timestamp and Timestamp With Time Zone
  • Time and Time With Time Zone
  • Interval Day To Second
  • Interval Hour To Second
  • Interval Minute To Second
  • Interval Second
PROVIDERDBTYPE Int32 .NET Data Provider for Teradata data type ( TdType ).
INTERVAL_PRECISION Int16

Returns the number of digits in the most significant field of an interval. Null if the data type is not an interval.

COLUMN_INFO String

Returns information additional information about the column.

If the column is defined as a NUMBER, the information that is returned indicates whether the NUMBER is a fixed or floating decimal point:

  • FIXED for a fixed point decimal number
  • FLOAT for a floating point decimal number


MacroParameters schema collection can be filtered or restricted to:

Restriction Column Name Restriction Number Description
MACRO_SCHEMA 1 This restriction can be set to a valid DATABASE object name.
MACO_NAME 2 This restriction can be set to a valid PROCEDURE object name.
PARAMETER_NAME 3 This restriction can be set to a valid PARAMETER name.


MacroParameters schema collection rows are ordered by:

Column Name Description
MACRO_SCHEMA  Ascending case sensitive sort order. For example A through Z followed by a through z.
MACRO_NAME Ascending case sensitive sort order.
PARAMETER ORDINAL POSITION Ascending sort order.

The ordinal position is dictated by the CREATE MACRO statement where the first parameter is assigned Ordinal 1, second parameter is assigned Ordinal 2 and so forth. Note that the resulting DataTable does not have a PARAMETER ORDINAL POSITION.