UserDefinedFunctionParameters Schema Collection

UserDefinedFunctionParameters schema collection returns information about the Parameters of User Defined Function objects by accessing the Advanced SQL Engine Data Dictionary views. It will access DBC.COLUMNS[V]X if UseXViews is set to true, otherwise it will access DBC.COLUMNS[V].

Column Name	Data Type	Description
UDF_CATALOG	String	This field is always set to String.Empty.
UDF_SCHEMA	String	Returns the name of the DATABASE in which the UDF object resides.
UDF_NAME	String	Returns the name of the UDF object.
PARAMETER_NAME	String	Returns the name of the PARAMETER.
PARAMETER_MODE	String	Returns: I to indicate that the parameter is passed to the UDF as Input. O to indicate that the parameter is returned from the UDF as Output. B to indicate that the Parameter is passed to the UDF as Input and returned from the UDF as Output.
PARAMETER_HASDEFAULT	Boolean	Returns: false to indicate the parameter does not have a default value. true to indicate the parameter has a default value.
PARAMETER_DEFAULT	String	Returns any default value assigned to the parameter.
IS_NULLABLE	Boolean	Returns: false to indicate the parameter may not have a null value. true to indicate the parameter may have a null value.
DATA_TYPE	String	Returns the SQL Data Type name. It will return the User Defined Type name if the parameter is a UDT. See PROVIDERDBTYPE for the .NET Data Provider for Teradata data type corresponding to the 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 the 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 the maximum number of digits (base 10) that can be stored in a Numeric data type: ByteInt, SmallInt, Integer and BigInt Decimal or Numeric Float or Double Precision
NUMERIC_SCALE	Int16	Returns the maximum number of fractional digits (base 10) to the right of decimal point for a Decimal data type.
DATETIME_PRECISION	Int16	Returns 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
REMARKS	String	Returns user-supplied text, or comments, associated with the parameter.
FORMAT	String	Returns the display format of the Parameter.
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, or Null if the data type is not an interval.
COLUMN_INFO	String	Returns 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 type: FIXED for a fixed point decimal number FLOAT for a floating point decimal number
STORAGE_FORMAT	String	The Format in which the parameter is used by the SQL Engine. For JSON parameters: TEXT, BSON or UBJSON For Dataset parameters: AVRO or CSV
INLINE_LENGTH	Int32	Returns the Inline Length for the following data types: JSON, XML, Dataset or ST_Geometry. If the parameter data is shorter than this length the SQL Engine will store that data within a spool row itself instead of storing it in an associated LOB sub table.

UserDefinedFunctionParameters schema collection can be filtered or restricted to:

Restriction Column Name	Restriction Number	Description
UDF_SCHEMA	1	This restriction can be set to a valid DATABASE object name.
UDF_NAME	2	This restriction can be set to a valid UDF object name.
PARAMETER_NAME	3	This restriction can be set to a valid PARAMETER name.

UserDefinedFunctionParameters schema collection rows are ordered by:

Column Name	Description
UDF_SCHEMA	Ascending case sensitive sort order. For example A through Z followed by a through z.
UDF_NAME	Ascending case sensitive sort order.
PARAMETER ORDINAL POSITION	Ascending sort order. The ordinal position is dictated by the CREATE FUNCTION statement where the first parameter is assigned Ordinal 1, the second parameter is assigned Ordinal 2 and so forth. Note that the resulting DataTable does not have a PARAMETER ORDINAL POSITION.