%SQL.DICT.Routine
hidden persistent class %SQL.DICT.Routine extends %Library.Persistent
SQL Table Name: %SQL_DICT.Routine
Routine is a generic class that models stored routines - both procedures and functions.Property Inventory
- ODBCcatalog
- ODBCinfo
- PROCID
- SCHEMAID
- class
- columns
- contextclass
- description
- executestring
- hidden
- idcolumn
- idextent
- informixlegacy
- inputparms
- interface
- outputparms
- parmsdirection
- parmslength
- parmsobjectcat
- projected
- remarks
- resultsets
- returnval
- routine
- routinetype
- schemaname
- selectmode
- signature
- sqlname
- statementtype
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 ODBCcatalog as %String);
ODBCcatalog is a serialized list of the ODBC catalog metadata object.
| column | description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| catalog | Catalog - normally this is empty | schema | Schema name | routine | Routine name |
Property methods: ODBCcatalogDisplayToLogical(), ODBCcatalogGet(), ODBCcatalogGetStored(), ODBCcatalogIsValid(), ODBCcatalogLogicalToDisplay(), ODBCcatalogLogicalToOdbc(), ODBCcatalogNormalize(), ODBCcatalogSet()
property ODBCinfo as %String);
ODBCinfo is a $List containing the interface, column count, column metadata for each column, parameter count, and parameter metadata for each parameter.
| column | description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| interface | refer to interface property for values | ||||||||||||||||||||||||||||||||||||||||||||||||
| column count | Number of columns | ||||||||||||||||||||||||||||||||||||||||||||||||
| columns | one for each column | ||||||||||||||||||||||||||||||||||||||||||||||||
Column metadata
|
|||||||||||||||||||||||||||||||||||||||||||||||||
| parmCount | Number of Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||
| parameters | one for each parameter | ||||||||||||||||||||||||||||||||||||||||||||||||
Parameter metadata
|
Property methods: ODBCinfoDisplayToLogical(), ODBCinfoGet(), ODBCinfoGetStored(), ODBCinfoIsValid(), ODBCinfoLogicalToDisplay(), ODBCinfoLogicalToOdbc(), ODBCinfoNormalize(), ODBCinfoSet()
property PROCID as %String (MAXLEN = 128) [ Required ];
UPPERCASE Routine name
Property methods: PROCIDDisplayToLogical(), PROCIDGet(), PROCIDGetStored(), PROCIDIsValid(), PROCIDLogicalToDisplay(), PROCIDLogicalToOdbc(), PROCIDNormalize(), PROCIDSet()
property SCHEMAID as %String (MAXLEN = 128) [ Required ];
UPPERCASE Schema name
Property methods: SCHEMAIDDisplayToLogical(), SCHEMAIDGet(), SCHEMAIDGetStored(), SCHEMAIDIsValid(), SCHEMAIDLogicalToDisplay(), SCHEMAIDLogicalToOdbc(), SCHEMAIDNormalize(), SCHEMAIDSet()
property class as %String (MAXLEN = 220);
The name of the class containing the projecting member (query or method).
Property methods: classDisplayToLogical(), classGet(), classGetStored(), classIsValid(), classLogicalToDisplay(), classLogicalToOdbc(), classNormalize(), classSet()
relationship columns as array of %SQL.DICT.RoutineColumn [ InitialExpression = $listbuild("%SQL.DICT.RoutineColumn","routine",+$this,"children",1,1) , Transient , Inverse = routine , Cardinality = children ];
All of the columns defined for this routine. That includes the return value, result columns,
input, input-output and output columns. If this routine includes a prepared cursor (currently,
only routines defined as interface = 1 include a prepared cursor) then there will be result columns
in the columns. Otherwise, only returntype, input, input-output and output columns will be present.
These column types (all but result column) collectively form what is often calls the "parameters".
Property methods: columnsGet(), columnsGetObject(), columnsGetObjectId(), columnsGetSwizzled(), columnsIsEmpty(), columnsIsValid(), columnsNewObject(), columnsRClose(), columnsRExec(), columnsRFetch(), columnsRelate(), columnsSQLCompute(), columnsSet(), columnsUnRelate()
property contextclass as %String (MAXLEN = 220);
The name of the %Library.ProcedureContext subclass prepared for dynamically calling
the routine from the server.
Property methods: contextclassDisplayToLogical(), contextclassGet(), contextclassGetStored(), contextclassIsValid(), contextclassLogicalToDisplay(), contextclassLogicalToOdbc(), contextclassNormalize(), contextclassSet()
property description as %String);
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionGetStored(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property executestring as %String);
The COS expression used to call this routine from %SYS.DBSRV
Property methods: executestringDisplayToLogical(), executestringGet(), executestringGetStored(), executestringIsValid(), executestringLogicalToDisplay(), executestringLogicalToOdbc(), executestringNormalize(), executestringSet()
If true then hidden indicates that this routine is not included by the catalog query.
Property methods: hiddenDisplayToLogical(), hiddenGet(), hiddenGetStored(), hiddenIsValid(), hiddenLogicalToDisplay(), hiddenNormalize(), hiddenSet()
property idcolumn as %String);
For query procedures, idcolumn is the CONTAINID value.
Property methods: idcolumnDisplayToLogical(), idcolumnGet(), idcolumnGetStored(), idcolumnIsValid(), idcolumnLogicalToDisplay(), idcolumnLogicalToOdbc(), idcolumnNormalize(), idcolumnSet()
property idextent as %String (MAXLEN = 220);
For query procedures, idextent is the name of the extent referenced by the type of the idcolumn.
Property methods: idextentDisplayToLogical(), idextentGet(), idextentGetStored(), idextentIsValid(), idextentLogicalToDisplay(), idextentLogicalToOdbc(), idextentNormalize(), idextentSet()
property informixlegacy as %Boolean;
If true then informixlegacy indicates that return values are returned as a single row result set.
Property methods: informixlegacyDisplayToLogical(), informixlegacyGet(), informixlegacyGetStored(), informixlegacyIsValid(), informixlegacyLogicalToDisplay(), informixlegacyNormalize(), informixlegacySet()
property inputparms as %Integer;
The number of input parameters declared by the procedure
Property methods: inputparmsDisplayToLogical(), inputparmsGet(), inputparmsGetStored(), inputparmsIsValid(), inputparmsLogicalToDisplay(), inputparmsNormalize(), inputparmsSet()
property interface as %Integer (VALUELIST = ",-2,-1,0,1,2");
cPROCinterface
| -2 | Procedure with a return value that may return result sets |
| -1 | Procedure without a return value that may return result sets |
| 0 | Procedure without a return value, no result sets |
| 1 | query procedure (single static result set) |
| 2 | function with a return value, no result sets |
Property methods: interfaceDisplayToLogical(), interfaceGet(), interfaceGetStored(), interfaceIsValid(), interfaceLogicalToDisplay(), interfaceNormalize(), interfaceSet()
property outputparms as %Integer;
The number of output parameters declared by the procedure
Property methods: outputparmsDisplayToLogical(), outputparmsGet(), outputparmsGetStored(), outputparmsIsValid(), outputparmsLogicalToDisplay(), outputparmsNormalize(), outputparmsSet()
property parmsdirection as %String);
Property methods: parmsdirectionDisplayToLogical(), parmsdirectionGet(), parmsdirectionGetStored(), parmsdirectionIsValid(), parmsdirectionLogicalToDisplay(), parmsdirectionLogicalToOdbc(), parmsdirectionNormalize(), parmsdirectionSet()
property parmslength as %String);
Property methods: parmslengthDisplayToLogical(), parmslengthGet(), parmslengthGetStored(), parmslengthIsValid(), parmslengthLogicalToDisplay(), parmslengthLogicalToOdbc(), parmslengthNormalize(), parmslengthSet()
property parmsobjectcat as %String);
Property methods: parmsobjectcatDisplayToLogical(), parmsobjectcatGet(), parmsobjectcatGetStored(), parmsobjectcatIsValid(), parmsobjectcatLogicalToDisplay(), parmsobjectcatLogicalToOdbc(), parmsobjectcatNormalize(), parmsobjectcatSet()
property projected as %Boolean;
projected is true if this routine is callable as a stored procedure/function. Some queries
are compiled as a stored routine but not callable unless they are defined as SQLPROC.
Property methods: projectedDisplayToLogical(), projectedGet(), projectedGetStored(), projectedIsValid(), projectedLogicalToDisplay(), projectedNormalize(), projectedSet()
property remarks as %String);
Property methods: remarksDisplayToLogical(), remarksGet(), remarksGetStored(), remarksIsValid(), remarksLogicalToDisplay(), remarksLogicalToOdbc(), remarksNormalize(), remarksSet()
property resultsets as %String);
Property methods: resultsetsDisplayToLogical(), resultsetsGet(), resultsetsGetStored(), resultsetsIsValid(), resultsetsLogicalToDisplay(), resultsetsLogicalToOdbc(), resultsetsNormalize(), resultsetsSet()
property returnval as %Boolean;
Property methods: returnvalDisplayToLogical(), returnvalGet(), returnvalGetStored(), returnvalIsValid(), returnvalLogicalToDisplay(), returnvalNormalize(), returnvalSet()
property routine as %String (MAXLEN = 220);
routine is the name of the projecting item - method or query depending on routinetype.
Property methods: routineDisplayToLogical(), routineGet(), routineGetStored(), routineIsValid(), routineLogicalToDisplay(), routineLogicalToOdbc(), routineNormalize(), routineSet()
property routinetype as %String (VALUELIST = ",function,query");
routinetype is the projecting item member type - function (aka method) or query.
Property methods: routinetypeDisplayToLogical(), routinetypeGet(), routinetypeGetStored(), routinetypeIsValid(), routinetypeLogicalToDisplay(), routinetypeLogicalToOdbc(), routinetypeNormalize(), routinetypeSet()
property schemaname as %String (MAXLEN = 128);
The name of the schema where this routine is defined. The fully qualified routine name is schemaname.sqlname.
Property methods: schemanameDisplayToLogical(), schemanameGet(), schemanameGetStored(), schemanameIsValid(), schemanameLogicalToDisplay(), schemanameLogicalToOdbc(), schemanameNormalize(), schemanameSet()
property selectmode as %Integer;
selectmode is the selectmode defined for the routine. The values are 0 = logical, 1 = odbc , 2 = display, and 3 = runtime.
Property methods: selectmodeDisplayToLogical(), selectmodeGet(), selectmodeGetStored(), selectmodeIsValid(), selectmodeLogicalToDisplay(), selectmodeNormalize(), selectmodeSet()
property signature as %String);
Property methods: signatureDisplayToLogical(), signatureGet(), signatureGetStored(), signatureIsValid(), signatureLogicalToDisplay(), signatureLogicalToOdbc(), signatureNormalize(), signatureSet()
property sqlname as %String (MAXLEN = 128);
The SQLNAME of the routine.
Property methods: sqlnameDisplayToLogical(), sqlnameGet(), sqlnameGetStored(), sqlnameIsValid(), sqlnameLogicalToDisplay(), sqlnameLogicalToOdbc(), sqlnameNormalize(), sqlnameSet()
property statementtype as %Integer;
Property methods: statementtypeDisplayToLogical(), statementtypeGet(), statementtypeGetStored(), statementtypeIsValid(), statementtypeLogicalToDisplay(), statementtypeNormalize(), statementtypeSet()
Indexes
index (idk on SCHEMAID,PROCID) [IdKey, Type = key];
Index methods: idkCheck(), idkDelete(), idkExists(), idkOpen(), idkSQLCheckUnique(), idkSQLExists(), idkSQLFindPKeyByConstraint(), idkSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %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()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
Storage
Storage Model: CacheStorage (%SQL.DICT.Routine)
^oddPROC(ID,$$$cPROCodbccatalog) | = | ODBCcatalog |
^oddPROC(ID,$$$cPROCodbcinfo) | = | ODBCinfo |
^oddPROC(ID,$$$cPROCclass) | = | class |
^oddPROC(ID,$$$cPROCcontextclass) | = | contextclass |
^oddPROC(ID,$$$cPROCdescription) | = | description |
^oddPROC(ID,$$$cPROCexecute) | = | executestring |
^oddPROC(ID,$$$cPROChidden) | = | hidden |
^oddPROC(ID,$$$cPROCidcolumn) | = | idcolumn |
^oddPROC(ID,$$$cPROCidextent) | = | idextent |
^oddPROC(ID,$$$cPROCinformixlegacy) | = | informixlegacy |
^oddPROC(ID,$$$cPROCinputparms) | = | inputparms |
^oddPROC(ID,$$$cPROCinterface) | = | interface |
^oddPROC(ID,$$$cPROCoutputparms) | = | outputparms |
^oddPROC(ID,$$$cPROCparmsdirection) | = | parmsdirection |
^oddPROC(ID,$$$cPROCparmslength) | = | parmslength |
^oddPROC(ID,$$$cPROCparmsobjectcat) | = | parmsobjectcat |
^oddPROC(ID,$$$cPROCprojected) | = | projected |
^oddPROC(ID,$$$cPROCremarks) | = | remarks |
^oddPROC(ID,$$$cPROCresultsets) | = | resultsets |
^oddPROC(ID,$$$cPROCreturnval) | = | returnval |
^oddPROC(ID,$$$cPROCprocedure) | = | routine |
^oddPROC(ID,$$$cPROCtype) | = | routinetype |
^oddPROC(ID,$$$cPROCschema) | = | schemaname |
^oddPROC(ID,$$$cPROCselectmode) | = | selectmode |
^oddPROC(ID,$$$cPROCsignature) | = | signature |
^oddPROC(ID,$$$cPROCname) | = | sqlname |
^oddPROC(ID,$$$cPROCstatementtype) | = | statementtype |