INFORMATION.SCHEMA.PARAMETERS

Class INFORMATION.SCHEMA.PARAMETERS Extends %Library.Persistent [ ClassType = persistent, Final, Owner = {_PUBLIC}, SqlRowIdPrivate, SqlTableName = PARAMETERS, StorageStrategy = SQLStorage, System = 4 ]

The PARAMETERS table has one row for each SQL parameter of each SQL-invoked routine (procedure) described in the ROUTINES base table for which the current user has privileges for. This includes all input, output, input-output, and return values. It does not include result set columns for any result sets returned by the procedure.

Parameters

READONLY

Parameter READONLY = 1;

Properties

SchemaUpper

Property SchemaUpper As %String(MAXLEN = 128) [ Internal, Private, Required, SqlColumnNumber = 60 ];

ProcedureUpper

Property ProcedureUpper As %String(MAXLEN = 128) [ Internal, Private, Required, SqlColumnNumber = 61 ];

SystemRoutine

Property SystemRoutine As %Integer [ Calculated, Internal, Private, Required, SqlColumnNumber = 62, SqlComputeCode = { set {*}=$s($e({SPECIFIC_SCHEMA})="%"||({SPECIFIC_SCHEMA}="INFORMATION_SCHEMA"):1,1:0) }, SqlComputed ];

Is the table a system routine (1 or 0)

SPECIFICCATALOG

Property SPECIFICCATALOG As %String(MAXLEN = 128) [ Calculated, SqlColumnNumber = 2, SqlComputeCode = { set {*}=""}, SqlComputed, SqlFieldName = SPECIFIC_CATALOG ];

Reserved for future use. Specific qualifier - always NULL in InterSystems IRIS.

SPECIFICSCHEMA

Property SPECIFICSCHEMA As %String(COLLATION = "Upper", MAXLEN = 128) [ Required, SqlColumnNumber = 3, SqlFieldName = SPECIFIC_SCHEMA ];

Name of schema that contains the routine.

SPECIFICNAME

Property SPECIFICNAME As %String(COLLATION = "Upper", MAXLEN = 128) [ Required, SqlColumnNumber = 4, SqlFieldName = SPECIFIC_NAME ];

Name of the routine (procedure).

ORDINALPOSITION

Property ORDINALPOSITION As %Integer [ Required, SqlColumnNumber = 5, SqlFieldName = ORDINAL_POSITION ];

Parameter's ordinal position within the procedure method or query, starting with 1. For the return value of a method/function, this is 0.

DTDIDENTIFIER

Property DTDIDENTIFIER As %String(MAXLEN = 3) [ Calculated, SqlColumnNumber = 6, SqlComputeCode = { set {*}="" }, SqlComputed, SqlFieldName = DTD_IDENTIFIER ];

Reserved for future use. For InterSystems IRIS DTD_IDENTIFIER is always NULL.

PARAMETERMODE

Property PARAMETERMODE As %String(MAXLEN = 5, VALUELIST = ",IN,OUT,INOUT") [ Required, SqlColumnNumber = 7, SqlFieldName = PARAMETER_MODE ];

The values of PARAMETER_MODE have the following meanings:

IN - The SQL parameter being described is an input parameter.
OUT - The SQL parameter being described is an output parameter.
INOUT - he SQL parameter being described is an input parameter and an output parameter.

ISRESULT

Property ISRESULT As %String(MAXLEN = 5, VALUELIST = ",YES,NO") [ Required, SqlColumnNumber = 8, SqlFieldName = IS_RESULT ];

The values of IS_RESULT have the following meanings:

YES - The parameter is the return result of a function.
NO - The parameter is not the return result of a function.

ASLOCATOR

Property ASLOCATOR As %String(MAXLEN = 3, VALUELIST = ",YES,NO") [ SqlColumnNumber = 9, SqlFieldName = AS_LOCATOR ];

Returns YES or NO based on if the parameter is a LOB oref value and not the actual data value of the LOB.
AS_LOCATOR have the following meanings:

YES - The parameter being described is an stream oref.
NO - The parameter being described is not an stream oref. For InterSystems IRIS, AS_LOCATOR is always null unless the return value is a stream, then it is YES.

PARAMETERNAME

Property PARAMETERNAME As %String(COLLATION = "Upper", MAXLEN = 128) [ Required, SqlColumnNumber = 10, SqlFieldName = PARAMETER_NAME ];

Name of the parameter.