|
%SYS
|
|
|
%SYS
|
|
<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...
Public Attributes | |
| CursorName | |
| <PROP> More... | |
| Hash | |
| hash the SQL so we can match incoming SQL with already stored Stats [<BC>Maintained for Backward-Compatibility</BC>] More... | |
| ImportSchema | |
| ImportSchema is used in generated code to handle SQL statements that have. More... | |
| ModuleName | |
| <PROP> More... | |
| NameSpace | |
| The NameSpace in which the SQL query resides. More... | |
| Parameters | |
| List of Query Parameters. More... | |
| QueryCompileTime | |
| Number of Seconds it takes to compile the query. More... | |
| QueryText | |
| External SQL Statement as a single string. More... | |
| QueryType | |
| <PROP> More... | |
| RoutineName | |
| The name of the routine in which the SQL query resides. More... | |
| RoutineNameUCQCaller | |
| <PROP> More... | |
| SQLIndexHash | |
| <PROP> More... | |
| SQLStatsFlag | |
| <PROP> More... | |
| SQLTextRaw | |
| Raw SQL Statement Text stored as a $LIST string. More... | |
| StatsGroup | |
| <PROP> More... | |
| StatsMarker | |
| <PROP> More... | |
| TotalCommandsExecuted | |
| The total number of ObjectScript commands that were executed in this Module for the given query. More... | |
| TotalCounter | |
| The total number of times the query has been run since it's last compilation. More... | |
| TotalDiskWait | |
| The total number of Milliseconds spent waiting for Disk reads in this Module for the given query. More... | |
| TotalGlobalRefs | |
| The total number of global references done in this Module for the given query. More... | |
| TotalLinesOfCode | |
| TotalModuleCount | |
| The total number of times we entered this module for the run of the query. More... | |
| TotalRowCount | |
| The total number of rows returned in the MAIN Module for the given query. More... | |
| TotalTimeSpent | |
| The total time spent in this Module for the given query. More... | |
| TotalTimeToFirstRow | |
| The total time spent finding the first row in the MAIN Module for the given query. More... | |
| VarianceTimeSpent | |
| The variance of the time spent in this Module for the given query. More... | |
| creationDate | |
| Creation Date: $HOROLOG date format. More... | |
| creationTime | |
| Creation Time: $HOROLOG time format. More... | |
 Public Attributes inherited from Stats | |
| CommandsExecuted | |
| The number of ObjectScript commands that were executed in this Module for the given query. More... | |
| Counter | |
| This is the number of times the query has been run since the last compile. More... | |
| CursorName | |
| Placeholder (*) indicating that this is not a Cursor Name for an SQL Statement [Used in SYS.PTools.StatsSQL]. More... | |
| DiskWait | |
| Number of Milliseconds spent waiting for Disk reads in this Module for the given query. More... | |
| ExeName | |
| Name of the executable that ran this query. More... | |
| GlobalRefs | |
| The number globals that were referenced in this Module for the given query. More... | |
| IPAddress | |
| IP Address of the machine that ran this query. More... | |
| LinesOfCode | |
| MachineName | |
| Name of the machine that ran this query. More... | |
| ModuleCount | |
| Number of times we entered this module for the run of the query. More... | |
| ModuleName | |
| This is the name of the method within a given routine to be analyzed [DEFAULT: 1]. More... | |
| NameSpace | |
| The NameSpace in which the Stats collection is being invoked. More... | |
| Pid | |
| OS level Process ID. More... | |
| RoutineInfo | |
| <PROP> More... | |
| RoutineName | |
| The name of the routine in which the Stats collection is being invoked. More... | |
| RowCount | |
| How many rows did the query return for this run. More... | |
| StartTime | |
| TimeStamp of when the query was compiled/run. More... | |
| StatsGroup | |
| <PROP> More... | |
| StatsMarker | |
| <PROP> More... | |
| TimeSpent | |
| How much time was spent in this Module for the given query. More... | |
| TimeToFirstRow | |
| How much time was spent finding the first row. More... | |
| TotalTime | |
| <BC>Maintained for Backward-Compatibility</BC>. More... | |
| UserName | |
| InterSystems IRIS UserName of the person who ran this query. More... | |
| _.Library.String | Export (file, delim, _.Library.RawString conds, _.Library.RawString ptInfo) |
| _.Library.String | ExportAll (filePrefix, delim, exportPlan, silent, rtnName, modName, _.Library.RawString conds, _.Library.RawString ptInfo) |
| _.Library.String | ExportSQLQuery (file, delim, exportPlan, _.Library.RawString conds, _.Library.RawString ptInfo) |
| _.Library.Integer | GetLastSQLStats (dumpResults) |
| _.Library.Integer | GetSQLStatsFlag (_.Library.Integer flagType, _.Library.Integer returnActionFlag, _.Library.RawString ptInfo) |
| _.Library.Integer | GetSQLStatsFlagByPID (_.Library.String pid, _.Library.Integer returnActionFlag, _.Library.RawString ptInfo) |
| _.Library.Integer | GetSQLStatsSaveFlag (_.Library.Integer flagType) |
| _.Library.String | GetStats (_.Library.String SQLText, _.Library.String mod, _.Library.Integer showStats) |
| _.Library.String | ImportSchema (_.Library.String CN, _.Library.String Rtn, _.Library.Boolean Internal) |
| _.Library.Status | Purge (_.Library.String ns, _.Library.String rtn, _.Library.Integer ph3, _.Library.Integer clearAll, _.Library.Integer clearErrs, _.Library.Integer returnType, _.Library.RawString ptInfo) |
| _.Library.String | QueryText (_.Library.String CN, _.Library.String Rtn, _.Library.Boolean Internal) |
| _.Library.Integer | SetSQLStats (_.Library.Integer actionFlag, _.Library.Integer returnActionFlag, _.Library.String collectFlag, _.Library.String terminateCond, _.Library.RawString ptInfo) |
| _.Library.Integer | SetSQLStatsFlag (_.Library.Integer actionFlag, _.Library.Integer returnActionFlag, _.Library.String collectFlag, _.Library.String terminateCond, _.Library.RawString ptInfo) |
| _.Library.Integer | SetSQLStatsFlagByNS (_.Library.String ns, _.Library.Integer actionFlag, _.Library.Integer returnActionFlag, _.Library.String collectFlag, _.Library.String terminateCond, _.Library.RawString ptInfo) |
| _.Library.Integer | SetSQLStatsFlagByPID (_.Library.String pid, _.Library.Integer actionFlag, _.Library.Integer returnActionFlag, _.Library.String collectFlag, _.Library.String p5, _.Library.RawString ptInfo) |
| _.Library.Integer | SetSQLStatsFlagJob (_.Library.Integer actionFlag, _.Library.Integer returnActionFlag, _.Library.String collectFlag, _.Library.String p4, _.Library.RawString ptInfo) |
| _.Library.Integer | SetSQLStatsJob (_.Library.Integer actionFlag, _.Library.Integer returnActionFlag, _.Library.String collectFlag, _.Library.String p4, _.Library.RawString ptInfo) |
| _.Library.Integer | SetSQLStatsSaveFlag (_.Library.Integer typeFlag, _.Library.Integer methodFlag) |
| _.Library.Integer | SetSQLStatsSaveFlagJob (_.Library.Integer typeFlag, _.Library.Integer methodFlag) |
| TriggerOnDelete (timing, ns, rtn, curs, sgrp, mod, rtnUCQCaller) | |
| Perform the OnDelete Trigger operations for this class... | |
| _.Library.Status | aggregateSQLStats (ns, rtn, curs) |
| buildPPcost (_.Library.Float qoqn, _.Library.RawString dmt, _.Library.RawString dmts, _.Library.RawString dalg, _.Library.RawString PPcost, _.Library.Integer silent) | |
| changeCost (_.Library.Float PPcost, _.Library.Integer num, _.Library.Integer level, _.Library.RawString dmt, _.Library.RawString dmts, _.Library.RawString dalg, _.Library.Integer silent) | |
| _.Library.Status | clearStatsSQL (_.Library.String ns, _.Library.String rtn, _.Library.Integer ph3, _.Library.Integer clearAll, _.Library.Integer clearErrs, _.Library.Integer returnType, _.Library.RawString ptInfo) |
| _.Library.Status | clearStatsSQLAllNS (_.Library.String rtn, _.Library.Integer ph2, _.Library.String ph3, _.Library.Integer clearAll, _.Library.Integer clearErrs, _.Library.Integer returnType, _.Library.RawString ptInfo) |
| _.Library.Status | exportStatsSQL (file, format, silent, statsType, exportPlan, rtnName, modName, _.Library.RawString conds, _.Library.RawString ptInfo, contRowCnt, bcFlag) |
| _.Library.String | getImportSchema (_.Library.String ns, _.Library.String rtn, _.Library.String curs) |
| _.Library.String | getQueryText (_.Library.String ns, _.Library.String rtn, _.Library.String curs, _.Library.Boolean getInt) |
| map (_.Library.String data, _.Library.RawString mt, _.Library.RawString mts, _.Library.RawString alg, _.Library.Integer qnum, _.Library.Integer str, _.Library.Integer silent) | |
| newSQLStats (SQLText, SQLType, ns, rtn, curs, compTime, SQLIndexHash, ucqInfo) | |
| possiblePlans (_.Library.RawString sql, _.Library.Integer PPcost, _.Library.Integer num, _.Library.Integer level, _.Library.Integer arr, _.Library.Integer showStats, _.Library.String schemaImport, _.Library.String schemaPath, _.Library.Integer preparse, _.Library.String hash, _.Library.Integer silent) | |
| _.Library.Status | possiblePlansClose (_.Library.Binary qHandle) |
| _.Library.Status | possiblePlansExecute (_.Library.Binary qHandle, _.Library.String sql) |
| _.Library.Status | possiblePlansFetch (_.Library.Binary qHandle, _.Library.List Row, _.Library.Integer AtEnd) |
| _.Library.Status | possiblePlansStatsClose (_.Library.Binary qHandle) |
| _.Library.Status | possiblePlansStatsExecute (_.Library.Binary qHandle, _.Library.String sql, _.Library.String ids) |
| _.Library.Status | possiblePlansStatsFetch (_.Library.Binary qHandle, _.Library.List Row, _.Library.Integer AtEnd) |
| saveSQLStats (ns, rtn, curs, mod, rowCount, SQLIndexHash) | |
| startSQLStats (ns, rtn, curs, params, SQLIndexHash, flag, collect) | |
| stopSQLStats (ns, rtn, curs, rowCount, SQLIndexHash, flag, collect) | |
| _.Library.Integer | useAggregatedData (ns, rtn, curs) |
| If Aggregated Data can be used for the given 'ns', 'rtn', and 'curs', then. More... | |
| _.Library.String | version () |
| Provide the current version for the SYS.PTools.StatsSQL class/section of the Performance Tools (PTools) Application. | |
| def | __init__ (self) |
| *** DEPRECATED via MRP1300 as of 05/30/2022 *** More... | |
<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>
Class: SYS.PTools.StatsSQL Replaces: <class>SYS.PTools.SQLStats</class> <DEP>[DEPRECATED]</DEP> Purpose:
This class contains the Optimal (new) Performance Tools for collecting statistics on SQL Queries. Since this class extends <class>SYS.PTools.Stats</class>, it uses the properties from this class and its extent class to record these individual performance statistics details for each execution of a SQL Query, since its last compilation.
To collect statistical data on SQL Query executions for the entire System, you can invoke different levels of statistics collecting via several different methods described in the next section.
One of these methods, <method>SetSQLStats</method> for example, creates the 'SQLStats-flag' which controls whether or not SQL Statistics are collected for each SQL Query execution by anybody on the system, and which performance statistics details are to be collected.
The SQLStats-flag is a colon (:) delimited string comprised of the following individual components:
SQLStats-flag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
The {action-flag} portion of the SQLStats-flag is represented by the 1st colon (:) piece, and can have one of the following values:
System Setting 0 - Query Compilation: Don't generator SQLStats collection code for any Query Modules Query Execution: Don't collect SQLStats for any Query Modules 1 - Query Compilation: Generator SQLStats collection code for MAIN
Query Module (Start & Stop) Query Execution: Don't collect SQLStats for any Query Modules 2 - Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Collect SQLStats for MAIN Query Module (Start & Stop) 3 - Query Compilation: Generator SQLStats collection code for ALL Query Modules Query Execution: Collect SQLStats for ALL Query Modules
Process/Job Setting -1 - Query Compilation: Turn SQLStats Off for this Process/Job Query Execution: Turn SQLStats Off for this Process/Job 0 - Query Compilation: Use the {action-flag} (System) setting Query Execution: Use the {action-flag} (System) setting
The {collect-flag} portion of the SQLStats-flag is represented by the 2nd colon (:) piece, and is a numeric value representing which SQL Performance Statistics/Metrics to collect, as specified below:
{collect-flag} = SUM(MVal)
In general, all of the following performance metrics are collected for each SQL module, along with a cumulative value representing all SQL modules, when the SQLStats-flag is turned on:
MVal Metric Name Metric Description
1 Query Execution Time Total number of seconds elapsed 2 Total Global References Total number of global references 4 Total Commands Executed Total number of OS commands executed 8 Total Disk Read Latency Time Total milliseconds spent waiting ==== for Disk Reads 15 ALL Collect all Performance Metrics
This flag provides a mechanism by which to choose a combination of which performance metrics to collect, by specifying a SUM of the performance metrics MVal numbers (specified above) that you wish to collect.
EXAMPLE #1: The following example represents the collection of 2 performance metrics, 'Query Execution Time' & 'Total Disk Read Latency Time':
MVal Metric Name
1 Query Execution Time
9 Collect both of these performance metrics
By passing 9 for the value of the {collect-flag}, the sum of the aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked.
EXAMPLE #2: The following example represents the collection of 3 performance metrics, 'Query Execution Time', 'Total Global References' & 'Total Commands Executed':
MVal Metric Name
1 Query Execution Time 2 Total Global References
7 Collect both of these performance metrics
By passing 9 for the value of the {collect-flag}, the sum of the aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these three performance metrics whenever an SQL Query is invoked.
The {condition-flag} portion of the SQLStats-flag is represented by the 3rd colon (:) piece, and can have one of the following values:
0 - No addition conditions, other than the ones specified by the following two flags: {action-flag} & {collect-flag} [DEFAULT] 1 - Namespace-Condition specified by the 'SetSQLStatsFlagByNS()' method
The {condition-value} portion of the SQLStats-flag is represented by the 4th colon (:) piece, and can have one of the following values:
The {condition-value} is based on the {condition-flag} and represents the way in which to further conditionalize/constrain whether SQLStats, by way of the SQLStats-flag, can collect statistical information for SQL Query executions within a given IRIS environment. For example, if the {condition-flag} is set to the value one (1), which is the Namespace-Condition, then the {condition-value} would be set to a Namespace in which SQLStats is authorized to collect statistical information about SQL Queries. (e.g. "USER")
The {terminate-flag} portion of the SQLStats-flag is represented by the 5th colon (:) piece, and can have one of the following values:
0 - No Action n - A termination flag, represented by the number of minutes from the starting $HOROLOG date, to determine when to terminate the SQLStats collection, by turning off the SQLStats-flag (System), or by setting it to a specified reset value.
The {flag-type} portion of the SQLStats-flag is represented by the 6th colon (:) piece, and can have one of the following values:
"" - Indeterminate (Older version of PTools/SQLStats) 0 - System Flag 1 - Process/Job Flag
You can invoke different levels of SQL Statistics collection by setting the SQLStats-flags, either for the entire System, for your current Process/Job, or for a specified Namespace.
To collect SQL Statistics for the entire System, invoke the following method:
Object Script: ##class(SYS.PTools.StatsSQL).SetSQLStats(...) $SYSTEM.SQL.SetSQLStats(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStats(...)
(...): (actionFlag[,returnActionFlag,collectFlag,terminateCond,ptInfo])
To collect SQL Statistics for the current Process/Job, invoke the following method:
Object Script: ##class(SYS.PTools.StatsSQL).SetSQLStats[Flag]Job(...) $SYSTEM.SQL.SetSQLStats[Flag]Job(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStats[Flag]Job(...)
(...): (actionFlag[,returnActionFlag,collectFlag,p4,ptInfo])
To collect SQL Statistics for a specific Process/Job, invoke the following method:
Object Script: ##class(SYS.PTools.StatsSQL).SetSQLStatsFlagByPID(...) $SYSTEM.SQL.SetSQLStatsFlagByPID(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStatsFlagByPID(...)
(...): (pid,actionFlag[,returnActionFlag,collectFlag,p5,ptInfo])
RESTRICTION: This method invocation requires Admin_Operate:Use privilege
To collect SQL Statistics within a specific Namespace, invoke the following method:
Object Script: ##class(SYS.PTools.StatsSQL).SetSQLStatsFlagByNS(...) $SYSTEM.SQL.SetSQLStatsFlagByNS(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStatsFlagByNS(...)
(...): (ns,actionFlag[,returnActionFlag,collectFlag,terminateCond,ptInfo])
Returns All of the aforementioned methods return the value of the SQLStats-flag before setting it to the new value; Otherwise, return an error message if an error occurred
SQLStats-flag RULES Whether to use the SQLStats-flag (System) or the SQLStats-flag (Process/Job) is determined by the following rules: IF {action-flag} (Process/Job) = 0, then use SQLStats-flag (System) ELSE use SQLStats-flag (Process/Job) NOTE: The 'GetSQLStatsFlag(flagType,...)' method has the following additional rule when passed the parameter: flagType="" RULE-G1: If {action-flag}=-1, then return zero (0) for each component-flag of the SQLStats-flag, except for the {flag-type} which is one (1) [indicating a Process/Job Flag setting], as in the following example: write $SYSTEM.SQL.GetSQLStatsFlag("") => "0:0:0::0:1"
To retrieve the actual value for each component-flag of the SQLStats-flag in this example, pass a one (1) for the 'flagType' parameter: write $SYSTEM.SQL.GetSQLStatsFlag(1) => "-1:0:0::0:1"
When the SQLStats-flag is on, statistical data will be collected in the 'SYS.PTools.StatsSQL' class, which can be interrogated during the analysis phase to determine a way to achieve optimal query performance. The following simple SQL Query displays all of the properties within the 'SYS.PTools.StatsSQL' class:
SELECT * FROM SYS_PTools.StatsSQL ORDER BY Namespace, RoutineName, CursorName, StatsGroup
The following properties are important for statistical analysis and are aggregated for a given SQL Query in the row WHERE ModuleName = 'INFO':
These properties are initialized to zero (0) for the 'INFO' row and are only set to their proper value via the invocation of the 'aggregateSQLStats()' method. Therefore, in order to directly use the data in these properties, the following method must first be invoked:
Object Script: set status=##class(SYS.PTools.StatsSQL).aggregateSQLStats(NameSpace, RoutineName, CursorName) SQL: SELECT SYS_PTools.PT_aggregateSQLStats(NameSpace, RoutineName, CursorName)
NOTE: To aggregate the SQL Statistics for all queries within a 'RoutineName', omit passing the 'CursorName' to the 'aggregateSQLStats' method.
The Mean/Average and Variance for the property {TimeSpent}, {GlobalRefs}, {CommandsExecuted}, and {DiskWait} can be obtained via the following computations:
{Mean-expr} = SUM({expr}) / {Counter}
{Variance-expr} = (1 / {Counter)) * SUM(({expr} - {Mean-expr})**2)
Where 'expr' is one of either: TimeSpent, GlobalRefs, CommandsExecuted, or DiskWait
NOTE: The 'TotalTime' property is maintained for backward-compatibility and should not be use in this context. Use the 'TimeSpent' property for the proper value, and the 'TotalTimeSpent' for the 'INFO' row.
All of the data that is stored in this class can be accessed in a number of predefined ways:
SELECT * FROM %SYS_PTools.StatsSQL#2: Aggregated Class View Query
SELECT * FROM %SYS_PTools.StatsSQLView#3: General Result-Set Query
SELECT * FROM %SYS_PTools.StatsSQL_ViewStatsSQL([namespace])#4: Specific Result-Set Query
SELECT * FROM %SYS_PTools.StatsSQL_ViewStatsSQLDetails(cursor,rtn)NOTE: All of these examples use the properties that are aggregated by the 'aggregateSQLStats()' method. Only example #1 requires this method to be invoked for the 'Total*' properties to have usable data. The other three examples would benefit by the invocation of this method, but will generate the totals on the fly if this method has not been adequately run.
It's important to note that whenever you collect statistical data for SQL Query executions via this tool, each collection which performs the last row INSERT into the <class>SYS.PTools.StatsSQL</class> class will populate the following array reference with the corresponding definition:
SQLStats("LastRow") = "||" Pieces: (ROWID of the last row INSERTed) 1) SQLStats Marker (statsSQLMarker) 2) Namespace (ns) 3) Routine (rtn) 4) Cursor (curs) 5) SQLStats Group (statsGroup)
The information contained within this array reference can be used to see the SQLStats Result Set from the last invoked SQL Statement, by invoking one of the following methods:
set tSC=##class(SYS.PTools.StatsSQL).GetLastSQLStats() do sqlcontext.DumpResults() OR set tSC=##class(SYS.PTools.StatsSQL).GetLastSQLStats(1) // Automatically invokes DumpResults()
NOTE: For additional details about the <method>GetLastSQLStats</method> method, please refer to the actual methods documentation contain herein
The PTools/SQLStats data is collected in the following globals:
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S}") Error Storage: ^sqlcq($NAMESPACE,"PTools","Error"[...])=$LIST Info
| def __init__ | ( | self | ) |
*** DEPRECATED via MRP1300 as of 05/30/2022 ***
The 'TotalLinesOfCode' property has been deprecated and replaced by the 'TotalCommandsExecuted' property, but is left here for backwards compatibility and returns the 'TotalCommandsExecuted' value. At some point in the future this property will be removed from the product, so users should not rely on its availability going forward and should use the 'TotalCommandsExecuted' property instead.
Reimplemented from Stats.
|
static |
Method: Export [SQL: StatsSQL_Export] Replaces: Export SQL: SQLStats_Export <DEP>[DEPRECATED]</DEP> Status: <BC>Maintained for Backward-Compatibility.</BC> See exportStatsSQL(...) Purpose: This method generates a comma delimited file containing the data from the 'SYS.PTools.StatsSQL' class
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).Export(...) SQL: CALL SYS_PTools.StatsSQL_Export(...) SELECT SYS_PTools.StatsSQL_Export(...)
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 Display this export file to the screen via a InterSystems IRIS Terminal:
set io=##class(%SYS.PTools.StatsSQL).Export($IO)
#2 Display this export file via the SQL Query Page of the Management Portal:
CALL SYS_PTools.StatsSQL_Export('$IO')
Where: '$IO' = Output to the current device NOTE: '$IO' can be omitted, as it is the default 'file' when invoked via the CALL interface
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: file - The path and file in which to create and store the data from the SYS.PTools.SQLStats class: (e.g. C:\exportFile.txt) NOTE: $IO = Outputs the data to the screen '$IO' = Output the data to the current device when invoked from the CALL/SELECT-interface '$DEF' = Ouput the data to the DEFAULT file when invoked from the CALL/SELECT-interface [DEFAULT: {MGR-Directory}computerName}_{ConfigName}_YYYYMMDD_HHMMSS_StatsSQL.psql] delim - The delimiter by which to delimit the data of the exported file [DEFAULT: $C(9) // TAB] conds - A string/array of possible conditions by which to restrict the output of the Export file, in the following format:
conds=<full condition> OR conds(0)=pos Count (WHERE pos = {1...n}) conds(pos)=$LIST() Pieces: 1) [<logical operator>] (Assumed Default: &&) 2) [{Heading}] (Omit for override cond) 3) <simple condition> | <complex condition>
WHERE: <full condition> := <full condition expression> <logical operator> := {&& | ||} (&& = AND | || = OR) <simple condition>@* := <oper>
<complex condition>@ := <complex condition expression>
@ = Contains no references to {Heading}
EXAMPLE: <full condition> conds="("",INFO,MAIN,""[("",""_{Module}_"",""))||({GlobalRefs}>20)" <simple condition> conds(0)=3 conds(1)=$LB(,"Module","=""INFO""") conds(2)=$LB("||","Module","=""MAIN""") conds(3)=$LB("||","GlobalRefs",">20") <complex condition> conds(0)=2 conds(1)=$LB(,"Module",""",INFO,MAIN,""[("",""_{*}_"","")") conds(2)=$LB("||","GlobalRefs","{*}>20") WHERE: {*} = value substitution for the 'Module' & 'GlobalRefs' fields NOTE: Conditions that don't contain any references to {Heading} fields, often called <override condition>s, can be included as <complex condition>s, as in the following example: conds(pos)=$LB(,,"$g(^zAction(""runIt""))=1")
NOTE: All conditions must be satisfied for the conds() to be considered true and for the row to be exported [PASS BY REFERENCE] ptInfo - A Pass By Reference information array that returns to the user the following details: ptInfo(variable)=value ptInfo("outputFile")=The canonical name of the Export/Reporting file
RETURN Value: The output locations of the exported data; Otherwise, return
the error status if one occurred
|
static |
Method: ExportAll [SQL: StatsSQL_ExportAll] Replaces: ExportAll SQL: SQLStats_ExportAll <DEP>[DEPRECATED]</DEP> Status: <BC>Maintained for Backward-Compatibility.</BC> See exportStatsSQL(...) Purpose: This method generates two Performance Tool files containing the data from the 'SYS.PTools.StatsSQL' class and return a $LIST of the output locations
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).ExportAll(...) SQL: CALL SYS_PTools.StatsSQL_ExportAll(...) SELECT SYS_PTools.StatsSQL_ExportAll(...)
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 Display this export file to the screen via a InterSystems IRIS Terminal:
set io=##class(%SYS.PTools.StatsSQL).ExportAll($IO)
#2 Display this export file via the SQL Query Page of the Management Portal:
CALL SYS_PTools.StatsSQL_ExportAll('$IO')
Where: '$IO' = Output to the current device NOTE: '$IO' can be omitted, as it is the default 'file' when invoked via the CALL interface
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: filePrefix - The path in which to create and store the data from the 'SYS.PTools.StatsSQL' class (e.g. C:) NOTE: $IO = Outputs the data to the screen '$IO' = Output the data to the current device when invoked from the CALL/SELECT-interface '$DEF' = Ouput the data to the DEFAULT file when invoked from the CALL/SELECT-interface [DEFAULT: {Current-Directory}\SQLQuery.{ext} & {Current-Directory}\StatsSQL.{ext}] WHERE {Current-Directory} = The directory of the Namespace in which this method is invoked (e.g. $ZU(12,"")) delim - The delimiter by which to delimit the data of the exported file [DEFAULT: $C(9) // TAB] exportPlan - 0 - Export the SQL Query Text 1 - Export the SQL Query Plan [DEFAULT: 0] silent - 0 - Display all messages during the running of this method 1 - Don't display any messages during the running of this method rtnName - If specified, return only the rows where the 'RoutineName' matches the value of this parameter; Otherwise, return rows for all 'RoutineName' values modName - If specified, return only the rows where the 'ModuleName' matches the value of this parameter; Otherwise, return rows for all 'ModuleName' values conds - A string/array of possible conditions by which to restrict the output of the Export file, in the following format:
conds=<full condition> OR conds(0)=pos Count (WHERE pos = {1...n}) conds(pos)=$LIST() Pieces: 1) [<logical operator>] (Assumed Default: &&) 2) [{Heading}] (Omit for override cond) 3) <simple condition> | <complex condition>
WHERE: <full condition> := <full condition expression> <logical operator> := {&& | ||} (&& = AND | || = OR) <simple condition>@* := <oper>
<complex condition>@ := <complex condition expression>
@ = Contains no references to {Heading}
EXAMPLE: <full condition> conds="("",INFO,MAIN,""[("",""_{Module}_"",""))||({GlobalRefs}>20)" <simple condition> conds(0)=3 conds(1)=$LB(,"Module","=""INFO""") conds(2)=$LB("||","Module","=""MAIN""") conds(3)=$LB("||","GlobalRefs",">20") <complex condition> conds(0)=2 conds(1)=$LB(,"Module",""",INFO,MAIN,""[("",""_{*}_"","")") conds(2)=$LB("||","GlobalRefs","{*}>20") WHERE: {*} = value substitution for the 'Module' & 'GlobalRefs' fields NOTE: Conditions that don't contain any references to {Heading} fields, often called <override condition>s, can be included as <complex condition>s, as in the following example: conds(pos)=$LB(,,"$g(^zAction(""runIt""))=1")
NOTE: All conditions must be satisfied for the conds() to be considered true and for the row to be exported [PASS BY REFERENCE] ptInfo - A Pass By Reference information array that returns to the user the following details: ptInfo(method,statsType,variable)=value ptInfo(method,statsType,"outputFile")=The canonical name of the Export/Reporting file
RETURN Value: A $LIST of the output locations of the exported data; Otherwise, return the error status if one occurred $LB(filePrefix_"StatsSQL_Qry.txt",filePrefix_"StatsSQL_Stats.txt")
|
static |
Method: ExportSQLQuery [SQL: StatsSQL_ExportSQLQuery] Replaces: Export SQL: SQLQuery_Export <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: This method generates a comma delimited file containing the SQL Query data from the 'SYS.PTools.StatsSQL' class
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).ExportSQLQuery(...) SQL: CALL SYS_PTools.StatsSQL_ExportSQLQuery(...) SELECT SYS_PTools.StatsSQL_ExportSQLQuery(...)
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 Display this export file to the screen via a InterSystems IRIS Terminal:
set io=##class(%SYS.PTools.StatsSQL).ExportSQLQuery($IO)
#2 Display this export file via the SQL Query Page of the Management Portal:
CALL SYS_PTools.StatsSQL_ExportSQLQuery('$IO')
Where: '$IO' = Output to the current device NOTE: '$IO' can be omitted, as it is the default 'file' when invoked via the CALL interface
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: file - The path and file in which to create and store the data from the SYS.PTools.SQLStats class: (e.g. C:\exportFile.txt) NOTE: $IO = Outputs the data to the screen '$IO' = Output the data to the current device when invoked from the CALL/SELECT-interface '$DEF' = Ouput the data to the DEFAULT file when invoked from the CALL/SELECT-interface [DEFAULT: {MGR-Directory}computerName}_{ConfigName}_YYYYMMDD_HHMMSS_ExportSQLQuery.psql] delim - The delimiter by which to delimit the data of the exported file [DEFAULT: $C(9) // TAB] exportPlan - 0 - Export the SQL Query Text [DEFAULT] 1 - Export the SQL Query Plan conds - A string/array of possible conditions by which to restrict the output of the Export file, in the following format:
conds=<full condition> OR conds(0)=pos Count (WHERE pos = {1...n}) conds(pos)=$LIST() Pieces: 1) [<logical operator>] (Assumed Default: &&) 2) [{Heading}] (Omit for override cond) 3) <simple condition> | <complex condition>
WHERE: <full condition> := <full condition expression> <logical operator> := {&& | ||} (&& = AND | || = OR) <simple condition>@* := <oper>
<complex condition>@ := <complex condition expression>
@ = Contains no references to {Heading}
EXAMPLE: <full condition> conds="("",INFO,MAIN,""[("",""_{Module}_"",""))||({GlobalRefs}>20)" <simple condition> conds(0)=3 conds(1)=$LB(,"Module","=""INFO""") conds(2)=$LB("||","Module","=""MAIN""") conds(3)=$LB("||","GlobalRefs",">20") <complex condition> conds(0)=2 conds(1)=$LB(,"Module",""",INFO,MAIN,""[("",""_{*}_"","")") conds(2)=$LB("||","GlobalRefs","{*}>20") WHERE: {*} = value substitution for the 'Module' & 'GlobalRefs' fields NOTE: Conditions that don't contain any references to {Heading} fields, often called <override condition>s, can be included as <complex condition>s, as in the following example: conds(pos)=$LB(,,"$g(^zAction(""runIt""))=1")
NOTE: All conditions must be satisfied for the conds() to be considered true and for the row to be exported [PASS BY REFERENCE] ptInfo - A Pass By Reference information array that returns to the user the following details: ptInfo(variable)=value ptInfo("outputFile")=The canonical name of the Export/Reporting file
RETURN Value: The output locations of the exported data; Otherwise, return
the error status if one occurred
|
static |
Method: GetLastSQLStats [SQL: StatsSQL_GetLastSQLStats] Replaces: GetLastSQLStats SQL: SQLStats_GetLastSQLStats <DEP>[DEPRECATED]</DEP> Status: <BC>Maintained for Backward-Compatibility</BC> Purpose: This method return the SQLStats Result Set from the last invoked SQL Statement
NOTE: This method makes use of a local variable 'sqlcontext' that gets set when the stats data is saved. This only works if you are running in the same process.
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).GetLastSQLStats(...) SQL: CALL SYS_PTools.StatsSQL_GetLastSQLStats(...) SELECT SYS_PTools.StatsSQL_GetLastSQLStats(...)
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 To see the SQLStats Result Set from the last invoked SQL Statement, invoke one of the following methods:
// First invoke a query with SQLStats turned on, such that the following // array value gets set: SQLStats("LastRow") set tSC=##class(SYS.PTools.StatsSQL).GetLastSQLStats() do sqlcontext.DumpResults() OR set tSC=##class(SYS.PTools.StatsSQL).GetLastSQLStats(1) // Automatically invokes DumpResults() OR set tSC=##class(SQL.Statement).ExecDirect(,"CALL %SYS_PTools.GetLastSQLStats(1)")
sqlcontext: The variable containing the instantiated object of the class Library.SQLProcContext when a stored procedure is called. sqlcontext consists of several properties, including an Error object, the SQLCODE error status, the SQL row count, and an error message. This variable is reset before each execution.
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: dumpResults - 1 = Automatically invoke the 'DumpResults()' if 'sqlcontext' is set to a valid value
RETURN Value: The status of this method's execution
|
static |
Method: GetSQLStatsFlag [SQL: StatsSQL_GetSQLStatsFlag] Replaces: N/A Status: New Functionality Purpose: This method gets the flag that controls whether or not we collect SQL Statistics for each SQL Query execution
Get the current value of the SQLStats-flag for the given 'flagType'.
The SQLStats-flag (System/Job) controls whether or not SQL Statistics are collected for each SQL Query execution, and which performance statistics to be collected.
The SQLStats-flag is a colon (:) delimited string comprised of the following individual components:
SQLStats-flag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
RULES: When (flagType=""), whether to use the SQLStats-flag (System) or the SQLStats-flag (Process/Job) is determined by the following rules: IF {action-flag} (Process/Job) = 0, then use SQLStats-flag (System) ELSE use SQLStats-flag (Process/Job) NOTE: This method has the following additional rule when passed the parameter: flagType="" RULE-G1: If {action-flag}=-1, then return zero (0) for each component-flag of the SQLStats-flag, except for the {flag-type} which is one (1) [indicating a Process/Job Flag setting], as in the following example: write $SYSTEM.SQL.GetSQLStatsFlag("") => "0:0:0::0:1"
To retrieve the actual value for each component-flag of the SQLStats-flag in this example, pass a one (1) for the 'flagType' parameter: write $SYSTEM.SQL.GetSQLStatsFlag(1) => "-1:0:0::0:1"
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).GetSQLStatsFlag(...) $SYSTEM.SQL.GetSQLStatsFlag(...) SQL: SELECT SYS_PTools.StatsSQL_GetSQLStatsFlag(...)
Examples: The following examples shows the use of this method:
#1 Get the current value of the SQLStats-flag for the Job/System Flag based on SQLStats-flag Rules:
set SQLStatsFlag=##class(SYS.PTools.StatsSQL).GetSQLStatsFlag("")
Data Storage: ^SYS("sql","sys","SQLStats")
Parameters: flagType - "" = Job/System Flag based on SQLStats-flag Rules [DEFAULT] 0 = System Flag 1 = Process/Job Flag returnActionFlag - 0 = Return the entire SQLStats-flag value [DEFAULT] 1 = Return only the {action-flag} value, which is the portion of the SQLStats-flag represented by the 1st colon (:) piece NOTE: This is the backward-compatible value ptInfo - A Pass By Reference information array that returns to the user detailed information in the following format: ptInfo(category,variable)=value Where category = { "current" | "terminate" | ["expired"] | ... } variable = A variable that corresponds to the given 'category'
Example: ptInfo("current","SQLStatsFlag")=The SQLStats-flag value after method execution
RETURN Value: The current value of the SQLStats-flag; Otherwise, return an error message if an error occurred
|
static |
Method: GetSQLStatsFlagByPID [SQL: StatsSQL_GetSQLStatsFlagByPID] Replaces: N/A Status: New Functionality Purpose: This method gets the flag that controls whether or not we collect SQL Statistics about each SQL Query execution for the given 'pid'
Get the current value of the SQLStats-flag for the given 'pid'.
The SQLStats-flag (Process/Job) controls whether or not SQL Statistics are collected for each SQL Query execution, and which performance statistics to be collected.
The SQLStats-flag is a colon (:) delimited string comprised of the following individual components:
SQLStats-flag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
NOTE: This method ONLY applies to the SQLStats-flag for the given 'pid' (Process/Job) and NOT the SQLStats-flag for the (System)!
RESTRICTION: This method invocation requires Admin_Operate:Use privilege
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).GetSQLStatsFlagByPID(...) $SYSTEM.SQL.GetSQLStatsFlagByPID(...) SQL: SELECT SYS_PTools.StatsSQL_GetSQLStatsFlagByPID(...)
Examples: The following examples shows the use of this method:
#1 Get the current value of the SQLStats-flag for the Job/System Flag based on SQLStats-flag Rules for PID# 12345:
set SQLStatsFlag=##class(SYS.PTools.StatsSQL).GetSQLStatsFlagByPID(12345)
Data Storage: ^SYS("sql","sys","SQLStats")
Parameters: pid - The process ID ($JOB) for which to set the SQLStats-flag [DEFAULT: Current $JOB] returnActionFlag - 0 = Return the entire SQLStats-flag value [DEFAULT] 1 = Return only the {action-flag} value, which is the portion of the SQLStats-flag represented by the 1st colon (:) piece NOTE: This is the backward-compatible value ptInfo - A Pass By Reference information array that returns to the user detailed information in the following format: ptInfo(category,variable)=value
NOTE: This method currently returns no 'ptInfo', but is included for future extensibility
RETURN Value: The current value of the SQLStats-flag; Otherwise, return an error message if an error occurred
|
static |
Method: GetSQLStatsSaveFlag [SQL: StatsSQL_GetSQLStatsSaveFlag] Replaces: N/A Status: New Functionality Purpose: This methods gets the flag that controls what type of SQL Statistics to collect about each run of a query
Get the current value of the SQLStatsSave-flag for the given 'flagType'.
The SQLStatsSave-flag (System/Job) controls what type of SQL Statistics are saved, either Original (backward-compatible) or Optimal (new).
The SQLStatsSave-flag is a colon (:) delimited string comprised of the following individual flags: {type-flag} & {method-flag}
RULES: When (flagType=""), whether to use the SQLStatsSave-flag (System) or the SQLStatsSave-flag (Job) is determined by the following rules: IF {type-flag} (JOB) = 0, then use SQLStatsSave-flag (System) ELSE use SQLStatsSave-flag (Job)
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).GetSQLStatsSaveFlag(...) $SYSTEM.SQL.GetSQLStatsSaveFlag(...) SQL: SELECT SYS_PTools.StatsSQL_GetSQLStatsSaveFlag(...)
Examples: The following examples shows the use of this method:
#1 Get the current SQLStatsSave-flag value based on the aforementioned 'flagType' Rules:
set SQLStatsSaveFlag=##class(SYS.PTools.StatsSQL).GetSQLStatsSaveFlag()
Data Storage: ^SYS("sql","sys","SQLStatsSave")
Parameters: flagType - "" = Job/System Flag based on SQLStatsSave-flag Rules [DEFAULT] 0 = System Flag 1 = Job Flag
RETURN Value: The current value of the SQLStatsSave-flag; Otherwise, return an error message if an error occurred
|
static |
Method: GetStats [SQL: N/A] Replaces: GetStats (<class>SYS.PTools.SQLStats</class>) <DEP>[DEPRECATED]</DEP> Status: <BC>Maintained for Backward-Compatibility</BC> Purpose: Returns the Stats for a given module of a given SQL statement Invoked by the Show Plan code when Stats are to be included
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).GetStats(...) SQL: N/A
Examples: The following examples shows the use of this method:
#1 Get the stats for the 'MAIN' module of the following SQL Statement from the 'SAMPLES' namespace:
zn "SAMPLES" kill sql set sql($i(sql))="SELECT ID, Name FROM Sample.Person" set statsList=##class(SYS.PTools.StatsSQL).GetStats(.sql,"MAIN",1)
for pos=1:1:$LL(statsList) write !?3,$LTS($LG(statsList,pos)) ModuleName,Module,MAIN TimeSpent,Time,0.00999 GlobalRefs,Globals,1,201 CommandsExecuted,Commands,41,311 DiskWait,Disk Wait,1 RowCount,Row Count,400 ModuleCount,Mod Execs,1 Counter,Run Count,1
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: SQLText - An array of the SQL Statement in the following format: SQLText={ln# counter} SQLText({ln#})={SQL Statement} mod - SQL Module being processed showStats - 0 = Don't show any stats with the query plan 1 = Execute a query and get/show stats with the query plan [FROM: Query Test or ShowPlan^apiSQL] 2 = Retrieve existing stats and show the averages with the query plan [NOTE: Query Info from ^mqh($UserName,"id") set in
[FROM: SQL Runtime Statistics->{View Stats}->Show Plan] 3 = Generate and show stats for an alternate Show Plan with the query plan
RETURN Value: Query Stats as a $LIST with the following format: 1) $LIST({Property},{Header},{Value}) ... n) $LIST({Property},{Header},{Value})
|
static |
Method: ImportSchema [SQL: N/A] Replaced By: getImportSchema (<class>SYS.PTools.StatsSQL</class>) Status: <BC>Maintained for Backward-Compatibility</BC> Purpose: This method retrieves the Import Schema given the parameters: 'CN', 'Rtn', & 'Internal'
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).ImportSchema(...) SQL: N/A
Examples: The following examples shows the use of this method:
#1 Retrieve the SQL Text for any of the data rows retrieved from invoking the 'exportStatsSQL()' method:
CALL SYS_PTools.PT_exportStatsSQL() set iSchema=##class(SYS.PTools.StatsSQL).ImportSchema("SQLStats0","PToolsSQLStats"_$JOB)
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: CN - The cursor name from which to retrieve the Import Schema Rtn - The routine from which to retrieve the Import Schema Internal - 0 = Return the External Query Text [DEFAULT] 1 = Return the Internal Query Text
Return: Return either the Internal or External Import Schema; Otherwise, return the Error Status if an error occurs.
|
static |
Method: Purge [SQL: StatsSQL_Purge] Replaced BY: clearStatsSQL SQL: PT_clearStatsSQL Status: <BC>Maintained for Backward-Compatibility</BC> Purpose: This method deletes all of the data stored in the 'SYS.PTools.StatsSQL' class, based on the specified parameters: 'ns' & 'rtn'
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).Purge(...) SQL: CALL SYS_PTools.StatsSQL_Purge(...) SELECT SYS_PTools.StatsSQL_Purge(...)
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.StatsSQL' class in the 'SAMPLES' namespace:
set stats=##class(SYS.PTools.StatsSQL).Purge("SAMPLES")
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
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.StatsSQL [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","clearStatsSQL")=The number of rows deleted via this method [Routine Method] ptInfo("cnt","Purge")=The number of rows deleted via this method [Class Method]
RETURN Value: Return a Status code of either $$$OK or $$$ERROR()
|
static |
Method: QueryText [SQL: N/A] Replaced By: getQueryText (<class>SYS.PTools.StatsSQL</class>) Status: <BC>Maintained for Backward-Compatibility</BC> Purpose: This method retrieves the SQL Query Text given the parameters: 'CN', 'Rtn', & 'Internal'
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).QueryText(...) SQL: N/A
Examples: The following examples shows the use of this method:
#1 Retrieve the SQL Text for any of the data rows retrieved from invoking the 'exportStatsSQL()' method:
CALL SYS_PTools.PT_exportStatsSQL() set sql=##class(SYS.PTools.StatsSQL).QueryText("SQLStats0","PToolsSQLStats"_$JOB)
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: CN - The cursor name from which to retrieve the SQL Query Text Rtn - The routine from which to retrieve the SQL Query Text Internal - 0 = Return the External Query Text [DEFAULT] 1 = Return the Internal Query Text
Return: Return either the Internal or External SQL Query Text; Otherwise, return the Error Status if an error occurs.
|
static |
Method: SetSQLStats [SQL: StatsSQL_SetSQLStats] Replaces: N/A Status: New Functionality Purpose: This method sets the flag that controls whether or not the System collects SQL Statistics about each run of a query
You can invoke different levels of SQL Statistics collection by setting the SQLStats-flag, for the System with this method.
The SQLStats-flag controls whether or not SQL Statistics are collected for each SQL Query execution, and which performance statistics to collect.
The SQLStats-flag is a colon (:) delimited string comprised of the following individual components:
SQLStats-flag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).SetSQLStats(...) $SYSTEM.SQL.SetSQLStats(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStats(...)
Examples: The following examples shows the use of this method:
#1 Turn PTools ON to collects stats for all SQL modules (System):
set oldStats=##class(%SYS.PTools.StatsSQL).SetSQLStats(3)
Data Storage: N/A
Parameters: actionFlag - The portion of the SQLStats-flag which is represented by the 1st colon (:) piece, and can have one of the following values: 0 = Query Compilation: Don't generator SQLStats collection code for any Query Modules Query Execution: Don't collect SQLStats for any Query Modules 1 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Don't collect SQLStats for any Query Modules 2 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Collect SQLStats for MAIN Query Module (Start & Stop) 3 = Query Compilation: Generator SQLStats collection code for ALL Query Modules Query Execution: Collect SQLStats for ALL Query Modules returnActionFlag - 0 = Return the entire SQLStats-flag value [DEFAULT] 1 = Return only the {action-flag} value, which is the portion of the SQLStats-flag represented by the 1st colon (:) piece NOTE: This is the backward-compatible value collectFlag - The portion of the SQLStats-flag which is represented by the 2nd colon (:) piece, and is a numeric value representing which SQL Performance Statistics/Metrics to collect, with one of the following values: "" = Collect All SQL Performance Metrics [DEFAULT] n = Where n=SUM(MVal) [See Below]
In general, all of the following performance metrics are collected for each SQL module, along with a cumulative value representing all SQL modules, when the SQLStats-flag is turned on:
MVal Metric Name Metric Description
1 Query Execution Time Total number of seconds elapsed 2 Total Global References Total number of global references 4 Total Commands Executed Total number of OS commands executed 8 Total Disk Read Latency Time Total milliseconds spent waiting ==== for Disk Reads 15 ALL Collect all Performance Metrics
This parameter provides a mechanism by which to choose a combination of which performance metrics to collect, by specifying a SUM of the performance metrics MVal numbers (specified above) that you wish to collect.
EXAMPLE #1: The following example represents the collection of 2 performance metrics, 'Query Execution Time' & 'Total Disk Read Latency Time':
MVal Metric Name
1 Query Execution Time
9 Collect both of these performance metrics
By passing 9 for the value of the 'collectFlag' parameter, the sum of the two aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked.
EXAMPLE #2: The following example represents the collection of 3 performance metrics, 'Query Execution Time', 'Total Global References' & 'Total Commands Executed':
MVal Metric Name
1 Query Execution Time 2 Total Global References
7 Collect both of these performance metrics
By passing 7 for the value of the 'collectFlag' parameter, the sum of the three aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked. terminateCond - The portion of the SQLStats-flag which is represented by the 5th colon (:) piece, and is determined by this parameter value. An optional condition to determine when to terminate the SQLStats collection, by turning off the SQLStats-flag (System), or by setting it to a specified reset value. This parameter accepts the following values: 0 No Action [DEFAULT] M:<min>:<raf> Where <min>=# of minutes from 1..n When specified, this value will terminate the SQLStats collection the number of minutes <min> after the current $H Where <raf>=Reset {action-flag} value from 0..3 When specified, this is the value to which the {action-flag} portion of the SQLStats-flag will be set upon expiration If not specified, default <raf> to zero (0) (e.g. "M:120:1" => Terminate 120minutes after the current $H and reset SQLStats-flag/{action-flag} to 1) T:<ts>:<raf> Where <ts>=Timestamp with the format: YYYYMMDD HHMM When specified, this value will terminate the SQLStats collection after the timestamp value Where <raf>=Reset {action-flag} value from 0..3 When specified, this is the value to which the {action-flag} portion of the SQLStats-flag will be set upon expiration If not specified, default <raf> to zero (0) (e.g. "T:20171018 1330:1" => Terminate after 10/18/2017 01:30PM and reset SQLStats-flag/{action-flag} to 1) ptInfo - A Pass By Reference information array that returns to the user detailed information in the following format: ptInfo(category,variable)=value Where category = { "current" | "terminate" | ... } variable = A variable that corresponds to the given 'category'
Example: ptInfo("current","SQLStatsFlag")=The SQLStats-flag value after method execution
RETURN Value: The value of the SQLStats-flag before setting it to the new value; Otherwise, return an error message if an error occurred
|
static |
Method: SetSQLStatsFlag [SQL: StatsSQL_SetSQLStatsFlag] Replaces: N/A Status: New Functionality Purpose: See <method>SetSQLStats</method> for details!
|
static |
Method: SetSQLStatsFlagByNS [SQL: StatsSQL_SetSQLStatsFlagByNS] Replaces: N/A Status: New Functionality Purpose: This method sets the flag that controls whether or not to collect SQL Statistics about each run of a query within the given 'ns' (Namespace)
You can invoke different levels of SQL Statistics collection by setting the SQLStats-flag, for a given 'ns'.
The SQLStats-flag (System) controls whether or not SQL Statistics are collected for each SQL Query execution, and which performance statistics to be collected.
The SQLStats-flag is a colon (:) delimited string comprised of the following individual components:
SQLStats-flag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
NOTE: This method ONLY applies to the SQLStats-flag (System) for the given 'ns' and NOT the SQLStats-flag (Process/Job)!
Invocation: This method can be invoked in the following ways: Object Script: ##class(SYS.PTools.StatsSQL).SetSQLStatsFlagByNS(...) $SYSTEM.SQL.SetSQLStatsFlagByNS(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStatsFlagByNS(...)
Examples: The following examples shows the use of this method:
#1 Turn PTools ON to collects stats for all SQL modules within the "USER" Namespace:
set oldStats=##class(SYS.PTools.StatsSQL).SetSQLStatsFlagByNS("USER",3)
Data Storage: N/A
Parameters: ns - The Namespace ($NAMESPACE) for which to set the SQLStats-flag [REQUIRED] actionFlag - The portion of the SQLStats-flag which is represented by the 1st colon (:) piece, and can have one of the following values: 0 = Query Compilation: Don't generator SQLStats collection code for any Query Modules Query Execution: Don't collect SQLStats for any Query Modules 1 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Don't collect SQLStats for any Query Modules 2 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Collect SQLStats for MAIN Query Module (Start & Stop) 3 = Query Compilation: Generator SQLStats collection code for ALL Query Modules Query Execution: Collect SQLStats for ALL Query Modules returnActionFlag - 0 = Return the entire SQLStats-flag value [DEFAULT] 1 = Return only the {action-flag} value, which is the portion of the SQLStats-flag represented by the 1st colon (:) piece NOTE: This is the backward-compatible value collectFlag - The portion of the SQLStats-flag which is represented by the 2nd colon (:) piece, and is a numeric value representing which SQL Performance Statistics/Metrics to collect, with one of the following values: "" = Collect All SQL Performance Metrics [DEFAULT] n = Where n=SUM(MVal) [See Below]
In general, all of the following performance metrics are collected for each SQL module, along with a cumulative value representing all SQL modules, when the SQLStats-flag is turned on:
MVal Metric Name Metric Description
1 Query Execution Time Total number of seconds elapsed 2 Total Global References Total number of global references 4 Total Commands Executed Total number of OS commands executed 8 Total Disk Read Latency Time Total milliseconds spent waiting ==== for Disk Reads 15 ALL Collect all Performance Metrics
This parameter provides a mechanism by which to choose a combination of which performance metrics to collect, by specifying a SUM of the performance metrics MVal numbers (specified above) that you wish to collect.
EXAMPLE #1: The following example represents the collection of 2 performance metrics, 'Query Execution Time' & 'Total Disk Read Latency Time':
MVal Metric Name
1 Query Execution Time
9 Collect both of these performance metrics
By passing 9 for the value of the 'collectFlag' parameter, the sum of the two aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked.
EXAMPLE #2: The following example represents the collection of 3 performance metrics, 'Query Execution Time', 'Total Global References' & 'Total Commands Executed':
MVal Metric Name
1 Query Execution Time 2 Total Global References
7 Collect both of these performance metrics
By passing 7 for the value of the 'collectFlag' parameter, the sum of the three aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked. terminateCond - The portion of the SQLStats-flag which is represented by the 5th colon (:) piece, and is determined by this parameter value. An optional condition to determine when to terminate the SQLStats collection, by turning off the SQLStats-flag (System), or by setting it to a specified reset value. This parameter accepts the following values: 0 No Action [DEFAULT] M:<min>:<raf> Where <min>=# of minutes from 1..n When specified, this value will terminate the SQLStats collection the number of minutes <min> after the current $H Where <raf>=Reset {action-flag} value from 0..3 When specified, this is the value to which the {action-flag} portion of the SQLStats-flag will be set upon expiration If not specified, default <raf> to zero (0) (e.g. "M:120:1" => Terminate 120minutes after the current $H and reset SQLStats-flag/{action-flag} to 1) T:<ts>:<raf> Where <ts>=Timestamp with the format: YYYYMMDD HHMM When specified, this value will terminate the SQLStats collection after the timestamp value Where <raf>=Reset {action-flag} value from 0..3 When specified, this is the value to which the {action-flag} portion of the SQLStats-flag will be set upon expiration If not specified, default <raf> to zero (0) (e.g. "T:20171018 1330:1" => Terminate after 10/18/2017 01:30PM and reset SQLStats-flag/{action-flag} to 1) ptInfo - A Pass By Reference information array that returns to the user detailed information in the following format: ptInfo(category,variable)=value Where category = { "current" | "terminate" | ... } variable = A variable that corresponds to the given 'category'
Example: ptInfo("current","SQLStatsFlag")=The SQLStats-flag value after method execution
RETURN Value: The value of the SQLStats-flag before setting it to the new value; Otherwise, return an error message if an error occurred
|
static |
Method: SetSQLStatsFlagByPID [SQL: StatsSQL_SetSQLStatsFlagByPID] Replaces: N/A Status: New Functionality Purpose: This method sets the flag that controls whether or not to collect SQL Statistics about each run of a query for the given 'pid'
You can invoke different levels of SQL Statistics collection by setting the SQLStats-flag, for a given 'pid'.
The SQLStats-flag (Process/Job) controls whether or not SQL Statistics are collected for each SQL Query execution, and which performance statistics to be collected.
The SQLStats-flag is a colon (:) delimited string comprised of the following individual components:
SQLStats-flag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
NOTE: This method ONLY applies to the SQLStats-flag for the given 'pid' (Process/Job) and NOT the SQLStats-flag for the (System)!
RESTRICTION: This method invocation requires Admin_Operate:Use privilege
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).SetSQLStatsFlagByPID(...) $SYSTEM.SQL.SetSQLStatsFlagByPID(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStatsFlagByPID(...)
Examples: The following examples shows the use of this method:
#1 Turn PTools ON to collects stats for all SQL modules for PID# 12345:
set oldStats=##class(SYS.PTools.StatsSQL).SetSQLStatsFlagByPID(12345,3)
Data Storage: N/A
Parameters: pid - The process ID ($JOB) for which to set the SQLStats-flag [DEFAULT: Current $JOB] actionFlag - The portion of the SQLStats-flag which is represented by the 1st colon (:) piece, and can have one of the following values: -1 = Query Compilation: Turn SQLStats Off for the given 'pid' Query Execution: Turn SQLStats Off for the given 'pid' 0 = Query Compilation: Use the {action-flag} (System) setting Query Execution: Use the {action-flag} (System) setting 1 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Don't collect SQLStats for any Query Modules 2 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Collect SQLStats for MAIN Query Module (Start & Stop) 3 = Query Compilation: Generator SQLStats collection code for ALL Query Modules Query Execution: Collect SQLStats for ALL Query Modules returnActionFlag - 0 = Return the entire SQLStats-flag value [DEFAULT] 1 = Return only the {action-flag} value, which is the portion of the SQLStats-flag represented by the 1st colon (:) piece NOTE: This is the backward-compatible value collectFlag - The portion of the SQLStats-flag which is represented by the 2nd colon (:) piece, and is a numeric value representing which SQL Performance Statistics/Metrics to collect, with one of the following values: "" = Collect All SQL Performance Metrics [DEFAULT] n = Where n=SUM(MVal) [See Below]
In general, all of the following performance metrics are collected for each SQL module, along with a cumulative value representing all SQL modules, when the SQLStats-flag is turned on:
MVal Metric Name Metric Description
1 Query Execution Time Total number of seconds elapsed 2 Total Global References Total number of global references 4 Total Commands Executed Total number of OS commands executed 8 Total Disk Read Latency Time Total milliseconds spent waiting ==== for Disk Reads 15 ALL Collect all Performance Metrics
This parameter provides a mechanism by which to choose a combination of which performance metrics to collect, by specifying a SUM of the performance metrics MVal numbers (specified above) that you wish to collect.
EXAMPLE #1: The following example represents the collection of 2 performance metrics, 'Query Execution Time' & 'Total Disk Read Latency Time':
MVal Metric Name
1 Query Execution Time
9 Collect both of these performance metrics
By passing 9 for the value of the 'collectFlag' parameter, the sum of the two aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked.
EXAMPLE #2: The following example represents the collection of 3 performance metrics, 'Query Execution Time', 'Total Global References' & 'Total Commands Executed':
MVal Metric Name
1 Query Execution Time 2 Total Global References
7 Collect both of these performance metrics
By passing 7 for the value of the 'collectFlag' parameter, the sum of the three aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked. p5 - Placeholder Parameter for future extensibility ptInfo - A Pass By Reference information array that returns to the user detailed information in the following format: ptInfo(category,variable)=value
NOTE: This method currently returns no 'ptInfo', but is included for future extensibility
RETURN Value: The value of the SQLStats-flag before setting it to the new value; Otherwise, return an error message if an error occurred
|
static |
Method: SetSQLStatsFlagJob [SQL: StatsSQL_SetSQLStatsFlagJob] Replaces: SetSQLStatsJob [SQL: StatsSQL_SetSQLStatsJob] Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: This method sets the flag that controls whether or not this Process/Job collects SQL Statistics about each run of a query
You can invoke different levels of SQL Statistics collection by setting the SQLStats-flag, for your current Process/Job with this method.
The SQLStats-flag controls whether or not SQL Statistics are collected for each SQL Query execution, and which performance statistics to collect.
The SQLStats-flag is a colon (:) delimited string comprised of the following individual components:
SQLStats-flag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).SetSQLStatsFlagJob(...) $SYSTEM.SQL.SetSQLStatsFlagJob(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStatsFlagJob(...)
Examples: The following examples shows the use of this method:
#1 Turn PTools ON to collects stats for all SQL modules:
set oldStats=##class(%SYS.PTools.StatsSQL).SetSQLStatsFlagJob(3)
Data Storage: ^SYS("sql","sys","SQLStats")
Parameters: actionFlag - The portion of the SQLStats-flag which is represented by the 1st colon (:) piece, and can have one of the following values: -1 = Query Compilation: Turn SQLStats Off for this Process/Job Query Execution: Turn SQLStats Off for this Process/Job [-1 ONLY when flagType=1] 0 = Query Compilation: Use the {action-flag} (System) setting Query Execution: Use the {action-flag} (System) setting 1 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Don't collect SQLStats for any Query Modules 2 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Collect SQLStats for MAIN Query Module (Start & Stop) 3 = Query Compilation: Generator SQLStats collection code for ALL Query Modules Query Execution: Collect SQLStats for ALL Query Modules returnActionFlag - 0 = Return the entire SQLStats-flag value [DEFAULT] 1 = Return only the {action-flag} value, which is the portion of the SQLStats-flag represented by the 1st colon (:) piece NOTE: This is the backward-compatible value collectFlag - The portion of the SQLStats-flag which is represented by the 2nd colon (:) piece, and is a numeric value representing which SQL Performance Statistics/Metrics to collect, with one of the following values: "" = Collect All SQL Performance Metrics [DEFAULT] n = Where n=SUM(MVal) [See Below]
In general, all of the following performance metrics are collected for each SQL module, along with a cumulative value representing all SQL modules, when the SQLStats-flag is turned on:
MVal Metric Name Metric Description
1 Query Execution Time Total number of seconds elapsed 2 Total Global References Total number of global references 4 Total Commands Executed Total number of OS commands executed 8 Total Disk Read Latency Time Total milliseconds spent waiting ==== for Disk Reads 15 ALL Collect all Performance Metrics
This parameter provides a mechanism by which to choose a combination of which performance metrics to collect, by specifying a SUM of the performance metrics MVal numbers (specified above) that you wish to collect.
EXAMPLE #1: The following example represents the collection of 2 performance metrics, 'Query Execution Time' & 'Total Disk Read Latency Time':
MVal Metric Name
1 Query Execution Time
9 Collect both of these performance metrics
By passing 9 for the value of the 'collectFlag' parameter, the sum of the two aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked.
EXAMPLE #2: The following example represents the collection of 3 performance metrics, 'Query Execution Time', 'Total Global References' & 'Total Commands Executed':
MVal Metric Name
1 Query Execution Time 2 Total Global References
7 Collect both of these performance metrics
By passing 7 for the value of the 'collectFlag' parameter, the sum of the three aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked. p4 - Placeholder Parameter for future extensibility ptInfo - A Pass By Reference information array that returns to the user detailed information in the following format: ptInfo(category,variable)=value Where category = { "current" | "terminate" | ... } variable = A variable that corresponds to the given 'category'
Example: ptInfo("current","SQLStatsFlag")=The SQLStats-flag value after method execution
RETURN Value: The value of the SQLStats-flag before setting it to the new value; Otherwise, return an error message if an error occurred
|
static |
Method: SetSQLStatsJob [SQL: StatsSQL_SetSQLStatsJob] Replaces: SetSQLStatsJob SQL: SetSQLStatsJob <DEP>[DEPRECATED]</DEP> Replaced By: SetSQLStatsFlagJob [SQL: StatsSQL_SetSQLStatsFlagJob] Status: <BC>Maintained for Backward-Compatibility</BC> Purpose: This method sets the flag that controls whether or not this Process/Job collects SQL Statistics about each run of a query
You can invoke different levels of SQL Statistics collection by setting the SQLStats-flag, for your current Process/Job with this method.
The SQLStats-flag controls whether or not SQL Statistics are collected for each SQL Query execution, and which performance statistics to collect.
The SQLStats-flag is a colon (:) delimited string comprised of the following individual components:
SQLStats-flag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).SetSQLStatsJob(...) $SYSTEM.SQL.SetSQLStatsJob(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStatsJob(...)
Examples: The following examples shows the use of this method:
#1 Turn PTools ON to collects stats for all SQL modules:
set oldStats=##class(%SYS.PTools.StatsSQL).SetSQLStatsJob(3)
Data Storage: N/A
Parameters: actionFlag - The portion of the SQLStats-flag which is represented by the 1st colon (:) piece, and can have one of the following values: -1 = Query Compilation: Turn SQLStats Off for this Process/Job Query Execution: Turn SQLStats Off for this Process/Job [-1 ONLY when flagType=1] 0 = Query Compilation: Use the {action-flag} (System) setting Query Execution: Use the {action-flag} (System) setting 1 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Don't collect SQLStats for any Query Modules 2 = Query Compilation: Generator SQLStats collection code for MAIN Query Module (Start & Stop) Query Execution: Collect SQLStats for MAIN Query Module (Start & Stop) 3 = Query Compilation: Generator SQLStats collection code for ALL Query Modules Query Execution: Collect SQLStats for ALL Query Modules returnActionFlag - 0 = Return the entire SQLStats-flag value [DEFAULT] 1 = Return only the {action-flag} value, which is the portion of the SQLStats-flag represented by the 1st colon (:) piece NOTE: This is the backward-compatible value collectFlag - The portion of the SQLStats-flag which is represented by the 2nd colon (:) piece, and is a numeric value representing which SQL Performance Statistics/Metrics to collect, with one of the following values: "" = Collect All SQL Performance Metrics [DEFAULT] n = Where n=SUM(MVal) [See Below]
In general, all of the following performance metrics are collected for each SQL module, along with a cumulative value representing all SQL modules, when the SQLStats-flag is turned on:
MVal Metric Name Metric Description
1 Query Execution Time Total number of seconds elapsed 2 Total Global References Total number of global references 4 Total Commands Executed Total number of OS commands executed 8 Total Disk Read Latency Time Total milliseconds spent waiting ==== for Disk Reads 15 ALL Collect all Performance Metrics
This parameter provides a mechanism by which to choose a combination of which performance metrics to collect, by specifying a SUM of the performance metrics MVal numbers (specified above) that you wish to collect.
EXAMPLE #1: The following example represents the collection of 2 performance metrics, 'Query Execution Time' & 'Total Disk Read Latency Time':
MVal Metric Name
1 Query Execution Time
9 Collect both of these performance metrics
By passing 9 for the value of the 'collectFlag' parameter, the sum of the two aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked.
EXAMPLE #2: The following example represents the collection of 3 performance metrics, 'Query Execution Time', 'Total Global References' & 'Total Commands Executed':
MVal Metric Name
1 Query Execution Time 2 Total Global References
7 Collect both of these performance metrics
By passing 7 for the value of the 'collectFlag' parameter, the sum of the three aforementioned performance metrics MVal numbers, the SQLStats PTool application will only collect statistical data for these two performance metrics whenever an SQL Query is invoked. p4 - Placeholder Parameter for future extensibility ptInfo - A Pass By Reference information array that returns to the user detailed information in the following format: ptInfo(category,variable)=value Where category = { "current" | "terminate" | ... } variable = A variable that corresponds to the given 'category'
Example: ptInfo("current","SQLStatsFlag")=The SQLStats-flag value after method execution
RETURN Value: The value of the SQLStats-flag before setting it to the new value; Otherwise, return an error message if an error occurred
|
static |
Method: SetSQLStatsSaveFlag [SQL: StatsSQL_SetSQLStatsSaveFlag] Replaces: N/A Status: New Functionality Purpose: This method sets the flag that controls what type of SQL Statistics the System collects about each run of a query
The SQLStatsSave-flag controls what type of SQL Statistics are saved, either Optimal (new) or Original (backward-compatible).
The SQLStatsSave-flag is a colon (:) delimited string comprised of the following individual flags: {type-flag} & {method-flag}
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).SetSQLStatsSaveFlag(...) $SYSTEM.SQL.SetSQLStatsSaveFlag(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStatsSaveFlag(...)
Examples: The following examples shows the use of this method:
#1 Set the PTools SQL Stats save flag (System) to 'Optimal'
set oldFlag=##class(%SYS.PTools.StatsSQL).SetSQLStatsSaveFlag(1)
Data Storage: ^SYS("sql","sys","SQLStatsSave")
Parameters: typeFlag - 1 = Optimal (new) [DEFAULT] 2 = Original (backward-compatible) [Optional Parameters] methodFlag - 0 = Save the collected SQL Performance [DEFAULT] Statistics via SQL (SQL-Set) 1 = Save the collected SQL Performance Statistics via COS (Direct-Set) NOTE: This parameter is only applicable when 'typeFlag=1' <IMP>NOTE: This parameter should only be used when advised by InterSystems Staff!</IMP>
RETURN Value: The value of the SQLStatsSave-flag before setting to the new value; Otherwise, return an error message if an error occurred
|
static |
Method: SetSQLStatsSaveFlagJob [SQL: StatsSQL_SetSQLStatsSaveFlagJob] Replaces: N/A Status: New Functionality Purpose: This method sets the flag that controls what type of SQL Statistics this Process/Job collects about each run of a query
The SQLStatsSave-flag controls what type of SQL Statistics are saved, either Optimal (new) or Original (backward-compatible).
The SQLStatsSave-flag is a colon (:) delimited string comprised of the following individual flags: {type-flag} & {method-flag}
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).SetSQLStatsSaveFlagJob(...) $SYSTEM.SQL.SetSQLStatsSaveFlagJob(...) SQL: SELECT SYS_PTools.StatsSQL_SetSQLStatsSaveFlagJob(...)
Examples: The following examples shows the use of this method:
#1 Set the PTools SQL Stats save flag (Process/Job) to 'Optimal'
set oldFlag=##class(%SYS.PTools.StatsSQL).SetSQLStatsSaveFlagJob(1)
Data Storage: N/A
Parameters: typeFlag - 0 = Use the {type-flag} (System) value [DEFAULT] 1 = Optimal (new) 2 = Original (backward-compatible) [Optional Parameters] methodFlag - 0 = Save the collected SQL Performance [DEFAULT] Statistics via SQL (SQL-Set) 1 = Save the collected SQL Performance Statistics via COS (Direct-Set) NOTE: This parameter is only applicable when 'typeFlag=1' <IMP>NOTE: This parameter should only be used when advised by InterSystems Staff!</IMP>
RETURN Value: The value of the SQLStatsSave-flag before setting to the new value; Otherwise, return an error message if an error occurred
|
static |
Method: aggregateSQLStats [SQL: PT_aggregateSQLStats] Replaces: N/A Status: New Functionality Purpose: This function aggregates all of the statistical properties for each SQL Query where data was collected
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).aggregateSQLStats(...) SQL: CALL SYS_PTools.PT_aggregateSQLStats(...) SELECT SYS_PTools.PT_aggregateSQLStats(...)
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 Aggregate all of the statistical properties for the 'SAMPLES' namespace:
set status=##class(SYS.PTools.StatsSQL).aggregateSQLStats("SAMPLES")
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: ns - The namespace in which to aggregate SQL Statistics If none provided, spin through all namespaces where SQL Stats collected rtn - The routine in which to aggregate SQL Statistics If none provided, spin through all routines where SQL Stats collected curs - The cursor in which to aggregate SQL Statistics If none provided, spin through all cursor where SQL Stats collected
Return: Error Status
|
static |
Method: buildPPcost Replaces: BuildPPcost (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: * INTERNAL USE ONLY * NOTE: This method is ONLY provided as an interface for the purpose of backward compatibility
Parameters: qoqn - dmt - dmts - dalg - PPcost - An array of query cost details to return to the invoking method silent - 0 = Output information for this method invocation 1 = Don't perform any writes within this method invocation
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
Method: changeCost Replaces: ChangeCost (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: * INTERNAL USE ONLY * NOTE: This method is ONLY provided as an interface for the purpose of backward compatibility
Parameters: PPcost - The cost of the SQL Plan Path specified num - The cost number of the SQL Plan Path specified level - The cost level of the SQL Plan Path specified dmt - dmts - dalg - silent - 0 = Output information for this method invocation 1 = Don't perform any writes within this method invocation
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
Method: clearStatsSQL [SQL: PT_clearStatsSQL] Replaces: Purge SQL: StatsSQL_Purge <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: This method deletes all of the data stored in the 'SYS.PTools.StatsSQL' class, based on the specified parameters: 'ns' & 'rtn'
This method clears SQLStats which are gathered when the SQLStats-flag is turned ON, a SQL Statement is invoked, and the SQLStats-flag is turned OFF, as in the following example: set SQLStatsJOB=$SYSTEM.SQL.SetSQLStatsFlagJob(3) // SQLStats-flag ON set sql($i(sql))="SELECT COUNT(*) FROM Sample.Person" // Use Dynamic SQL Query Interface (SQL.Statement) to invoke // SQL Statement & collect SQLStats data: // New() ... Prepare(.sql) ... Execute() ... Next() ... OnClose() set SQLStatsJOB=$SYSTEM.SQL.SetSQLStatsFlagJob(0) // SQLStats-flag OFF
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).clearStatsSQL(...) SQL: CALL SYS_PTools.PT_clearStatsSQL(...) SELECT SYS_PTools.PT_clearStatsSQL(...)
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.StatsSQL' class in the 'SAMPLES' namespace:
set stats=##class(SYS.PTools.StatsSQL).clearStatsSQL("SAMPLES")
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
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.StatsSQL [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","clearStatsSQL")=The number of rows deleted via this 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.StatsSQL
|
static |
Method: clearStatsSQLAllNS [SQL: PT_clearStatsSQLAllNS] Replaces: N/A Status: New Functionality Purpose: This method deletes all of the data stored in the 'SYS.PTools.StatsSQL' class in All Namespaces on a system for which the user has Write Privileges (Write infers Read), based on the optional 'rtn' parameter...
This method clears SQLStats in all namespaces which are gathered when the SQLStats-flag is turned ON, a SQL Statement is invoked, and the SQLStats-flag is turned OFF, as in the following example: set SQLStatsJOB=$SYSTEM.SQL.SetSQLStatsFlagJob(3) // SQLStats-flag ON set sql($i(sql))="SELECT COUNT(*) FROM Sample.Person" // Use Dynamic SQL Query Interface (SQL.Statement) to invoke // SQL Statement & collect SQLStats data: // New() ... Prepare(.sql) ... Execute() ... Next() ... OnClose() set SQLStatsJOB=$SYSTEM.SQL.SetSQLStatsFlagJob(0) // SQLStats-flag OFF
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).clearStatsSQLAllNS(...) SQL: CALL SYS_PTools.PT_clearStatsSQLAllNS(...) SELECT SYS_PTools.PT_clearStatsSQLAllNS(...)
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.StatsSQL' class in all namespaces on the system:
set status=##class(SYS.PTools.StatsSQL).clearStatsSQLAllNS()
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: rtn - The routine in which to clear SQL Statistics If none provided, clear all routines in all appropriate namespaces [OPTIONAL] ph2 - Placeholder Parameter for future extensibility 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 total number of Stats rows deleted from the following class, for each namespace: SYS.PTools.StatsSQL [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","clearStatsSQLAllNS")=The number of rows deleted
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.StatsSQL
|
static |
Method: exportStatsSQL [SQL: PT_exportStatsSQL] Replaces: Export & ExportAll (<class>SYS.PTools.SQLStats</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: Create a Performance Tool file containing the data from the 'SYS.PTools.StatsSQL' and return the output location... By default, the file will be created in the current directory of the InterSystems IRIS instance.
NOTE: Current directory can be obtained in the following way, from a InterSystems IRIS Terminal: >write $ZU(12,"")
You can pass a different value for the 'file' parameters if you wish to override the default location and file name.
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).exportStatsSQL(...) SQL: CALL SYS_PTools.PT_exportStatsSQL(...) SELECT SYS_PTools.PT_exportStatsSQL(...)
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 Display this export file to the screen via a InterSystems IRIS Terminal:
set tSC=##class(%SYS.PTools.StatsSQL).exportStatsSQL($IO)
#2 Display this export file via the SQL Query Page of the Management Portal:
CALL SYS_PTools.PT_exportStatsSQL('$IO','H')
Where: '$IO' = Output to the current device NOTE: '$IO' can be omitted, as it is the default 'file' when invoked via the CALL interface 'H' = Output the format in HTML format NOTE: 'H' can be omitted, as it is the default 'format' when invoked via the CALL interface
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: file - The path and file in which to create and store the data from the SYS.PTools.StatsSQL class: (e.g. C:\exportFile.txt) NOTE: $IO = Outputs the data to the screen '$IO' = Output the data to the current device when invoked from the CALL/SELECT-interface '$DEF' = Ouput the data to the DEFAULT file when invoked from the CALL/SELECT-interface [DEFAULT: {Current-Directory}\PT_StatsSQL_exportStatsSQL[_{Stmt|Plan}]_YYYYMMDD_HHMMSS.{ext}] WHERE {Current-Directory} = The directory of the Namespace in which this method is invoked (e.g. $ZU(12,"")) NOTE 2: If Passed By Reference, then 'file' will be returned as the canonical name of the Export/Reporting file format - The output format of the Export/Reporting file This parameter has the following structure of constituent elements: format=<data-format>[:$LB(<delim>,<csv-header>,<csv-footer>)] Where the constituent elements have the following values: <data-format> - The format of the Export/Reporting file:
conds=<full condition> OR conds(0)=pos Count (WHERE pos = {1...n}) conds(pos)=$LIST() Pieces: 1) [<logical operator>] (Assumed Default: &&) 2) [{Heading}] (Omit for override cond) 3) <simple condition> | <complex condition>
WHERE: <full condition> := <full condition expression> <logical operator> := {&& | ||} (&& = AND | || = OR) <simple condition>@* := <oper>
<complex condition>@ := <complex condition expression>
@ = Contains no references to {Heading}
EXAMPLE: <full condition> conds="("",INFO,MAIN,""[("",""_{Module}_"",""))||({GlobalRefs}>20)" <simple condition> conds(0)=3 conds(1)=$LB(,"Module","=""INFO""") conds(2)=$LB("||","Module","=""MAIN""") conds(3)=$LB("||","GlobalRefs",">20") <complex condition> conds(0)=2 conds(1)=$LB(,"Module",""",INFO,MAIN,""[("",""_{*}_"","")") conds(2)=$LB("||","GlobalRefs","{*}>20") WHERE: {*} = value substitution for the 'Module' & 'GlobalRefs' fields NOTE: Conditions that don't contain any references to {Heading} fields, often called <override condition>s, can be included as <complex condition>s, as in the following example: conds(pos)=$LB(,,"$g(^zAction(""runIt""))=1")
NOTE: All conditions must be satisfied for the conds() to be considered true and for the row to be exported [PASS BY REFERENCE] ptInfo - A Pass By Reference information array that returns to the user the following details: ptInfo(variable)=value ptInfo("outputFile")=The canonical name of the Export/Reporting file contRowCnt - "" - No Action >=0 - Continuation from another Export, so skip the preamble code [InterSystems: Internal Purposes ONLY] bcFlag - This is a Backward-Compatibility flag used for [InterSystems: Internal Purposes ONLY]
RETURN Value: The status from the invocation of this method
|
static |
Method: getImportSchema [SQL: N/A] Replaces: ImportSchema (<class>SYS.PTools.SQLStats</class>) <DEP>[DEPRECATED]</DEP> Status: New Functionality Purpose: This method retrieves the Import Schema given the parameters: 'ns', 'rtn', & 'curs'
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).getImportSchema(...) SQL: N/A
Examples: The following examples shows the use of this method:
#1 Retrieve the SQL Text for any of the data rows retrieved from invoking the 'exportStatsSQL()' method:
CALL SYS_PTools.PT_exportStatsSQL() set iSchema=##class(SYS.PTools.StatsSQL).getImportSchema($NAMESPACE,"PToolsSQLStats"_$JOB,"SQLStats0")
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: ns - The namespace from which to retrieve the SQL Query Text rtn - The routine from which to retrieve the SQL Query Text curs - The cursor from which to retrieve the SQL Query Text
Return: Return the Import Schema; Otherwise, return the Error Status if an error occurs.
|
static |
Method: getQueryText [SQL: N/A] Replaces: QueryText (<class>SYS.PTools.SQLStats</class>) <DEP>[DEPRECATED]</DEP> Status: New Functionality Purpose: This method retrieves the SQL Query Text given the parameters: 'ns', 'rtn', 'curs', & 'getInt'
Invocation: This method can be invoked in the following ways: ObjectScript: ##class(SYS.PTools.StatsSQL).getQueryText(...) SQL: N/A
Examples: The following examples shows the use of this method:
#1 Retrieve the SQL Text for any of the data rows retrieved from invoking the 'exportStatsSQL()' method:
CALL SYS_PTools.PT_exportStatsSQL() set sql=##class(SYS.PTools.StatsSQL).getQueryText($NAMESPACE,"PToolsSQLStats"_$JOB,"SQLStats0")
Data Storage: ^sqlcq($NAMESPACE,"PTools","db","Stats{C|D|I|S|Z}")
Parameters: ns - The namespace from which to retrieve the SQL Query Text rtn - The routine from which to retrieve the SQL Query Text curs - The cursor from which to retrieve the SQL Query Text getInt - 0 = Return the External Query Text 1 = Return the Internal Query Text
Return: Return either the Internal or External SQL Query Text; Otherwise, return the Error Status if an error occurs.
|
static |
Method: map Replaces: map (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: * INTERNAL USE ONLY * NOTE: This method is ONLY provided as an interface for the purpose of backward compatibility
Parameters: data - mt - mts - alg - qnum - str -
silent - 0 = Output information for this method invocation 1 = Don't perform any writes within this method invocation
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
<STUB>Stub: For the 'newSQLStats()' method in the 'SYS.PTools.MAC' routine</STUB> Status: New Method to replicate Backward-Compatible Method it 'Replaces'
|
static |
Method: possiblePlans Replaces: PossiblePlans (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: Generate a plan() arrays for the SQL Plan Path specified for the given 'sql' Query Statement. This method processed by the ShowPlanAlt^apiSQL() method and other such interfaces...
Parameters: sql - An array of the SQL Statement in the following format: sql={ln# counter} sql({ln#})={SQL Statement} PPcost - The cost of the SQL Plan Path specified num - The cost number of the SQL Plan Path specified level - The cost level of the SQL Plan Path specified arr - 0 = Output the plan(1:plan) array via WRITE 1 = Leave the resulting plan lines in the array plan(1:plan) showStats - 0 = Do not show stats as part of the plan [DEFAULT] 1 = Run the SQL query to generate stats and output the stats as part of the plan text 2 = Lookup the stats in SYS.PTools.StatsSQL 3 = Generate alternate plan for the Portal schemaImport - Used with the #IMPORT preprocessor directive, one or more schema
names to search to supply the schema name for an unqualified table name in an Embedded SQL query. You can specify a single schema name, or a comma-separated list of schema names. NOTE: All schemas must be in the current namespace. #IMPORT directives are additive. Specifying a second #IMPORT does not inactivate the list of schema names specified in a prior #IMPORT. [DEFAULT: ""] schemaPath - Used with the #SQLCompile Path preprocessor directive, one or more schema names to search, refered to as the schema search path, for any subsequent Embedded SQL query statements. You can specify a single schema name, or a comma-separated list of schema names. NOTE: #SQLCompile Path directive overwrites the path specified in a prior #SQLCompile Path directive; it does not overwrite schema names specified in prior #IMPORT directives. [DEFAULT: ""] preparse - 0 = Do not do any preparsing to the SQL statement [DEFAULT] 1 = Preparse the SQL statement to perform literal replacement NOTE: ShowPlan call from the SMP will call with preparse=1 so the plan reflects the same execution path as the Execute Query will hash - A hash string of the plan() array: $$Hash^SYS.SQLSRV(str,.plan,.Hval) [PASS BY REFERENCE] silent - 0 = Output information for this method invocation 1 = Don't perform any writes within this method invocation
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
Method: possiblePlansClose Replaces: PossiblePlansClose (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: Mimic an SQL CLOSE by clearing the Result-Set
Parameters: qHandle - Query Handle
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
Method: possiblePlansExecute Replaces: PossiblePlansExecute (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: Mimic an SQL OPEN and create a Result-Set by invoking the method ShowPlanAlt^apiSQL(...) for the specified 'sql' parameter. The Result-Set created is in the following format: AltPlan(qHandle,0)=$LIST(cost,num,$$map^SYS.PTools(...)) AltPlan(qHandle)=plan()
Parameters: qHandle - Query Handle sql - An string or array of the SQL Statement in the following format: sql={SQL Statement} OR sql={ln# counter} sql({ln#})={SQL Statement}
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
Method: possiblePlansFetch Replaces: PossiblePlansFetch (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Query to replicate Backward-Compatible Query it 'Replaces' Purpose: Mimic an SQL FETCH and return a 'Row' of the Result-Set by iterating over the 'AltPlan(qHandle)' array with the 'qHandle' The Result-Set 'Row' is returned in the following format: $LIST(qHandle,cost,map,type,"Plan")
Parameters: qHandle - Query Handle Row - A row of the SQL Query Result-Set in the following format: $LIST(qHandle,cost,map,type,"Plan") AtEnd - A FETCH marker with the following values: 0 = More rows to FETCH [DEFAULT] 1 = No more rows to FETCH
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
Method: possiblePlansStatsClose Replaces: PossiblePlansStatsClose (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: Mimic an SQL CLOSE by clearing the Result-Set
Parameters: qHandle - Query Handle
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
Method: possiblePlansStatsExecute Replaces: PossiblePlansStatsExecute (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: Mimic an SQL OPEN and create a Result-Set by invoking the method ShowPlanAlt^apiSQL(...) for the specified 'sql' & 'ids' parameters. The Result-Set created is in the following format: AltPlan(qHandle,0)=$LIST(cost,num,$$map^SYS.PTools(...)) AltPlan(qHandle)=plan()
Parameters: qHandle - Query Handle sql - An string or array of the SQL Statement in the following format: sql={SQL Statement} OR sql={ln# counter} sql({ln#})={SQL Statement} ids - A comma (,) delimited list of Possible Plans IDs in the following format: ids="[,ID]...[,ID]" (e.g. ",1,3")
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
Method: possiblePlansStatsFetch Replaces: PossiblePlansStatsFetch (<class>SYS.PTools.SQLUtilities</class>) <DEP>[DEPRECATED]</DEP> Status: New Method to replicate Backward-Compatible Method it 'Replaces' Purpose: Mimic an SQL FETCH and return a 'Row' of the Result-Set by iterating over the 'AltPlan(qHandle)' array with the 'qHandle' The Result-Set 'Row' is returned in the following format: $LIST(qHandle,cost,map,globals,commands,time,rows,"Plan")
Parameters: qHandle - Query Handle Row - A row of the SQL Query Result-Set in the following format: $LIST(qHandle,cost,map,type,"Plan") AtEnd - A FETCH marker with the following values: 0 = More rows to FETCH [DEFAULT] 1 = No more rows to FETCH
RETURN Value: The status of this method; Otherwise, return an error message if an error occurred
|
static |
<STUB>Stub: For the 'saveSQLStats()' method in the 'SYS.PTools.MAC' routine</STUB> Status: New Method to replicate Backward-Compatible Method it 'Replaces'
|
static |
<STUB>Stub: For the 'startSQLStats()' method in the 'SYS.PTools.MAC' routine</STUB> Status: New Method to replicate Backward-Compatible Method it 'Replaces'
|
static |
<STUB>Stub: For the 'stopSQLStats()' method in the 'SYS.PTools.MAC' routine</STUB> Status: New Method to replicate Backward-Compatible Method it 'Replaces'
|
static |
If Aggregated Data can be used for the given 'ns', 'rtn', and 'curs', then.
return 1; Otherwise, return 0
| CursorName |
| Hash |
| ImportSchema |
ImportSchema is used in generated code to handle SQL statements that have.
unqualified table names
| NameSpace |
The NameSpace in which the SQL query resides.
| Parameters |
List of Query Parameters.
| QueryCompileTime |
Number of Seconds it takes to compile the query.
| QueryType |
<PROP>
The type of SQL Query for which stats will be recorded: SQL-Statement=>SQLType -> mt("t")=>SQLType SEL=>SELECT | DEC=>SELECT | INS=>INSERT | UPD=>UPDATE | DEL=>DELETE </PROP>
| RoutineName |
The name of the routine in which the SQL query resides.
| RoutineNameUCQCaller |
<PROP>
The name of the Routine/Class in which the Embedded SQL Statement resides, and which ultimately calls/invokes the Universal Cached Query [UCQ] created as the class container to compile and code-generate the Embedded SQL Statement's query code. The value stored in this property will have the following format:
NOTE: This property will only have a value if a Routine/Class contains an Embedded SQL Statement within one of its methods which calls/invokes a Universal Cached Query [UCQ]. This property will be stored within the following row of this class/table: WHERE StatsMarker = 1 /* 'SYS.PTools.StatsSQL' */ AND StatsGroup = 0 /* 'INFO' */ AND ModuleName = -1 /* 'INFO' */
This property will also be stored in the following 'Conditional Index', which will be maintained via Triggers: ^sqlcq($NAMESPACE,"PTools","db","StatsI","rtnUCQCaller",{RoutineNameUCQCaller},...) </PROP>
| SQLIndexHash |
<PROP>
Internal unique statement hash used as the ID for the SQL Statement Index (DPV4651): ^rINDEXSQL("sqlidx",1,{SQLIndexHash},...) ^rINDEXSQL("sqlidx",2,{rtn},{SQLIndexHash}) ^rINDEXSQL("sqlidx",3,{table},{SQLIndexHash}) For additional details, refer to the following: http://twiki.iscinternal.com/twiki/bin/view/ISC/SQL20Statement20Indexing </PROP>
| SQLStatsFlag |
<PROP>
A flag that controls whether or not SQL Statistics are collected for each SQL Query execution (by anybody on the system, by a given Process/Job, or for a given Namespace), and which performance statistics to be collected.
The SQLStatsFlag is a colon (:) delimited string comprised of the following individual flags:
SQLStatsFlag={action-flag}:{collect-flag}:{condition-flag}:{condition-value}:{terminate-flag}:{flag-type}
The {action-flag} portion of the SQLStatsFlag is represented by 1st colon piece The {collect-flag} portion of the SQLStatsFlag is represented by 2nd colon piece The {condition-flag} portion of the SQLStatsFlag is represented by 3nd colon piece The {condition-value} portion of the SQLStatsFlag is represented by 4nd colon piece The {terminate-flag} portion of the SQLStatsFlag is represented by 5nd colon piece The {flag-type} portion of the SQLStatsFlag is represented by 6nd colon piece
Internal: $$$getSQLStatsFlagForJob | $$$getSQLStatsFlagForSystem </PROP>
| SQLTextRaw |
Raw SQL Statement Text stored as a $LIST string.
**NOTE: If this property changes position/location within the data storage global, ensure that the following MACROS are updated accordingly:
| StatsGroup |
<PROP>
This is a unique number that specifies the Stats Collection Group for each query run The counter comes from bumping the following global: ^sqlcq($NAMESPACE,"PTools","db","StatsZ","StatsGroup",1,{NameSpace},{RoutineName},{CursorName}) USE: $$$bumpStatsSQLStatsGroup({NameSpace},{RoutineName},{CursorName}) </PROP>
| StatsMarker |
<PROP>
This marker indicates if the statistical data is from a SQL Query, in which case the 'SYS.PTools.StatsSQL' class should be use, or if these stats are general purpose stats for non-SQL modules, in which case the <class>SYS.PTools.Stats</class> class should be use. </PROP>
| TotalCommandsExecuted |
The total number of ObjectScript commands that were executed in this Module for the given query.
| TotalCounter |
The total number of times the query has been run since it's last compilation.
| TotalDiskWait |
The total number of Milliseconds spent waiting for Disk reads in this Module for the given query.
| TotalGlobalRefs |
The total number of global references done in this Module for the given query.
| TotalLinesOfCode |
| TotalModuleCount |
The total number of times we entered this module for the run of the query.
| TotalRowCount |
The total number of rows returned in the MAIN Module for the given query.
| TotalTimeSpent |
The total time spent in this Module for the given query.
| TotalTimeToFirstRow |
The total time spent finding the first row in the MAIN Module for the given query.
| VarianceTimeSpent |
The variance of the time spent in this Module for the given query.
| creationDate |
Creation Date: $HOROLOG date format.
| creationTime |
Creation Time: $HOROLOG time format.
1.9.1