Skip to main content

%CSP.UI.Portal.SQL.QButtons.ShowPlanAlt

class %CSP.UI.Portal.SQL.QButtons.ShowPlanAlt extends %CSP.UI.Template.Property

Property Inventory

Method Inventory

Parameters

parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.SQL.QButtons.ShowPlanAlt.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 Alternate Show Plans;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = SQL.QButtons.ShowPlanAlt;
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

property PlanPage as %String;
Property methods: PlanPageDisplayToLogical(), PlanPageGet(), PlanPageIsValid(), PlanPageLogicalToDisplay(), PlanPageLogicalToOdbc(), PlanPageNormalize(), PlanPageSet()

Methods

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.
clientmethod ComparePlans() [ Language = javascript ]
method DrawCompare(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
method DrawDetailsTitle(pSeed) as %Status
Draw html for details title: Routine name and Query text
clientmethod GetPlans() [ Language = javascript ]
Invoke method to gather SQL Statements and update SQL Statement Count table. During this time, disable the rasio buttons.
classmethod PassSQLHack(query) [ ZenMethod ]
classmethod PassSQLHack2(query, ids) [ ZenMethod ]
classmethod PrepareShowPlan(query, rtn="") [ ZenMethod ]
clientmethod adjustSizes() [ Language = javascript ]
clientmethod doShowPlan(ID) [ Language = javascript ]
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab