Skip to main content


class %CSP.UI.SQL.SQLPane extends %CSP.Util.Pane

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 displays a table based on a class query. This class is used for SQL Manager utilities

Property Inventory

Method Inventory


property Actions as array of %CSP.Util.Action (XMLKEYNAME = "name");
An array of actions, indexed by column name in the query. These are associated with columns in a table.
If the subscript name starts with a $, then the action is displayed as an additional column in the table.
Property methods: ActionsBuildValueArray(), ActionsCollectionToDisplay(), ActionsCollectionToOdbc(), ActionsDisplayToCollection(), ActionsGet(), ActionsGetObject(), ActionsGetObjectId(), ActionsGetSwizzled(), ActionsIsValid(), ActionsOdbcToCollection(), ActionsSet(), ActionsSetObject(), ActionsSetObjectId()
property MaxColumns as %Integer;
Max number of columns to show.
Property methods: MaxColumnsDisplayToLogical(), MaxColumnsGet(), MaxColumnsIsValid(), MaxColumnsLogicalToDisplay(), MaxColumnsNormalize(), MaxColumnsSet(), MaxColumnsXSDToLogical()
property Method as %String (MAXLEN = 128);
Name of the class method that provides info for the Cached Query.
This is a full name: e.g., "Package.Class:MethodName" In this SYSTEM class the Method is used to store the function name
Property methods: MethodDisplayToLogical(), MethodGet(), MethodIsValid(), MethodLogicalToDisplay(), MethodLogicalToOdbc(), MethodNormalize(), MethodSet()
property Query as %String (MAXLEN = 128);
Name of the class query that provides info for the Table.
This is a full name: e.g., "Package.Class:QueryName" In this SYSTEM class the Query is used to store the function name
Property methods: QueryDisplayToLogical(), QueryGet(), QueryIsValid(), QueryLogicalToDisplay(), QueryLogicalToOdbc(), QueryNormalize(), QuerySet()
property ShowRowNumbers as %Boolean [ InitialExpression = 0 ];
If true, then rows numbers are displayed.
Property methods: ShowRowNumbersDisplayToLogical(), ShowRowNumbersGet(), ShowRowNumbersIsValid(), ShowRowNumbersLogicalToDisplay(), ShowRowNumbersLogicalToXSD(), ShowRowNumbersNormalize(), ShowRowNumbersSet(), ShowRowNumbersXSDToLogical()
property ShowZebra as %Boolean [ InitialExpression = 0 ];
If true, then rows are displayed using zebra styling.
Property methods: ShowZebraDisplayToLogical(), ShowZebraGet(), ShowZebraIsValid(), ShowZebraLogicalToDisplay(), ShowZebraLogicalToXSD(), ShowZebraNormalize(), ShowZebraSet(), ShowZebraXSDToLogical()
property Sortable as %Boolean [ InitialExpression = 0 ];
If true, then rows in the table can be sorted.
Property methods: SortableDisplayToLogical(), SortableGet(), SortableIsValid(), SortableLogicalToDisplay(), SortableLogicalToXSD(), SortableNormalize(), SortableSet(), SortableXSDToLogical()


classmethod BuildSortFile(pRS As %ResultSet, pSortCol As %String, pMaxCols As %Integer, ByRef pCols As %String, ByRef pSortFile) as %Boolean
Sort the data within a ResultSet and place the results in a tempfile. pCol contains the names of the columns ordered by column #.
method DrawBODY(pInstance As PageInstance) as %Status
Draw the BODY of the detail pane
method OnGenerateCode() as %String
Inherited description: Subclasses override this to generate code during CSP processing
classmethod TuneTables(ByRef pParms As %String) as %Status
Method to tune all tables in a schema, or an individual table in the background
classmethod listCQ(ByRef listRec As %String, ByRef listTH As %String, ByRef tQuery As %String) as %Integer
Return CQ infor

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab