Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %SYS.PTools.SQLBenchMarkResults
Private  Storage   

%SYS.PTools.SQLBenchMarkResults


persistent class %SYS.PTools.SQLBenchMarkResults extends
%Persistent

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
10 1 1


Summary


Properties
FRGlobalRefs FRLines FRRunTime GlobalRefs Lines
QueryId Rowcount Run RunTime StartTS

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %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 %InsertBatch %IsA
%IsModified %IsNull %KillExtent %KillExtentData
%LoadFromMemory %LockExtent %LockId %New
%NormalizeObject %ObjectIsNull %ObjectModified %Oid
%OnBeforeAddToSync %OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SaveIndices %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject clearSQLBenchMarkRslt


Properties


• property FRGlobalRefs as %Integer;
Number of Global References to fetch the first row
• property FRLines as %Integer;
Number of lines executed to fetch the first row
• property FRRunTime as %Time;
Time to fetch the first row
• property GlobalRefs as %Integer;
Number of Global References for all rows
• property Lines as %Integer;
Number of lines executed for all rows
• property QueryId as %SYS.PTools.SQLBenchMarkQueries;
• property Rowcount as %Integer;
Number of rows returned by the query
• property Run as %Integer;
• property RunTime as %Time;
Time to fetch all rows
• property StartTS as %TimeStamp;

Methods


• classmethod clearSQLBenchMarkRslt(ns As %String = "", rtn As %String = "", ph3 As %Integer = 0, clearErrs As %Integer = 0, returnType As %Integer = 0, ByRef ptInfo As %ArrayOfObjects) as %Status [ SQLProc = PT_clearSQLBenchMarkRslt ]

------------------------------------------------------------------------------- -- DEPRECATED --- DEPRECATED --- DEPRECATED --- DEPRECATED --- DEPRECATED -- Method: clearSQLBenchMarkRslt [SQL: PT_clearSQLBenchMarkRslt] Replaced BY: N/A Status: New Functionality Purpose: Delete all of the data stored in the '%SYS.PTools.SQLBenchMarkResults' class, based on the specified parameters... Invocation: This method can be invoked in the following ways: ObjectScript: ##class(%SYS.PTools.SQLBenchMarkResults).clearSQLBenchMarkRslt(...) SQL: CALL %SYS_PTools.PT_clearSQLBenchMarkRslt(...) SELECT %SYS_PTools.PT_clearSQLBenchMarkRslt(...) NOTE: This 'SqlProc' method can be invoked with either the CALL-interface or the SELECT-interface. Both interfaces execute the method: the CALL-interface does not return any resulting value, while the SELECT-interface does. Examples: The following examples shows the use of this method: #1 Delete all of the data stored in the '%SYS.PTools.SQLBenchMarkResults' class in the 'SAMPLES' namespace: set stats=##class(%SYS.PTools.SQLBenchMarkResults).clearSQLBenchMarkRslt("SAMPLES") Data Storage: ^%sqlcq($NAMESPACE,"PTools","Bench","Results","{D|I|C|S}") Parameters: ns - The namespace in which to clear SQL Statistics If none provided, use the current namespaces where SQL Stats collected [DEFAULT: Current Namespace] rtn - The routine for which to clear SQL Statistics If none provided, clear all routines in the given 'ns' [OPTIONAL] ph3 - Placeholder Parameter for future extensibility clearAll - 0 = Perform a normal clear, but leave the 'INFO' rows 1 = Clear everything including the 'INFO' rows [DEFAULT: 0] clearErrs - 0 = Don't delete the 'PTools' Application Errors 1 = Delete all of the 'PTools' Application Errors [DEFAULT: 0] returnType - 0 = Return a %Status code of either $$$OK or $$$ERROR() 1 = Return the number of Stats rows deleted from the following class: %SYS.PTools.SQLBenchMarkResults [DEFAULT: 0] ptInfo - A Pass By Reference information array that returns detailed information to the user in the following format: ptInfo(category,variable)=value OR $LB(val1,...,valn) Where category = { "cnt" | "curr" | "term" | ... } variable = A var corresponding to the given 'category' Example: ptInfo("cnt","clearSQLBenchMarkRslt")=The number of rows deleted via this method [Routine Method] RETURN Value: Based on the value of the 'returnType' parameter, return one of the following: 0: Return a %Status code of either $$$OK or $$$ERROR() 1: Return the number of Stats rows deleted from the following class; Otherwise, return an error message if an error occurred: %SYS.PTools.SQLBenchMarkResults -------------------------------------------------------------------------------


Triggers


•trigger OnDelete (AFTER event DELETE)