ProcedureParameters Schema Collection

ProcedureParameters schema collection returns information about the Parameters of any STORED PROCEDURE or EXTERNAL STORED PROCEDURE 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
PROCEDURE_SCHEMA	String	Returns the name of the DATABASE in which the PROCEDURE object resides.
PROCEDURE_NAME	String	Returns the name of the PROCEDURE object.
PARAMETER_NAME	String	Returns the name of the PARAMETER.
PARAMETER_MODE	String	Returns: I to indicate that the parameter is passed to the SQL Engine as Input. O to indicate that the parameter is returned from the SQL Engine as Output. B to indicate that the Parameter is passed to the SQL Engine as Input and returned from the SQL Engine as Output.
PARAMETER_HASDEFAULT	Int32	Returns: 0 indicating the parameter does not have a default value. -1 indicating the 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 the Parameter may have a null value: Y indicating it may have a null value. N indicating it may not have a null value.
DATA_TYPE	String	Returns the SQL Data Type name. It will return the User Defined Type name if the column 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 Decimal data type.
DESCRIPTION	String	Returns user-supplied text, or comments, associated with the parameter.
PROCEDURE_CATALOG	String	This field is always set to String.Empty.
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
PROCEDURE_TYPE	String	Returns: E to indicate an EXTERNAL STORED PROCEDURE P to indicate an SQL STORED PROCEDURE
FORMAT	String	Returns the display format of the Parameter.
PROVIDERDBTYPE	Int32	The .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 information additional information about the column. If the parameter 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.

ProcedureParameters schema collection can be filtered or restricted to:

Restriction Column Name	Restriction Number	Description
PROCEDURE_SCHEMA	1	This restriction can be set to a valid DATABASE object name.
PROCEDURE_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.

ProcedureParameters schema collection rows are ordered by:

Column Name	Description
PROCEDURE_SCHEMA	Ascending case sensitive sort order. For example A through Z followed by a through z.
PROCEDURE_NAME	Ascending case sensitive sort order.
PARAMETER ORDINAL POSITION	Ascending sort order. The ordinal position is dictated by the CREATE PROCEDURE 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.