ROUTINES Class Reference

Returns one row for each stored procedure and function that can be accessed by the current user in the current namespace. More...

Inheritance diagram for ROUTINES:

Collaboration diagram for ROUTINES:

Public Attributes
	ASLOCATOR
	Returns YES or NO based on if the return value of the function is a LOB oref value and not the actual data value of the LOB. More...
	CHARACTERMAXIMUMLENGTH
	Maximum length in characters, if the return type is a character type. More...
	CHARACTEROCTETLENGTH
	Reserved for future use. More...
	CHARACTERSETCATALOG
	Reserved for future use. More...
	CHARACTERSETNAME
	Reserved for future use. More...
	CHARACTERSETSCHEMA
	Reserved for future use. More...
	COLLATIONCATALOG
	Reserved for future use. More...
	COLLATIONNAME
	Reserved for future use. More...
	COLLATIONSCHEMA
	Reserved for future use. More...
	CREATED
	For InterSystems IRIS, CREATED is always NULL. More...
	Classname
	Name of the class that projected the Stored Procedure. More...
	DATATYPE
	Data type of the return value of the function. More...
	DATETIMEPRECISION
	Reserved for future use. More...
	DTDIDENTIFIER
	Reserved for future use. More...
	EXTERNALLANGUAGE
	Reserved for future use. More...
	EXTERNALNAME
	Reserved for future use. More...
	ISDETERMINISTIC
	Reserved for future use. More...
	ISIMPLICITLYINVOCABLE
	The values of IS_IMPLICITLY_INVOCABLE have the following meanings: More...
	ISNULLCALL
	The values of IS_NULL_CALL have the following meanings: More...
	ISUDTDEPENDENT
	Reserved for future use. More...
	ISUSERDEFINEDCAST
	The values of IS_USER_DEFINED_CAST have the following meanings: More...
	LASTALTERED
	For InterSystems IRIS, LAST_ALTERED is always NULL. More...
	MAXDYNAMICRESULTSETS
	Reserved for future use. More...
	MODULECATALOG
	Reserved for future use. More...
	MODULENAME
	Reserved for future use. More...
	MODULESCHEMA
	Reserved for future use. More...
	MethodQueryName
	Name of the class method or class query that projected this procedure. More...
	NEWSAVEPOINTLEVEL
	Reserved for future use. More...
	NUMERICPRECISION
	Numeric precision of the return value. More...
	NUMERICPRECISIONRADIX
	Numeric precision radix of the return value. More...
	NUMERICSCALE
	Scale of the return value. More...
	PARAMETERSTYLE
	Reserved for future use. More...
	RESULTCASTASLOCATOR
	Reserved for future use. More...
	RESULTCASTFROMDTDIDENTIFIER
	Reserved for future use. More...
	ROUTINEBODY
	The values of ROUTINE_BODY have the following meanings: More...
	ROUTINECATALOG
	Reserved for future use. More...
	ROUTINEDEFINITION
	/// The routine's query expression. More...
	ROUTINENAME
	Routine name, same as SPECIFIC_NAME. More...
	ROUTINESCHEMA
	Name of schema that contains the routine, same as SPECIFIC_SCHEMA. More...
	ROUTINETYPE
	The values of ROUTINE_TYPE have the following meanings: More...
	SCHEMALEVELROUTINE
	The values of SCHEMA_LEVEL_ROUTINE have the following meanings: More...
	SECURITYTYPE
	The values of SECURITY_TYPE have the following meanings: More...
	SPECIFICCATALOG
	Reserved for future use. More...
	SPECIFICNAME
	Specific name. More...
	SPECIFICSCHEMA
	Name of schema that contains the routine. More...
	SQLDATAACCESS
	SQL_DATA_ACCESS Returns one of the following values: More...
	SQLPATH
	Reserved for future use. More...
	TOSQLSPECIFICCATALOG
	Reserved for future use. More...
	TOSQLSPECIFICNAME
	Reserved for future use. More...
	TOSQLSPECIFICSCHEMA
	Reserved for future use. More...
	USERDEFINEDTYPECATALOG
	Reserved for future use. More...
	USERDEFINEDTYPENAME
	Reserved for future use. More...
	USERDEFINEDTYPESCHEMA
	Reserved for future use. More...

Additional Inherited Members
Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...
_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...
_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...
_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...
Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...
_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...
_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...
_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...
_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)
_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)
_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...
	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...
	DEFAULTGLOBAL = None
	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...
	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...
	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...
	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...
	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...
	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...
	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...
	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...
	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...
	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More...
	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...
	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...
	USEEXTENTSET = None
	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...
	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...
Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

Returns one row for each stored procedure and function that can be accessed by the current user in the current namespace.

Member Data Documentation

ASLOCATOR

ASLOCATOR

Returns YES or NO based on if the return value of the function is a LOB oref value and not the actual data value of the LOB.

AS_LOCATOR have the following meanings:

• YES - The return value of the routine being described is an stream oref.
• NO - The return value of the routine being described is not an stream oref.
• null - The routine is a class query procedure.

For InterSystems IRIS, AS_LOCATOR is always null unless the return value is a stream, then it is YES.  

CHARACTERMAXIMUMLENGTH

CHARACTERMAXIMUMLENGTH

Maximum length in characters, if the return type is a character type.

If not a character type, returns null.

 

CHARACTEROCTETLENGTH

CHARACTEROCTETLENGTH

Reserved for future use.

For InterSystems IRIS, CHARACTER_OCTET_LENGTH is always NULL.

 

CHARACTERSETCATALOG

CHARACTERSETCATALOG

Reserved for future use.

For InterSystems IRIS, CHARACTER_SET_CATALOG is always NULL.

 

CHARACTERSETNAME

CHARACTERSETNAME

Reserved for future use.

For InterSystems IRIS, CHARACTER_SET_NAME is always NULL.

 

CHARACTERSETSCHEMA

CHARACTERSETSCHEMA

Reserved for future use.

For InterSystems IRIS, CHARACTER_SET_SCHEMA is always NULL.

 

COLLATIONCATALOG

COLLATIONCATALOG

Reserved for future use.

For InterSystems IRIS, COLLATION_CATALOG is always NULL.

 

COLLATIONNAME

COLLATIONNAME

Reserved for future use.

For InterSystems IRIS, COLLATION_NAME is always NULL.

 

COLLATIONSCHEMA

COLLATIONSCHEMA

Reserved for future use.

For InterSystems IRIS, COLLATION_SCHEMA is always NULL.

 

CREATED

CREATED

For InterSystems IRIS, CREATED is always NULL.

 

Classname

Classname

Name of the class that projected the Stored Procedure.

 

DATATYPE

DATATYPE

Data type of the return value of the function.

Returns null if the procedure has no return value.

 

DATETIMEPRECISION

DATETIMEPRECISION

Reserved for future use.

For InterSystems IRIS, DATETIME_PRECISION is always NULL.

 

DTDIDENTIFIER

DTDIDENTIFIER

Reserved for future use.

For InterSystems IRIS, DTD_IDENTIFIER is always NULL.

 

EXTERNALLANGUAGE

EXTERNALLANGUAGE

Reserved for future use.

For InterSystems IRIS, EXTERNAL_LANGUAGE is always NULL.

 

EXTERNALNAME

EXTERNALNAME

Reserved for future use.

For InterSystems IRIS, EXTERNAL_NAME is always NULL.

 

ISDETERMINISTIC

ISDETERMINISTIC

Reserved for future use.

For InterSystems IRIS, IS_DETERMINISTIC is always NULL.

 

ISIMPLICITLYINVOCABLE

ISIMPLICITLYINVOCABLE

The values of IS_IMPLICITLY_INVOCABLE have the following meanings:

• YES - The user-defined cast function is implicitly invocable.
• NO - The user-defined cast function is not implicitly invocable.
• null - The routine is not a user-defined cast function.

Reserved for future use. For InterSystems IRIS, IS_IMPLICITLY_INVOCABLE is always null.  

ISNULLCALL

ISNULLCALL

The values of IS_NULL_CALL have the following meanings:

• YES - The routine is a function and returns null if any of its parameters are null.
• NO - The routine is a function and its return value is determined by invoking the routine.
• null - The routine being described is a class query procedure.

For InterSystems IRIS, if the routine is a function IS_NULL_CALL is always NO.  

ISUDTDEPENDENT

ISUDTDEPENDENT

Reserved for future use.

For InterSystems IRIS, IS_UDT_DEPENDENT is always NULL.

 

ISUSERDEFINEDCAST

ISUSERDEFINEDCAST

The values of IS_USER_DEFINED_CAST have the following meanings:

• YES - The routine is a function that is a user-defined cast function.
• NO - The routine is a function that is not a user-defined cast function.
• null - The routine being described is a class query procedure.

For InterSystems IRIS, if the routine is a function IS_USER_DEFINED_CAST is always NO.  

LASTALTERED

LASTALTERED

For InterSystems IRIS, LAST_ALTERED is always NULL.

 

MAXDYNAMICRESULTSETS

MAXDYNAMICRESULTSETS

Reserved for future use.

For InterSystems IRIS, MAX_DYNAMIC_RESULT_SETS is always NULL.

 

MODULECATALOG

MODULECATALOG

Reserved for future use.

For InterSystems IRIS, MODULE_CATALOG is always NULL.

 

MODULENAME

MODULENAME

Reserved for future use.

For InterSystems IRIS, MODULE_NAME is always NULL.

 

MODULESCHEMA

MODULESCHEMA

Reserved for future use.

For InterSystems IRIS, MODULE_SCHEMA is always NULL.

 

MethodQueryName

MethodQueryName

Name of the class method or class query that projected this procedure.

 

NEWSAVEPOINTLEVEL

NEWSAVEPOINTLEVEL

Reserved for future use.

For InterSystems IRIS, NEW_SAVEPOINT_LEVEL is always NULL.

 

NUMERICPRECISION

NUMERICPRECISION

Numeric precision of the return value.

For the nonnumeric types, returns NULL.

 

NUMERICPRECISIONRADIX

NUMERICPRECISIONRADIX

Numeric precision radix of the return value.

For nonnumeric types, returns NULL.

 

NUMERICSCALE

NUMERICSCALE

Scale of the return value.

For nonnumeric types, returns NULL.

 

PARAMETERSTYLE

PARAMETERSTYLE

Reserved for future use.

For InterSystems IRIS, PARAMETER_STYLE is always NULL.

 

RESULTCASTASLOCATOR

RESULTCASTASLOCATOR

Reserved for future use.

For InterSystems IRIS, RESULT_CAST_AS_LOCATOR is always NULL.

 

RESULTCASTFROMDTDIDENTIFIER

RESULTCASTFROMDTDIDENTIFIER

Reserved for future use.

For InterSystems IRIS, RESULT_CAST_FROM_DTD_IDENTIFIER is always NULL.

 

ROUTINEBODY

ROUTINEBODY

The values of ROUTINE_BODY have the following meanings:

• SQL - Means this routine is a class query with language SQL.
• EXTERNAL - Means this is not a class query with language SQL.

 

ROUTINECATALOG

ROUTINECATALOG

Reserved for future use.

Routine qualifier - always NULL in InterSystems IRIS.

 

ROUTINEDEFINITION

ROUTINEDEFINITION

/// The routine's query expression.

If longer than 8192 characters, or the routine is not an SQL class query, NULL is returned.

 

ROUTINENAME

ROUTINENAME

Routine name, same as SPECIFIC_NAME.

 

ROUTINESCHEMA

ROUTINESCHEMA

Name of schema that contains the routine, same as SPECIFIC_SCHEMA.

 

ROUTINETYPE

ROUTINETYPE

The values of ROUTINE_TYPE have the following meanings:

• PROCEDURE - The SQL-invoked routine is a query projected as a procedure.
• FUNCTION - The SQL-invoked routine is a function (method) projected as a procedure.

 

SCHEMALEVELROUTINE

SCHEMALEVELROUTINE

The values of SCHEMA_LEVEL_ROUTINE have the following meanings:

• YES - If the routine is a schema-level routine.
• NO - If the routine is not a schema-level routine.

For InterSystems IRIS, SCHEMA_LEVEL_ROUTINE is always YES.  

SECURITYTYPE

SECURITYTYPE

The values of SECURITY_TYPE have the following meanings:

• DEFINER - The routine has the security characteristic DEFINER.
• INVOKER - The routine has the security characteristic INVOKER.
• IMPLEMENTATION DEFINED - The external routine has the security characteristic IMPLEMENTATION DEFINED.
• null - Unknown security type.

For InterSystems IRIS, SECURITY_TYPE is always null.  

SPECIFICCATALOG

SPECIFICCATALOG

Reserved for future use.

Specific qualifier - always NULL in InterSystems IRIS.

 

SPECIFICNAME

SPECIFICNAME

Specific name.

 

SPECIFICSCHEMA

SPECIFICSCHEMA

Name of schema that contains the routine.

 

SQLDATAACCESS

SQLDATAACCESS

SQL_DATA_ACCESS Returns one of the following values:

• NO SQL = Function does not contain SQL.
• CONTAINS SQL = Function possibly contains SQL.
• READS SQL DATA = Function possibly reads SQL data.
• MODIFIES SQL DATA = Function possibly modifies SQL data.

Returns CONTAINS SQL for all functions, and READS SQL DATA for all class query procedure.  

SQLPATH

SQLPATH

Reserved for future use.

For InterSystems IRIS, SQL_PATH is always NULL.

 

TOSQLSPECIFICCATALOG

TOSQLSPECIFICCATALOG

Reserved for future use.

For InterSystems IRIS, TO_SQL_SPECIFIC_CATALOG is always NULL.

 

TOSQLSPECIFICNAME

TOSQLSPECIFICNAME

Reserved for future use.

For InterSystems IRIS, TO_SQL_SPECIFIC_NAME is always NULL.

 

TOSQLSPECIFICSCHEMA

TOSQLSPECIFICSCHEMA

Reserved for future use.

For InterSystems IRIS, TO_SQL_SPECIFIC_SCHEMA is always NULL.

 

USERDEFINEDTYPECATALOG

USERDEFINEDTYPECATALOG

Reserved for future use.

For InterSystems IRIS, USER_DEFINED_TYPE_CATALOG is always NULL.

 

USERDEFINEDTYPENAME

USERDEFINEDTYPENAME

Reserved for future use.

For InterSystems IRIS, USER_DEFINED_TYPE_NAME is always NULL.

 

USERDEFINEDTYPESCHEMA

USERDEFINEDTYPESCHEMA

Reserved for future use.

For InterSystems IRIS, USER_DEFINED_TYPE_SCHEMA is always NULL.