Class INFORMATION.SCHEMA.PARAMETERS

persistent class INFORMATION.SCHEMA.PARAMETERS extends %Library.Persistent

SQL Table Name: PARAMETERS

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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	32			2

Summary

Properties
ASLOCATOR	CHARACTERMAXIMUMLENGTH	CHARACTEROCTETLENGTH	CHARACTERSETCATALOG
CHARACTERSETNAME	CHARACTERSETSCHEMA	COLLATIONCATALOG	COLLATIONNAME
COLLATIONSCHEMA	DATATYPE	DATETIMEPRECISION	DTDIDENTIFIER
FROMSQLSPECIFICCATALOG	FROMSQLSPECIFICNAME	FROMSQLSPECIFICSCHEMA	ISRESULT
NUMERICPRECISION	NUMERICPRECISIONRADIX	NUMERICSCALE	ORDINALPOSITION
PARAMETERMODE	PARAMETERNAME	SPECIFICCATALOG	SPECIFICNAME
SPECIFICSCHEMA	TOSQLSPECIFICCATALOG	TOSQLSPECIFICNAME	TOSQLSPECIFICSCHEMA

Methods
%AddToSaveSet	%AddToSyncSet	%BuildDeferredIndices	%BuildIndicesAsync
%BuildIndicesAsyncResponse	%CheckConstraints	%CheckConstraintsForExtent	%ClassIsLatestVersion
%ClassName	%ComposeOid	%ConstructClone	%Delete
%DeleteExtent	%DeleteId	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%Exists	%ExistsId	%Extends
%GUID	%GUIDSet	%GetLock	%GetParameter
%GetSwizzleObject	%Id	%IsA	%IsModified
%IsNull	%KillExtent	%LockExtent	%LockId
%New	%NormalizeObject	%ObjectIsNull	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDeleteFinally	%OnDetermineClass
%OnOpenFinally	%OnSaveFinally	%Open	%OpenId
%OriginalNamespace	%PackageName	%PurgeIndices	%Reload
%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack	%Save
%SaveDirect	%SerializeObject	%SetModified	%SortBegin
%SortEnd	%SyncObjectIn	%SyncTransport	%UnlockExtent
%UnlockId	%ValidateIndices	%ValidateObject	%ValidateTable

Parameters

• parameter READONLY = 1;

READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

• property ASLOCATOR as %String(MAXLEN=3,VALUELIST=",YES,NO") [ 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.

• property CHARACTERMAXIMUMLENGTH as %Integer [ Calculated,SqlFieldName = CHARACTER_MAXIMUM_LENGTH ];

Maximum length in characters, if the return type is a varchar or varbinary type. If not a character type, returns null.

• property CHARACTEROCTETLENGTH as %Integer [ Calculated,SqlFieldName = CHARACTER_OCTET_LENGTH ];

Reserved for future use. For InterSystems IRIS, CHARACTER_OCTET_LENGTH is always NULL.

• property CHARACTERSETCATALOG as %String(MAXLEN=3) [ Calculated,SqlFieldName = CHARACTER_SET_CATALOG ];

Reserved for future use. For InterSystems IRIS, CHARACTER_SET_CATALOG is always NULL.

• property CHARACTERSETNAME as %String(MAXLEN=3) [ Calculated,SqlFieldName = CHARACTER_SET_NAME ];

Reserved for future use. For InterSystems IRIS, CHARACTER_SET_NAME is always NULL.

• property CHARACTERSETSCHEMA as %String(MAXLEN=3) [ Calculated,SqlFieldName = CHARACTER_SET_SCHEMA ];

Reserved for future use. For InterSystems IRIS, CHARACTER_SET_SCHEMA is always NULL.

• property COLLATIONCATALOG as %String(MAXLEN=3) [ Calculated,SqlFieldName = COLLATION_CATALOG ];

Reserved for future use. For InterSystems IRIS, COLLATION_CATALOG is always NULL.

• property COLLATIONNAME as %String(MAXLEN=3) [ Calculated,SqlFieldName = COLLATION_NAME ];

Reserved for future use. For InterSystems IRIS, COLLATION_NAME is always NULL.

• property COLLATIONSCHEMA as %String(MAXLEN=3) [ Calculated,SqlFieldName = COLLATION_SCHEMA ];

Reserved for future use. For InterSystems IRIS, COLLATION_SCHEMA is always NULL.

• property DATATYPE as %String(MAXLEN=30) [ SqlFieldName = DATA_TYPE ];

Data type of the parameter

• property DATETIMEPRECISION as %Integer [ Calculated,SqlFieldName = DATETIME_PRECISION ];

Reserved for future use. For InterSystems IRIS, DATETIME_PRECISION is always NULL.

• property DTDIDENTIFIER as %String(MAXLEN=3) [ Calculated,SqlFieldName = DTD_IDENTIFIER ];

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

• property FROMSQLSPECIFICCATALOG as %String(MAXLEN=3) [ Calculated,SqlFieldName = FROM_SQL_SPECIFIC_CATALOG ];

Reserved for future use. Always NULL in InterSystems IRIS.

• property FROMSQLSPECIFICNAME as %String(MAXLEN=3) [ Calculated,SqlFieldName = FROM_SQL_SPECIFIC_NAME,Required ];

Reserved for future use. Always NULL in InterSystems IRIS.

• property FROMSQLSPECIFICSCHEMA as %String(MAXLEN=3) [ Calculated,SqlFieldName = FROM_SQL_SPECIFIC_SCHEMA,Required ];

Reserved for future use. Always NULL in InterSystems IRIS.

• property ISRESULT as %String(MAXLEN=5,VALUELIST=",YES,NO") [ SqlFieldName = IS_RESULT,Required ];

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.

• property NUMERICPRECISION as %SmallInt [ Calculated,SqlFieldName = NUMERIC_PRECISION ];

Numeric precision of the return value. For the nonnumeric types, returns NULL.

• property NUMERICPRECISIONRADIX as %Integer [ Calculated,SqlFieldName = NUMERIC_PRECISION_RADIX ];

Numeric precision radix of the return value. For nonnumeric types, returns NULL.

• property NUMERICSCALE as %Integer [ Calculated,SqlFieldName = NUMERIC_SCALE ];

Scale of the return value. For nonnumeric types, returns NULL.

• property ORDINALPOSITION as %Integer [ SqlFieldName = ORDINAL_POSITION,Required ];

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

• property PARAMETERMODE as %String(MAXLEN=5,VALUELIST=",IN,OUT,INOUT") [ SqlFieldName = PARAMETER_MODE,Required ];

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.

• property PARAMETERNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = PARAMETER_NAME,Required ];

Name of the parameter.

• property SPECIFICCATALOG as %String(MAXLEN=128) [ Calculated,SqlFieldName = SPECIFIC_CATALOG ];

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

• property SPECIFICNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = SPECIFIC_NAME,Required ];

Name of the routine (procedure).

• property SPECIFICSCHEMA as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = SPECIFIC_SCHEMA,Required ];

Name of schema that contains the routine.

• property TOSQLSPECIFICCATALOG as %String(MAXLEN=3) [ Calculated,SqlFieldName = TO_SQL_SPECIFIC_CATALOG ];

Reserved for future use. Always NULL in InterSystems IRIS.

• property TOSQLSPECIFICNAME as %String(MAXLEN=3) [ Calculated,SqlFieldName = TO_SQL_SPECIFIC_NAME ];

Reserved for future use. Always NULL in InterSystems IRIS.

• property TOSQLSPECIFICSCHEMA as %String(MAXLEN=3) [ Calculated,SqlFieldName = TO_SQL_SPECIFIC_SCHEMA ];

Reserved for future use. Always NULL in InterSystems IRIS.

Indices

•index (PKeyIndex on SPECIFICSCHEMA,SPECIFICNAME,ORDINALPOSITION) [PrimaryKey];

Class Reference IRIS for UNIX 2024.1.2
Documentation Search