Skip to main content


abstract class %SYSTEM.DeepSee extends %SYSTEM.Help

The %SYSTEM.DeepSee class provides an interface for the most common DeepSee tasks.

You can use it via the special $system object:

 Do $system.DeepSee.BuildCube("MyCube")
For a more complete API, refer to the %DeepSee.Utils class.

Method Inventory


classmethod BuildCube(pCubeName As %String, pAsync As %Boolean = 1, pVerbose As %Boolean = 1, pIndexOnly As %Boolean = 0, pMaxFacts As %Integer = 0, pTracking As %Boolean = 0, ByRef pBuildStatistics As %String = 0) as %Status
Update all facts in the DeepSee cube pCubeName with data from the source table.
This will delete any information currently in the cube. If pAsync is true, then background tasks are used.
If pVerbose is true, then status information is written to the console.
If pIndexOnly is true, only rebuild the fact table indices.
If pMaxFacts is non-zero, then only build this number of facts.
classmethod KillCube(pCubeName As %String) as %Status
Delete all indices and cache values for the given cube.
classmethod ListCubes()
Display a list of all cubes within this namespace (that are visible to the current user) to the console.
classmethod PurgeObsoleteCache(pCubeName As %String) as %Status
Delete all cache that has been invalidated for cube pCubeName.
The results cache is stored in partitions, and a partition of the results cache is invalidated during the cube synchronization process if one or more of the records being updated contributed to the results within that partition.
A cube build removes the entire cache and so automatically performs this operation.
classmethod Reset(pClearCells As %Boolean = 0) as %Status
Stops all DeepSee background agents, clears any pending tasks, and clears the result cache for the current namespace. If pClearCells is true, then the cell cache for the current namespace is also cleared.
This method is provided as a convenience for developers for use on development or test systems.
You should not use this method on production systems as it will have immediate effect on the performance of end user operations.
classmethod Shell() as %Status
Invoke the DeepSee command line shell.
classmethod SynchronizeCube(pCubeName As %String, pVerbose As %Boolean = 0, Output pFactsUpdated As %Integer, pReadCommitted As %Boolean = 1, pCheckReferences As %Boolean = 1, pAsync As %Boolean = 0, ByRef pSynchronizeStatistics As %String = 0) as %Status
For the specified cube, find and apply all changes from the source data that have been made since the last call to this method. If pVerbose is true, then status information is written to the console.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab