PARAMETERS Class Reference

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. More...

Inheritance diagram for PARAMETERS:

Collaboration diagram for PARAMETERS:

Public Attributes
	ASLOCATOR
	Returns YES or NO based on if the parameter 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 varchar or varbinary 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...
	DATATYPE
	Data type of the parameter. More...
	DATETIMEPRECISION
	Reserved for future use. More...
	DTDIDENTIFIER
	Reserved for future use. More...
	FROMSQLSPECIFICCATALOG
	Reserved for future use. More...
	FROMSQLSPECIFICNAME
	Reserved for future use. More...
	FROMSQLSPECIFICSCHEMA
	Reserved for future use. More...
	ISRESULT
	The values of IS_RESULT have the following meanings: 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...
	ORDINALPOSITION
	Parameter's ordinal position within the procedure method or query, starting with 1. More...
	PARAMETERMODE
	The values of PARAMETER_MODE have the following meanings: More...
	PARAMETERNAME
	Name of the parameter. More...
	SPECIFICCATALOG
	Reserved for future use. More...
	SPECIFICNAME
	Name of the routine (procedure). More...
	SPECIFICSCHEMA
	Name of schema that contains the routine. More...
	TOSQLSPECIFICCATALOG
	Reserved for future use. More...
	TOSQLSPECIFICNAME
	Reserved for future use. More...
	TOSQLSPECIFICSCHEMA
	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

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.

Member Data Documentation

ASLOCATOR

ASLOCATOR

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.  

CHARACTERMAXIMUMLENGTH

CHARACTERMAXIMUMLENGTH

Maximum length in characters, if the return type is a varchar or varbinary 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.

 

DATATYPE

DATATYPE

Data type of the parameter.

 

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.

 

FROMSQLSPECIFICCATALOG

FROMSQLSPECIFICCATALOG

Reserved for future use.

Always NULL in InterSystems IRIS.

 

FROMSQLSPECIFICNAME

FROMSQLSPECIFICNAME

Reserved for future use.

Always NULL in InterSystems IRIS.

 

FROMSQLSPECIFICSCHEMA

FROMSQLSPECIFICSCHEMA

Reserved for future use.

Always NULL in InterSystems IRIS.

 

ISRESULT

ISRESULT

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.

 

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.

 

ORDINALPOSITION

ORDINALPOSITION

Parameter's ordinal position within the procedure method or query, starting with 1.

For the return value of a method/function, this is 0.

 

PARAMETERMODE

PARAMETERMODE

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.

 

PARAMETERNAME

PARAMETERNAME

Name of the parameter.

 

SPECIFICCATALOG

SPECIFICCATALOG

Reserved for future use.

Specific qualifier - always NULL in InterSystems IRIS.

 

SPECIFICNAME

SPECIFICNAME

Name of the routine (procedure).

 

SPECIFICSCHEMA

SPECIFICSCHEMA

Name of schema that contains the routine.

 

TOSQLSPECIFICCATALOG

TOSQLSPECIFICCATALOG

Reserved for future use.

Always NULL in InterSystems IRIS.

 

TOSQLSPECIFICNAME

TOSQLSPECIFICNAME

Reserved for future use.

Always NULL in InterSystems IRIS.

 

TOSQLSPECIFICSCHEMA

TOSQLSPECIFICSCHEMA

Reserved for future use.

Always NULL in InterSystems IRIS.