Home > Class Reference > %SYS namespace > INFORMATION.SCHEMA.PARAMETERS

INFORMATION.SCHEMA.PARAMETERS

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

SQL Table Name: INFORMATION_SCHEMA.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.

Property Inventory

Parameters

parameter READONLY = 1;
Inherited description: 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 Caché, AS_LOCATOR is always null unless the return value is a stream, then it is YES.
Property methods: ASLOCATORDisplayToLogical(), ASLOCATORGet(), ASLOCATORIsValid(), ASLOCATORLogicalToDisplay(), ASLOCATORLogicalToOdbc(), ASLOCATORNormalize(), ASLOCATORSet()
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 methods: CHARACTERMAXIMUMLENGTHCompute(), CHARACTERMAXIMUMLENGTHDisplayToLogical(), CHARACTERMAXIMUMLENGTHGet(), CHARACTERMAXIMUMLENGTHIsValid(), CHARACTERMAXIMUMLENGTHLogicalToDisplay(), CHARACTERMAXIMUMLENGTHNormalize(), CHARACTERMAXIMUMLENGTHSQLCompute()
property CHARACTEROCTETLENGTH as %Integer [ Calculated , SqlFieldName = CHARACTER_OCTET_LENGTH ];
Reserved for future use. For Caché, CHARACTER_OCTET_LENGTH is always NULL.
Property methods: CHARACTEROCTETLENGTHCompute(), CHARACTEROCTETLENGTHDisplayToLogical(), CHARACTEROCTETLENGTHGet(), CHARACTEROCTETLENGTHIsValid(), CHARACTEROCTETLENGTHLogicalToDisplay(), CHARACTEROCTETLENGTHNormalize(), CHARACTEROCTETLENGTHSQLCompute()
property CHARACTERSETCATALOG as %String (MAXLEN = 3) [ Calculated , SqlFieldName = CHARACTER_SET_CATALOG ];
Reserved for future use. For Caché, CHARACTER_SET_CATALOG is always NULL.
Property methods: CHARACTERSETCATALOGCompute(), CHARACTERSETCATALOGDisplayToLogical(), CHARACTERSETCATALOGGet(), CHARACTERSETCATALOGIsValid(), CHARACTERSETCATALOGLogicalToDisplay(), CHARACTERSETCATALOGLogicalToOdbc(), CHARACTERSETCATALOGNormalize(), CHARACTERSETCATALOGSQLCompute()
property CHARACTERSETNAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = CHARACTER_SET_NAME ];
Reserved for future use. For Caché, CHARACTER_SET_NAME is always NULL.
Property methods: CHARACTERSETNAMECompute(), CHARACTERSETNAMEDisplayToLogical(), CHARACTERSETNAMEGet(), CHARACTERSETNAMEIsValid(), CHARACTERSETNAMELogicalToDisplay(), CHARACTERSETNAMELogicalToOdbc(), CHARACTERSETNAMENormalize(), CHARACTERSETNAMESQLCompute()
property CHARACTERSETSCHEMA as %String (MAXLEN = 3) [ Calculated , SqlFieldName = CHARACTER_SET_SCHEMA ];
Reserved for future use. For Caché, CHARACTER_SET_SCHEMA is always NULL.
Property methods: CHARACTERSETSCHEMACompute(), CHARACTERSETSCHEMADisplayToLogical(), CHARACTERSETSCHEMAGet(), CHARACTERSETSCHEMAIsValid(), CHARACTERSETSCHEMALogicalToDisplay(), CHARACTERSETSCHEMALogicalToOdbc(), CHARACTERSETSCHEMANormalize(), CHARACTERSETSCHEMASQLCompute()
property COLLATIONCATALOG as %String (MAXLEN = 3) [ Calculated , SqlFieldName = COLLATION_CATALOG ];
Reserved for future use. For Caché, COLLATION_CATALOG is always NULL.
Property methods: COLLATIONCATALOGCompute(), COLLATIONCATALOGDisplayToLogical(), COLLATIONCATALOGGet(), COLLATIONCATALOGIsValid(), COLLATIONCATALOGLogicalToDisplay(), COLLATIONCATALOGLogicalToOdbc(), COLLATIONCATALOGNormalize(), COLLATIONCATALOGSQLCompute()
property COLLATIONNAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = COLLATION_NAME ];
Reserved for future use. For Caché, COLLATION_NAME is always NULL.
Property methods: COLLATIONNAMECompute(), COLLATIONNAMEDisplayToLogical(), COLLATIONNAMEGet(), COLLATIONNAMEIsValid(), COLLATIONNAMELogicalToDisplay(), COLLATIONNAMELogicalToOdbc(), COLLATIONNAMENormalize(), COLLATIONNAMESQLCompute()
property COLLATIONSCHEMA as %String (MAXLEN = 3) [ Calculated , SqlFieldName = COLLATION_SCHEMA ];
Reserved for future use. For Caché, COLLATION_SCHEMA is always NULL.
Property methods: COLLATIONSCHEMACompute(), COLLATIONSCHEMADisplayToLogical(), COLLATIONSCHEMAGet(), COLLATIONSCHEMAIsValid(), COLLATIONSCHEMALogicalToDisplay(), COLLATIONSCHEMALogicalToOdbc(), COLLATIONSCHEMANormalize(), COLLATIONSCHEMASQLCompute()
property DATATYPE as %String (MAXLEN = 30) [ SqlFieldName = DATA_TYPE ];
Data type of the parameter
Property methods: DATATYPEDisplayToLogical(), DATATYPEGet(), DATATYPEIsValid(), DATATYPELogicalToDisplay(), DATATYPELogicalToOdbc(), DATATYPENormalize(), DATATYPESet()
property DATETIMEPRECISION as %Integer [ Calculated , SqlFieldName = DATETIME_PRECISION ];
Reserved for future use. For Caché, DATETIME_PRECISION is always NULL.
Property methods: DATETIMEPRECISIONCompute(), DATETIMEPRECISIONDisplayToLogical(), DATETIMEPRECISIONGet(), DATETIMEPRECISIONIsValid(), DATETIMEPRECISIONLogicalToDisplay(), DATETIMEPRECISIONNormalize(), DATETIMEPRECISIONSQLCompute()
property DTDIDENTIFIER as %String (MAXLEN = 3) [ Calculated , SqlFieldName = DTD_IDENTIFIER ];
Reserved for future use. For Caché DTD_IDENTIFIER is always NULL.
Property methods: DTDIDENTIFIERCompute(), DTDIDENTIFIERDisplayToLogical(), DTDIDENTIFIERGet(), DTDIDENTIFIERIsValid(), DTDIDENTIFIERLogicalToDisplay(), DTDIDENTIFIERLogicalToOdbc(), DTDIDENTIFIERNormalize(), DTDIDENTIFIERSQLCompute()
property FROMSQLSPECIFICCATALOG as %String (MAXLEN = 3) [ Calculated , SqlFieldName = FROM_SQL_SPECIFIC_CATALOG ];
Reserved for future use. Always NULL in Caché.
Property methods: FROMSQLSPECIFICCATALOGCompute(), FROMSQLSPECIFICCATALOGDisplayToLogical(), FROMSQLSPECIFICCATALOGGet(), FROMSQLSPECIFICCATALOGIsValid(), FROMSQLSPECIFICCATALOGLogicalToDisplay(), FROMSQLSPECIFICCATALOGLogicalToOdbc(), FROMSQLSPECIFICCATALOGNormalize(), FROMSQLSPECIFICCATALOGSQLCompute()
property FROMSQLSPECIFICNAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = FROM_SQL_SPECIFIC_NAME , Required ];
Reserved for future use. Always NULL in Caché.
Property methods: FROMSQLSPECIFICNAMECompute(), FROMSQLSPECIFICNAMEDisplayToLogical(), FROMSQLSPECIFICNAMEGet(), FROMSQLSPECIFICNAMEIsValid(), FROMSQLSPECIFICNAMELogicalToDisplay(), FROMSQLSPECIFICNAMELogicalToOdbc(), FROMSQLSPECIFICNAMENormalize(), FROMSQLSPECIFICNAMESQLCompute()
property FROMSQLSPECIFICSCHEMA as %String (MAXLEN = 3) [ Calculated , SqlFieldName = FROM_SQL_SPECIFIC_SCHEMA , Required ];
Reserved for future use. Always NULL in Caché.
Property methods: FROMSQLSPECIFICSCHEMACompute(), FROMSQLSPECIFICSCHEMADisplayToLogical(), FROMSQLSPECIFICSCHEMAGet(), FROMSQLSPECIFICSCHEMAIsValid(), FROMSQLSPECIFICSCHEMALogicalToDisplay(), FROMSQLSPECIFICSCHEMALogicalToOdbc(), FROMSQLSPECIFICSCHEMANormalize(), FROMSQLSPECIFICSCHEMASQLCompute()
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 methods: ISRESULTDisplayToLogical(), ISRESULTGet(), ISRESULTIsValid(), ISRESULTLogicalToDisplay(), ISRESULTLogicalToOdbc(), ISRESULTNormalize(), ISRESULTSet()
property NUMERICPRECISION as %SmallInt [ Calculated , SqlFieldName = NUMERIC_PRECISION ];
Numeric precision of the return value. For the nonnumeric types, returns NULL.
Property methods: NUMERICPRECISIONCompute(), NUMERICPRECISIONDisplayToLogical(), NUMERICPRECISIONGet(), NUMERICPRECISIONIsValid(), NUMERICPRECISIONLogicalToDisplay(), NUMERICPRECISIONNormalize(), NUMERICPRECISIONRADIXCompute(), NUMERICPRECISIONRADIXDisplayToLogical(), NUMERICPRECISIONRADIXGet(), NUMERICPRECISIONRADIXIsValid(), NUMERICPRECISIONRADIXLogicalToDisplay(), NUMERICPRECISIONRADIXNormalize(), NUMERICPRECISIONRADIXSQLCompute(), NUMERICPRECISIONSQLCompute()
property NUMERICPRECISIONRADIX as %Integer [ Calculated , SqlFieldName = NUMERIC_PRECISION_RADIX ];
Numeric precision radix of the return value. For nonnumeric types, returns NULL.
Property methods: NUMERICPRECISIONRADIXCompute(), NUMERICPRECISIONRADIXDisplayToLogical(), NUMERICPRECISIONRADIXGet(), NUMERICPRECISIONRADIXIsValid(), NUMERICPRECISIONRADIXLogicalToDisplay(), NUMERICPRECISIONRADIXNormalize(), NUMERICPRECISIONRADIXSQLCompute()
property NUMERICSCALE as %Integer [ Calculated , SqlFieldName = NUMERIC_SCALE ];
Scale of the return value. For nonnumeric types, returns NULL.
Property methods: NUMERICSCALECompute(), NUMERICSCALEDisplayToLogical(), NUMERICSCALEGet(), NUMERICSCALEIsValid(), NUMERICSCALELogicalToDisplay(), NUMERICSCALENormalize(), NUMERICSCALESQLCompute()
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 methods: ORDINALPOSITIONDisplayToLogical(), ORDINALPOSITIONGet(), ORDINALPOSITIONIsValid(), ORDINALPOSITIONLogicalToDisplay(), ORDINALPOSITIONNormalize(), ORDINALPOSITIONSet()
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 methods: PARAMETERMODEDisplayToLogical(), PARAMETERMODEGet(), PARAMETERMODEIsValid(), PARAMETERMODELogicalToDisplay(), PARAMETERMODELogicalToOdbc(), PARAMETERMODENormalize(), PARAMETERMODESet()
property PARAMETERNAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = PARAMETER_NAME , Required ];
Name of the parameter.
Property methods: PARAMETERNAMEDisplayToLogical(), PARAMETERNAMEGet(), PARAMETERNAMEIsValid(), PARAMETERNAMELogicalToDisplay(), PARAMETERNAMELogicalToOdbc(), PARAMETERNAMENormalize(), PARAMETERNAMESet()
property SPECIFICCATALOG as %String (MAXLEN = 128) [ Calculated , SqlFieldName = SPECIFIC_CATALOG ];
Reserved for future use. Specific qualifier - always NULL in Caché.
Property methods: SPECIFICCATALOGCompute(), SPECIFICCATALOGDisplayToLogical(), SPECIFICCATALOGGet(), SPECIFICCATALOGIsValid(), SPECIFICCATALOGLogicalToDisplay(), SPECIFICCATALOGLogicalToOdbc(), SPECIFICCATALOGNormalize(), SPECIFICCATALOGSQLCompute()
property SPECIFICNAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = SPECIFIC_NAME , Required ];
Name of the routine (procedure).
Property methods: SPECIFICNAMEDisplayToLogical(), SPECIFICNAMEGet(), SPECIFICNAMEIsValid(), SPECIFICNAMELogicalToDisplay(), SPECIFICNAMELogicalToOdbc(), SPECIFICNAMENormalize(), SPECIFICNAMESet()
property SPECIFICSCHEMA as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = SPECIFIC_SCHEMA , Required ];
Name of schema that contains the routine.
Property methods: SPECIFICSCHEMADisplayToLogical(), SPECIFICSCHEMAGet(), SPECIFICSCHEMAIsValid(), SPECIFICSCHEMALogicalToDisplay(), SPECIFICSCHEMALogicalToOdbc(), SPECIFICSCHEMANormalize(), SPECIFICSCHEMASet()
property TOSQLSPECIFICCATALOG as %String (MAXLEN = 3) [ Calculated , SqlFieldName = TO_SQL_SPECIFIC_CATALOG ];
Reserved for future use. Always NULL in Caché.
Property methods: TOSQLSPECIFICCATALOGCompute(), TOSQLSPECIFICCATALOGDisplayToLogical(), TOSQLSPECIFICCATALOGGet(), TOSQLSPECIFICCATALOGIsValid(), TOSQLSPECIFICCATALOGLogicalToDisplay(), TOSQLSPECIFICCATALOGLogicalToOdbc(), TOSQLSPECIFICCATALOGNormalize(), TOSQLSPECIFICCATALOGSQLCompute()
property TOSQLSPECIFICNAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = TO_SQL_SPECIFIC_NAME ];
Reserved for future use. Always NULL in Caché.
Property methods: TOSQLSPECIFICNAMECompute(), TOSQLSPECIFICNAMEDisplayToLogical(), TOSQLSPECIFICNAMEGet(), TOSQLSPECIFICNAMEIsValid(), TOSQLSPECIFICNAMELogicalToDisplay(), TOSQLSPECIFICNAMELogicalToOdbc(), TOSQLSPECIFICNAMENormalize(), TOSQLSPECIFICNAMESQLCompute()
property TOSQLSPECIFICSCHEMA as %String (MAXLEN = 3) [ Calculated , SqlFieldName = TO_SQL_SPECIFIC_SCHEMA ];
Reserved for future use. Always NULL in Caché.
Property methods: TOSQLSPECIFICSCHEMACompute(), TOSQLSPECIFICSCHEMADisplayToLogical(), TOSQLSPECIFICSCHEMAGet(), TOSQLSPECIFICSCHEMAIsValid(), TOSQLSPECIFICSCHEMALogicalToDisplay(), TOSQLSPECIFICSCHEMALogicalToOdbc(), TOSQLSPECIFICSCHEMANormalize(), TOSQLSPECIFICSCHEMASQLCompute()

Indexes

index (PKeyIndex on SPECIFICSCHEMA,SPECIFICNAME,ORDINALPOSITION) [PrimaryKey];
Index methods: PKeyIndexCheck(), PKeyIndexCheckUnique(), PKeyIndexDelete(), PKeyIndexExists(), PKeyIndexOpen(), PKeyIndexSQLCheckUnique(), PKeyIndexSQLExists(), PKeyIndexSQLFindPKeyByConstraint(), PKeyIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: CacheSQLStorage

Maps: 1