Routine is a generic class that models stored routines - both procedures and functions.
Properties
ODBCcatalog is a serialized list of the ODBC catalog metadata object.
column description
Set $$$PROCodbccatalog($$$pPROC,SCHEMA,PROC)=$lb("",schema,proc,$$$PROCinputparms($$$pPROC,SCHEMA,PROC),$$$PROCoutputparms($$$pPROC,SCHEMA,PROC),$$$PROCresultsets($$$pPROC,SCHEMA,PROC),$$$PROCremarks($$$pPROC,SCHEMA,PROC),0,proc)
catalog Catalog - normally this is empty
schema Schema name
routine Routine name
Property methods: ODBCcatalogDisplayToLogical(), ODBCcatalogGet(), ODBCcatalogGetStored(), ODBCcatalogIsValid(), ODBCcatalogLogicalToDisplay(), ODBCcatalogLogicalToOdbc(), ODBCcatalogNormalize(), ODBCcatalogSet()
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
Name Description
ODBCType ODBC Type
Precision
Scale
nullable NULLABLE (integer)
label Column Label (same as Name)
table Column Table Name
schema Column Schema Name
qualifier Column Qualifier Name - NULL
columnoptions $Char(1)/$Char(0) string
position Option
1 isAutoIncrement
2 isCaseSensitive
3 isCurrency
4 isReadOnly
5 isRowVersion
6 isUnique
7 isAliased
8 isExpression
9 isHidden
10 isIdentity
11 isKeyColumn
12 isRowid
parmCount Number of Parameters
parameters one for each parameter
Parameter metadata
ODBCType ODBC Type
precision Precision
scale Scale
nullable NULLABLE
colName Column (parameter) name
colType
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 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()
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()
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()
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()
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 methods: parmslengthDisplayToLogical(), parmslengthGet(), parmslengthGetStored(), parmslengthIsValid(), parmslengthLogicalToDisplay(), parmslengthLogicalToOdbc(), parmslengthNormalize(), parmslengthSet()
property parmsobjectcat as %String );
Property methods: parmsobjectcatDisplayToLogical(), parmsobjectcatGet(), parmsobjectcatGetStored(), parmsobjectcatIsValid(), parmsobjectcatLogicalToDisplay(), parmsobjectcatLogicalToOdbc(), parmsobjectcatNormalize(), parmsobjectcatSet()
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 methods: remarksDisplayToLogical(), remarksGet(), remarksGetStored(), remarksIsValid(), remarksLogicalToDisplay(), remarksLogicalToOdbc(), remarksNormalize(), remarksSet()
Property methods: resultsetsDisplayToLogical(), resultsetsGet(), resultsetsGetStored(), resultsetsIsValid(), resultsetsLogicalToDisplay(), resultsetsLogicalToOdbc(), resultsetsNormalize(), resultsetsSet()
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()
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 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 methods: statementtypeDisplayToLogical(), statementtypeGet(), statementtypeGetStored(), statementtypeIsValid(), statementtypeLogicalToDisplay(), statementtypeNormalize(), statementtypeSet()