STATEMENTS Class Reference

Contains SQL Statement Index entries that can be accessed by the current user in the current namespace. More...

Inheritance diagram for STATEMENTS:

Collaboration diagram for STATEMENTS:

Public Attributes
	CallStack
	Call stack at the time the query was built. More...
	Children
	More...
	ClientApp
	Client application name at the time the query was built. More...
	ClientIP
	Client IP address at the time the query was built. More...
	ClientName
	Client name at the time the query was built. More...
	Days
	Breakdown of light weight SQL stats per day. More...
	DefaultSchema
	Value of defschema when the statement was compiled. More...
	Error
	Error string recorded for this plan. More...
	Frozen
	0/1/2/3 flag which defines if the statement plan Unfrozen (0), Frozen/Explicit (1), Frozen/Upgrade (2), or Unfrozen/Parallel (3) More...
	FrozenDifferent
	True if the frozen plan is different to what we would use if the plan was not frozen. More...
	Hash
	Internal unique statement hash used as the ID for the statement. More...
	JSONPlan
	Machine Readable Query Plan. More...
	Locations
	More...
	NaturalQuery
	Set to true for 'natural' queries which are already maximally efficient and for which. More...
	Packages
	Value of packages argument passed to SQL compiler when the statement was compiled. More...
	ParentHash
	Hash of this statement's parent statement. More...
	Plan
	Query plan. More...
	PrivilegeRelations
	More...
	Relations
	More...
	SQLSchemaPath
	Value of sqlSchemaPath when the statement was compiled. More...
	SQLStatementID
	A Unique SQL Statement Identifier which can be used to identify each SQL Statement that is stored in the SQL Statement Index (SSI)... More...
	SqlComp
	SQL Compilation mode, Logical, Odbc, Display, Runtime, etc., when the statement was compiled. More...
	StatAverage
	Average time spent running this query. More...
	StatCommands
	Total ObjectScript commands executed from running this query. More...
	StatCount
	Total number of times we have recorded this query being run. More...
	StatFirst
	First day we recorded statistics from running this query. More...
	StatRowCount
	Total ROWCOUNT from running this query. More...
	StatStdDev
	Standard deviation of the time measurement for this query. More...
	StatTotal
	Total time spent running this query. More...
	StatVariance
	Variance in time from running this query. More...
	Statement
	More...
	Switch
	Value of switch when the statement was compiled. More...
	Timestamp
	Timestamp value for when the plan was saved. More...
	UserName
	$username at the time the query was built More...
	Version
	$zversion string for when the plan was saved. More...

Private Attributes
	__BinaryPlan
	Binary Query plan. 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...
Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...
_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...
_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. 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 Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...
_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...
_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...
_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. 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...
Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...
	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...
	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...
	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...
	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...
	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...
	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...
	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

Contains SQL Statement Index entries that can be accessed by the current user in the current namespace.

Member Data Documentation

__BinaryPlan

__BinaryPlan

private

Binary Query plan.

 

CallStack

CallStack

Call stack at the time the query was built.

 

Children

Children

 

 

ClientApp

ClientApp

Client application name at the time the query was built.

 

ClientIP

ClientIP

Client IP address at the time the query was built.

 

ClientName

ClientName

Client name at the time the query was built.

 

Days

Days

Breakdown of light weight SQL stats per day.

 

DefaultSchema

DefaultSchema

Value of defschema when the statement was compiled.

 

Error

Error

Error string recorded for this plan.

 

Frozen

Frozen

0/1/2/3 flag which defines if the statement plan Unfrozen (0), Frozen/Explicit (1), Frozen/Upgrade (2), or Unfrozen/Parallel (3)

 

FrozenDifferent

FrozenDifferent

True if the frozen plan is different to what we would use if the plan was not frozen.

 

Hash

Hash

Internal unique statement hash used as the ID for the statement.

 

JSONPlan

JSONPlan

Machine Readable Query Plan.

 

Locations

Locations

 

 

NaturalQuery

NaturalQuery

Set to true for 'natural' queries which are already maximally efficient and for which.

we do not collect any statistics as the overhead of statistical collection would have a significant impact on the statement performance.  

Packages

Packages

Value of packages argument passed to SQL compiler when the statement was compiled.

 

ParentHash

ParentHash

Hash of this statement's parent statement.

Only defined if this is a recursive compile for PARALLEL statements. This references the root parent's hash.

 

Plan

Plan

Query plan.

 

PrivilegeRelations

PrivilegeRelations

 

 

Relations

Relations

 

 

SQLSchemaPath

SQLSchemaPath

Value of sqlSchemaPath when the statement was compiled.

 

SQLStatementID

SQLStatementID

A Unique SQL Statement Identifier which can be used to identify each SQL Statement that is stored in the SQL Statement Index (SSI)...

 

SqlComp

SqlComp

SQL Compilation mode, Logical, Odbc, Display, Runtime, etc., when the statement was compiled.

 

StatAverage

StatAverage

Average time spent running this query.

 

StatCommands

StatCommands

Total ObjectScript commands executed from running this query.

 

StatCount

StatCount

Total number of times we have recorded this query being run.

 

StatFirst

StatFirst

First day we recorded statistics from running this query.

 

StatRowCount

StatRowCount

Total ROWCOUNT from running this query.

 

StatStdDev

StatStdDev

Standard deviation of the time measurement for this query.

 

StatTotal

StatTotal

Total time spent running this query.

 

StatVariance

StatVariance

Variance in time from running this query.

 

Statement

Statement

 

 

Switch

Switch

Value of switch when the statement was compiled.

 

Timestamp

Timestamp

Timestamp value for when the plan was saved.

 

UserName

UserName

$username at the time the query was built

 

Version

Version

$zversion string for when the plan was saved.