Class INFORMATION.SCHEMA.STATEMENTS

persistent class INFORMATION.SCHEMA.STATEMENTS extends %Library.Persistent, %XML.Adaptor

SQL Table Name: STATEMENTS

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

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	39	1

Summary

Properties
CallStack	Children	ClientApp	ClientIP
ClientName	Days	DefaultSchema	Error
Frozen	FrozenDifferent	Hash	JSONPlan
Locations	NaturalQuery	Packages	ParentHash
Plan	PrivilegeRelations	Relations	SQLSchemaPath
SQLStatementID	SqlComp	StatAverage	StatCommands
StatCount	StatFirst	StatRowCount	StatStdDev
StatTotal	StatVariance	Statement	Switch
Timestamp	UserName	Version

Methods
%AddToSaveSet	%AddToSyncSet	%BuildDeferredIndices	%BuildIndicesAsync
%BuildIndicesAsyncResponse	%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	%IsA	%IsModified
%IsNull	%KillExtent	%LockExtent	%LockId
%New	%NormalizeObject	%ObjectIsNull	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDeleteFinally	%OnDetermineClass
%OnOpenFinally	%OnSaveFinally	%Open	%OpenId
%OriginalNamespace	%PackageName	%PurgeIndices	%Reload
%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack	%Save
%SaveDirect	%SerializeObject	%SetModified	%SortBegin
%SortEnd	%SyncObjectIn	%SyncTransport	%UnlockExtent
%UnlockId	%ValidateIndices	%ValidateObject	%ValidateTable
GetBinaryPlan	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType

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 CallStack as %List;

Call stack at the time the query was built

• relationship Children as INFORMATION.SCHEMA.STATEMENTCHILDREN [ Inverse = Statement,Cardinality = children ];

• property ClientApp as %String;

Client application name at the time the query was built

• property ClientIP as %String;

Client IP address at the time the query was built

• property ClientName as %String;

Client name at the time the query was built

• relationship Days as INFORMATION.SCHEMA.STATEMENTDAILYSTATS(XMLPROJECTION="NONE") [ Inverse = Statement,Cardinality = children ];

Breakdown of light weight SQL stats per day

• property DefaultSchema as %Library.List;

Value of %defschema when the statement was compiled

• property Error as %String(MAXLEN=4096);

Error string recorded for this plan

• property Frozen as %Integer;

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

• property FrozenDifferent as %Boolean;

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

• property Hash as %String(MAXLEN=32) [ Required ];

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

• property JSONPlan as %String(XMLPROJECTION="NONE") [ Calculated ];

Machine Readable Query Plan

• relationship Locations as INFORMATION.SCHEMA.STATEMENTLOCATIONS(XMLPROJECTION="NONE") [ Inverse = Statement,Cardinality = children ];

• property NaturalQuery as %Boolean;

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.

• property Packages as %Library.List;

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

• property ParentHash as %String(MAXLEN=32);

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.

• property Plan as %String(XMLPROJECTION="NONE") [ Calculated ];

Query plan

• relationship PrivilegeRelations as INFORMATION.SCHEMA.STATEMENTPRIVOBJECTS [ Inverse = Statements,Cardinality = children ];

• relationship Relations as INFORMATION.SCHEMA.STATEMENTRELATIONS [ Inverse = Statement,Cardinality = children ];

• property SQLSchemaPath as %Library.List;

Value of %sqlSchemaPath when the statement was compiled

• property SQLStatementID as %Integer;

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

• property SqlComp as %String(MAXLEN=32);

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

• property StatAverage as %Double [ Calculated ];

Average time spent running this query

• property StatCommands as %Integer;

Total ObjectScript commands executed from running this query

• property StatCount as %Integer;

Total number of times we have recorded this query being run

• property StatFirst as %Date;

First day we recorded statistics from running this query

• property StatRowCount as %Integer;

Total %ROWCOUNT from running this query

• property StatStdDev as %Double [ Calculated ];

Standard deviation of the time measurement for this query

• property StatTotal as %Double;

Total time spent running this query

• property StatVariance as %Double;

Variance in time from running this query

• property Statement as %String(COLLATION="SQLSTRING",MAXLEN=262144);

• property Switch as %String(MAXLEN=32);

Value of %switch when the statement was compiled

• property Timestamp as %TimeStamp;

Timestamp value for when the plan was saved.

• property UserName as %String;

$username at the time the query was built

• property Version as %String(MAXLEN=200);

$zversion string for when the plan was saved.

Methods

• method GetBinaryPlan(plan) as %Status

Class Reference IRIS for UNIX 2024.1.2
Documentation Search