%SYS
SQLBenchMarkResults Class Reference

<style type="text/css"> DEP { color: red; font-weight: bold; } BC { color: green; font-weight: bold; } PROP { display: block; white-space: pre; font-size: 16px; font-family: monospace; } STUB { color: DarkGoldenRod ; } IMP { color: red; font-style: italic; } .dep-head { color: red; white-space: pre; font-family: 'Courier New'; } .section-head { color: blue; white-space: pre; font-family: 'Courier New'; } .info-head { white-space: pre; font-family: 'Courier New'; } </style> More...

Inheritance diagram for SQLBenchMarkResults:
Collaboration diagram for SQLBenchMarkResults:

Static Public Member Functions

 TriggerOnDelete (timing)
 Perform the OnDelete Trigger operations for this class...
 
_.Library.Status clearSQLBenchMarkRslt (_.Library.String ns, _.Library.String rtn, _.Library.Integer ph3, _.Library.Integer clearErrs, _.Library.Integer returnType, _.Library.RawString ptInfo)
 

Public Attributes

 FRGlobalRefs
 Number of Global References to fetch the first row. More...
 
 FRLines
 Number of lines executed to fetch the first row. More...
 
 FRRunTime
 Time to fetch the first row. More...
 
 GlobalRefs
 Number of Global References for all rows. More...
 
 Lines
 Number of lines executed for all rows. More...
 
 QueryId
   More...
 
 Rowcount
 Number of rows returned by the query. More...
 
 Run
   More...
 
 RunTime
 Time to fetch all rows. More...
 
 StartTS
   More...
 

Detailed Description

<style type="text/css"> DEP { color: red; font-weight: bold; } BC { color: green; font-weight: bold; } PROP { display: block; white-space: pre; font-size: 16px; font-family: monospace; } STUB { color: DarkGoldenRod ; } IMP { color: red; font-style: italic; } .dep-head { color: red; white-space: pre; font-family: 'Courier New'; } .section-head { color: blue; white-space: pre; font-family: 'Courier New'; } .info-head { white-space: pre; font-family: 'Courier New'; } </style>

Member Function Documentation

◆ clearSQLBenchMarkRslt()

_.Library.Status clearSQLBenchMarkRslt ( _.Library.String  ns,
_.Library.String  rtn,
_.Library.Integer  ph3,
_.Library.Integer  clearErrs,
_.Library.Integer  returnType,
_.Library.RawString  ptInfo 
)
static

<DEP> – DEPRECATED — DEPRECATED — DEPRECATED — DEPRECATED — DEPRECATED – </DEP>

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

Member Data Documentation

◆ FRGlobalRefs

FRGlobalRefs

Number of Global References to fetch the first row.

 

◆ FRLines

FRLines

Number of lines executed to fetch the first row.

 

◆ FRRunTime

FRRunTime

Time to fetch the first row.

 

◆ GlobalRefs

GlobalRefs

Number of Global References for all rows.

 

◆ Lines

Lines

Number of lines executed for all rows.

 

◆ QueryId

QueryId

 

 

◆ Rowcount

Rowcount

Number of rows returned by the query.

 

◆ Run

Run

 

 

◆ RunTime

RunTime

Time to fetch all rows.

 

◆ StartTS

StartTS