Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [SQL] >  [TuneTable]
Private  Storage   

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

System Management Portal - SQL Tuen Table page.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 6 26


Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource CurrentSize Filter FirstFailed
HelpAddress ISREADONLY InvalidParam IsEMSReadOnly
IsEditForm IsTuned LocatorHeader NAMESPACE
OnclickArray PID ParentURL SCHEMANAME
StdTitle TABLENAME TableMaxRows TablePageSize
ValidationErrorMsg aboutPage align aux
backgroundTimerInterval cellAlign cellSize cellStyle
cellVAlign children composite contactPage
containerStyle cssLevel currSortMode currStep
currViewMode disabled dragAndDrop dragEnabled
dropEnabled enableAutoRefresh enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
home homePage iTimeoutInterval id
index label labelClass labelDisabledClass
labelPosition labelStyle layout lblCurrentTableSize
lblTitle limitPopups name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent searchKey showLabel
slice title tuple useSVG
useSoftModals valign visible width
window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %AddToSaveSet %ApplyURLParms
%Attr %BindExport %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML %DrawHTML
%DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetNavTableState
%GetPageName %GetParameter %GetProductName %GetValueById
%GetValueByName %GetXMLName %IsA %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion BuildMenu CheckAllBlanks CheckContextLinks
CheckEnterpriseManager CheckJobStatus ConvertParameter Decrypt
DoLogout DrawLocator DrawPropertyTitle DrawRibbon
DrawSQLTitle DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult ExecuteRS GetCSPURL
GetContextLinks GetDocURL GetHomePage GetNewURL
GetQuickLinks HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate JavaInstalled
Link OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL SaveData SaveMap
SaveTableSize SetSelValues ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
UpdateTableNavState XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
adjustSizes afterSave afterValidate cancelPopup
changePassword childrenMutated clearForm correctIELayering
createComponent createComponentNS deleteComponent disableCommandButton
doCancel doClose doModified doSave
doSaveTableSize doSelectRow doTuneTable dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getPageTitle getProperty getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton invokeSuper
isButtonDisabled isOfType launchPopupWindow logout
makeId navMaxRowsChanged navPageSizeChanged navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
removeChild render renderContents renderSVG
resetMsg searchBlur searchBoxHandler searchFocus
searchKeyDown searchKeyPress setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation showExpand
showHelp showMsg startModal startProgressBar
stopProgressBar switchNamespace tabChanged timeout
toggleButtons toggleOptions toggleSettings trimSpace
validateRequired


Parameters

• parameter PAGENAME = "SQL Table Statistics";
Displayed name of this page.
• parameter RECENT = 0;
If true, register visits to this page in the recent list.
• parameter RESOURCE = "%Development";
Security requirement

Properties

• property CurrentSize as %Integer;
Current extent size when the page is loaded. Used to compare with the textbox value.
• property IsTuned as %Boolean [ InitialExpression = 0 ];
• property SCHEMANAME as %String(ZENURL="SCHEMANAME");
• property TABLENAME as %String(ZENURL="TABLENAME");
• property iTimeoutInterval as %ZEN.Datatype.integer [ InitialExpression = 1000 ];
• property lblCurrentTableSize as %ZEN.Datatype.string [ InitialExpression = $$$TextHTML("Current Extentsize (per shard if table is sharded): ") ];

Methods

• method %OnAfterCreatePage() as %Status
Be sure to do ##super() when overriding.
• method %OnGetPageName() as %String
This should be implemented in a subclass.
• classmethod CheckJobStatus(PID, SCHEMANAME, TABLENAME) as %ZEN.proxyObject [ ZenMethod ]
• method DrawPropertyTitle(pPropertyForm) as %Status
• method DrawSQLTitle(pSeed) as %Status
• method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for executing the process query.
• classmethod SaveData(SchemaName, TableName, KeepClassUpToDate, field, selectivity, outSelectivity, outValue, AverageFieldSize) as %String [ ZenMethod ]
• classmethod SaveMap(SchemaName, TableName, KeepClassUpToDate, field, blockCount) as %String [ ZenMethod ]
• classmethod SaveTableSize(SCHEMANAME, TABLENAME, ExtentSize, KeepClassUpToDate) as %String [ ZenMethod ]
This is called when user clicks Save for Table Extentsize they edited.
• classmethod SetSelValues(CurrentSize, ExtentSize, KeepClassUpToDate, SCHEMANAME, TABLENAME) as %ZEN.proxyObject [ ZenMethod ]
User clicked Tune Table button. Now calculate table extentsize, blockcounts, and selectivity and save.
• 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.
• method adjustSizes() [ Language = javascript ]
• method clearForm() [ Language = javascript ]
Clear form
• method doClose() [ Language = javascript ]
• method doSave(option) [ Language = javascript ]
• method doSaveTableSize() [ Language = javascript ]
• method doSelectRow(option) [ Language = javascript ]
• method doTuneTable() [ Language = javascript ]
• method navMaxRowsChanged(value, tableId) [ Language = javascript ]
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
• method navPageSizeChanged(value, tableId) [ Language = javascript ]
Overriden to add tabId and tableId to the page name to distinguish the type for the page.
• method onlayoutHandler(load) [ Language = javascript ]
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.
• method tabChanged(index) [ Language = javascript ]
• method timeout() [ Language = javascript ]
timeout function
• method toggleButtons(flag) [ Language = javascript ]
hide the two panes during Tuning until Tuning is finished. user can still click the Close button to quit out.
• method toggleOptions() [ Language = javascript ]
Show or hide Edit Table Extentsize fields.


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