Class Reference
%CSP.UI.SQL.QueryPane
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%CSP] >  [UI] >  [SQL] >  [QueryPane]
Private  Storage

class %CSP.UI.SQL.QueryPane extends %CSP.Util.SQLQueryPane

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

An AutoPage pane that lets a user enter an SQL query and execute it.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 2


Summary

Properties
Actions Align AutoRefresh CheckboxId
CommandFormClass CommandFormObject CommandSubmitPage Commands
Conditions FrameStyle HiddenColumns ItemsPerPage
LocalizeColumns MaxColumns MaxResults Name
Query SQLQuery ShowCheckboxes ShowFilter
ShowLastUpdate ShowRowNumbers ShowSearchPage ShowZebra
Sortable Styles Text URL
bgcolor border cellpadding cellspacing
enableAutoRefresh

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
CreateDataSet CreateResultSet CreateTempFile DrawBODY
DrawCommandForm DrawCommands DrawHEAD DrawLastUpdate
DrawSearch DrawStatusError DrawTable ExecuteResultSet
FilterTable GenerateCode GetColorByColumn GetDescriptiveText
GetItemsPerPage ItemsPerPageUpdate LocalizeColumnName LocalizeText
OnDrawFilter OnDrawHEADTablePane OnGenerateCode PurgeTempData
QuoteCOS RefreshTable XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Parameters

• parameter SHOWSQLINFO = 1;
Should this page display SQL Info
• parameter SHOWSTATISTICS = 1;
Should this page display timing stats

Methods

• method CreateResultSet(ByRef pID As %String, ByRef pRS As %ResultSet) as %Status
This method creates the %ResultSet object that is used for the table pane.
A subclass can override this to customize the table displayed by this pane.
pID is array of page variables...
• method ExecuteResultSet(pRS As %ResultSet, ByRef pID As %String) as %Status
This method performs the actual execution of the ResultSet This can be overridden by subclasses


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.