This class is used internally by Caché. 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.
Zen page for System Management Portal - Home for SQL
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;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = SQL Home Page;
Displayed name of this page.
parameter RESOURCE = %Development;
Security requirement
Properties
property BuilderPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.SQL.QueryBuilderWindow.cls",,1) ];
current user selected catalog type - updated when user clicked on a tree node. -1=Nothing selected; 0=Table; 1=SystemTable; 2=View; 3=Procedure; 4=Cached Query
property ObjectSelectMode as %Integer [ InitialExpression = 0 ];
Specify how columns whose type class is a swizzleable class
will be defined in the result set class generated from a SELECT statement.
Currently it is always set to 0.
property msgDeleteCQNamespace as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to delete ALL cached queries in namespace %1?") ];
property msgDeleteCQTable as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to delete all cached queries for table %1?") ];
classmethod Drop(pDropType, pSchema, pTable) as %String [ ZenMethod ]
Drop a Table, View, Procedure, or CachedQuery
classmethod GetCQText(pRoutine) as %String [ ZenMethod ]
Given cached query routine name, return query text
classmethod GetCQs(pShowSystem, pFilter, pSchema, pTotalNumber, ByRef pTree) as %Integer
Build array for Cached Queries tree.
If schema is not null then use CachedQueryInfo that takes in the schema name and get routines(classes) that belong to that schema.
If filter is not null then match routine name to that filter.
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
Curently we do not display the ribbon for this page.
classmethod SaveQueryHistory(QueryText As %String, Output HistoryId) as %Status
classmethod TableFields(tableName) as %String [ ZenMethod ]
Given schema == table, return a list of fields concatenated by commas excluding hidden fields. Used by drag and drop.
classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer, ptableId As %String) [ ZenMethod ]
Used to Save tableNavBar values, add MapType to the page name to distinguish the type for the page.
clientmethod adjustSizes() [ Language = javascript ]
clientmethod deleteSelectedQuery() [ Language = javascript ]
if there are selected quries, then we are deleting selected queries.
else 1) if there are selected schema.table, then asking if user wants to delete
clientmethod doAction(action) [ Language = javascript ]
This method takes care of actions that do not need schema.table name
clientmethod doActionTable(action) [ Language = javascript ]
This method takes care of actions that need schema.table name
clientmethod doAllSchemas(applyFilter) [ Language = javascript ]
This method is called to show schemas
clientmethod doDeleteAll() [ Language = javascript ]
clientmethod doDrill(drillType, schemaname, overrideFilter) [ Language = javascript ]
drillType indicate the type (1 based. Tables/Views...) if overrideFilter is 0 then do not override Filter unless it is null.
clientmethod doExecute() [ Language = javascript ]
clientmethod doFilterType() [ Language = javascript ]
user changed filter type. Show or hide procedure options.
clientmethod doHistory() [ Language = javascript ]
*** Methods for Exeucte Query ***
clientmethod doInprogress() [ Language = javascript ]
clientmethod doOpenDoc(className) [ Language = javascript ]
This method opens Documatic in a seperate window. Called by table class doc and procedure doc.
clientmethod doOpenTableMax(maxRows) [ Language = javascript ]
clientmethod doQueryBuilder() [ Language = javascript ]
clientmethod doRebuildIndex(pIndex) [ Language = javascript ]
This is the method for rebuilding a particular index
clientmethod doReferenceTo(newtable, type) [ Language = javascript ]
User clicked a ReferenceTo link.
Check the current tree to see if we can find the reference class. If yes then make it selected and we won't need to refresh tree.
Otherwise, refresh tree with the new reference class as filter.
The tree will be collapsed and we will hide groupDetails and show message to remind user to reselect item from tree.
type arguement. 0 = Tables, 1 = View, 2 = Stored procedures
clientmethod doReloadNode(listType) [ Language = javascript ]
This method reload a particular listType.
The expected behavior:
If the current list selected on the tree is equal to the listType and is expanded, then reload the list and expand.
clientmethod doSearch() [ Language = javascript ]
reload tree with new filter. when this happens we want to hide groupDetails and
show the message to remind user to select item from tree.
clientmethod doSelectRow(thisTable) [ Language = javascript ]
clientmethod doShowPlan() [ Language = javascript ]
clientmethod doStatementDetailsTo(stmthash) [ Language = javascript ]
User clicked a StatementDetailsTo link.
clientmethod doTree(tree) [ Language = javascript ]
*** Methods for tree item text click ***
clientmethod getTable() [ Language = javascript ]
Return tree's selected index value
clientmethod historyFilterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod keyUp(zenEvent, flag) [ Language = javascript ]
Check if user hit [Enter].
clientmethod navMaxRowsChanged(value, tableId) [ Language = javascript ]
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
clientmethod navPageSizeChanged(value, tableId) [ Language = javascript ]
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
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 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.
clientmethod onloadHandler(load) [ Language = javascript ]
Inherited description: Disable save button for EMS-managed pages.
Be sure to use this.invokeSuper('onloadHandler',arguments); when overriding.
clientmethod prepareProp(routine) [ Language = javascript ]
User clicked the Cached Query link (it used to be a routine and now it's class) after executed a query. Hide components so that we can show CQ details.
Check the current tree to see if we can find the routine. If yes then make it selected and we won't need to refresh tree.
Otherwise, refresh tree with the new routine as filter.
The tree will be collapsed and we will hide groupDetails and show message to remind user to reselect item from tree.
clientmethod selectCQ(tRoutine, tAction) [ Language = javascript ]
User clicked Exeucte or ShowPlan link from the Cached Query details box. Query Routine is passed in.
clientmethod selectHistory(tID, tAction) [ Language = javascript ]
This method processes actions for a query history item.
clientmethod selectSchema(schema) [ Language = javascript ]
clientmethod showCQ(routine) [ Language = javascript ]
clientmethod showCQTable(routine) [ Language = javascript ]
clientmethod showCatalog() [ Language = javascript ]
show catalog details for a table
clientmethod showCatalogProc() [ Language = javascript ]
show catalog details for a stored procedure
clientmethod showCatalogView() [ Language = javascript ]
show catalog details for a view
clientmethod showExpand() [ Language = javascript ]
Inherited description: Note that this arrow is the opposite of search.
clientmethod showStatement(statement) [ Language = javascript ]
clientmethod showStatementTable(statement) [ Language = javascript ]
clientmethod showStatements() [ Language = javascript ]
show statement details for a table
clientmethod statementFilterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod tabChanged(tab, totalTabs) [ Language = javascript ]
user clicked a tab. hide/show result tables, and alter tab's background color.
clientmethod tableDropHandler(dragData) [ Language = javascript ]
Drop handler for model table.
clientmethod timeout() [ Language = javascript ]
This is currently used for cached queries. When user clicks the cached query name from the Execute Query tab,
we reload the tree for the cached query and starts the timer. When the timer reaches it's end it calls this method
to have the selected cached query "clicked" so that the CQ info block can be shown.
clientmethod toggleClearText(tControl) [ Language = javascript ]
show or hide the Clear image for Query Text or Filter
clientmethod toggleOptions() [ Language = javascript ]
clientmethod toggleSearch() [ Language = javascript ]
Toggle display of search pane.
clientmethod updateParameters() [ Language = javascript ]
Update properties for Execute Query and save to server for the future.
clientmethod updateStatistics() [ Language = javascript ]
This method is fired up after onDrawContent is finished. Hide progress message and display error if exists.
clientmethod updateTreeItems() [ Language = javascript ]
Update number of tree items loaded after a tree branch is loaded.
Totals are displayed at the bottom of the the tree pane
clientmethod validateText() [ Language = javascript ]