This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %CSP.UI.Portal.SQL.QButtons.IndexAnalyzer

%CSP.UI.Portal.SQL.QButtons.IndexAnalyzer

class %CSP.UI.Portal.SQL.QButtons.IndexAnalyzer extends %CSP.UI.Template.Property, %CSP.UI.Portal.UtilsNav

System Management Portal - SQL Performance Tool

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.SQL.QButtons.IndexAnalyzer.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter HELPADDRESS = Home,SQL Index Analyzer;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = SQL.QButtons.IndexAnalyzer;
Displayed name of this page.
parameter RESOURCE = %Development:USE;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties (Including Private)

property PlanPage as %String;
Property methods: PlanPageDisplayToLogical(), PlanPageGet(), PlanPageIsValid(), PlanPageLogicalToDisplay(), PlanPageLogicalToOdbc(), PlanPageNormalize(), PlanPageSet()
property QUERYNAME as %ZEN.Datatype.string [ InitialExpression = "indexUsage" ];
Property methods: QUERYNAMEDisplayToLogical(), QUERYNAMEGet(), QUERYNAMEIsValid(), QUERYNAMELogicalToDisplay(), QUERYNAMELogicalToOdbc(), QUERYNAMENormalize(), QUERYNAMESet()
property dots as %String;
Property methods: dotsDisplayToLogical(), dotsGet(), dotsIsValid(), dotsLogicalToDisplay(), dotsLogicalToOdbc(), dotsNormalize(), dotsSet()
property gatherStatus as %Boolean;
Property methods: gatherStatusDisplayToLogical(), gatherStatusGet(), gatherStatusIsValid(), gatherStatusLogicalToDisplay(), gatherStatusLogicalToXSD(), gatherStatusNormalize(), gatherStatusSet(), gatherStatusXSDToLogical()
property jobStatus as %String;
Property methods: jobStatusDisplayToLogical(), jobStatusGet(), jobStatusIsValid(), jobStatusLogicalToDisplay(), jobStatusLogicalToOdbc(), jobStatusNormalize(), jobStatusSet()

Methods (Including Private)

method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
method CheckButtonStatus() [ ZenMethod ]
method CheckRadioStatus(title, queryName) [ ZenMethod ]
classmethod ClearResults() as %Status [ ZenMethod ]
classmethod ClearStatements() as %Status [ ZenMethod ]
method CreateRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
pInfo holds details on how to create the query.
method DrawDetailsTitle(pSeed) as %Status
Draw html for details title: Routine name and Query text
method DrawSQLStatements(pSeed) as %Status
method DrawShowPlanCell(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
method GatherStatements() [ ZenMethod ]
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
method PrepareAnalysis(option, system) [ ZenMethod ]
classmethod PrepareShowPlan(query, schema="") [ ZenMethod ]
clientmethod clearRadio() [ Language = javascript ]
clientmethod endButtonGather() [ Language = javascript ]
Called by server-side GatherStatements method upon completion
clientmethod endRadioOption(newOption) [ Language = javascript ]
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod refreshButton(string) [ Language = javascript ]
clientmethod refreshRadio(string, title, queryName) [ Language = javascript ]
clientmethod schemaSort() [ Language = javascript ]
method showPlan(query, schema) [ ZenMethod ]
clientmethod startButtonGather() [ Language = javascript ]
Invoke method to gather SQL Statements and update SQL Statement Count table. During this time, disable the rasio buttons.
clientmethod startRadioOption(newOption) [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)