IRISLIB database
DeepSee Class Reference

The <class>SYSTEM.DeepSee</class> class provides an interface for the most common DeepSee tasks. More...

Inheritance diagram for DeepSee:
Collaboration diagram for DeepSee:

Static Public Member Functions

_.Library.Status BuildCube (_.Library.String pCubeName, _.Library.Boolean pAsync, _.Library.Boolean pVerbose, _.Library.Boolean pIndexOnly, _.Library.Integer pMaxFacts, _.Library.Boolean pTracking, _.Library.String pBuildStatistics, _.Library.String pFactList)
 The <class>SYSTEM.DeepSee</class> class provides an interface for the most common DeepSee tasks. More...
 
_.Library.Status KillCube (_.Library.String pCubeName)
 Delete all indices and cache values for the given cube.
 
 ListCubes ()
 Display a list of all cubes within this namespace (that are visible to the current user) to the console.
 
_.Library.Status PurgeObsoleteCache (_.Library.String pCubeName)
 Delete all cache that has been invalidated for cube pCubeName. More...
 
_.Library.Status Reset (_.Library.Boolean pClearCells)
 Stops all DeepSee background agents, clears any pending tasks,. More...
 
_.Library.Status Shell ()
 Invoke the DeepSee command line shell.
 
_.Library.Status SynchronizeCube (_.Library.String pCubeName, _.Library.Boolean pVerbose, _.Library.Integer pFactsUpdated, _.Library.Boolean pReadCommitted, _.Library.Boolean pCheckReferences, _.Library.Boolean pAsync, _.Library.String pSynchronizeStatistics)
 For the specified cube, find and apply all changes from the source data that have been made since the. More...
 
- Static Public Member Functions inherited from Help
_.Library.String Help (_.Library.String method)
 This is a helper class that is used by the various SYSTEM classes to provide a Help method. More...
 

Detailed Description

The <class>SYSTEM.DeepSee</class> 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 <class>DeepSee.Utils</class> class.

Member Function Documentation

◆ BuildCube()

_.Library.Status BuildCube ( _.Library.String  pCubeName,
_.Library.Boolean  pAsync,
_.Library.Boolean  pVerbose,
_.Library.Boolean  pIndexOnly,
_.Library.Integer  pMaxFacts,
_.Library.Boolean  pTracking,
_.Library.String  pBuildStatistics,
_.Library.String  pFactList 
)
static

The <class>SYSTEM.DeepSee</class> 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 <class>DeepSee.Utils</class> class.

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.
If the pFactList is supplied the build will only update the columns listed in that fact list. The list must consist of the specific fact names and can have either a comma-delimited or $LB format.

◆ PurgeObsoleteCache()

_.Library.Status PurgeObsoleteCache ( _.Library.String  pCubeName)
static

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.

◆ Reset()

_.Library.Status Reset ( _.Library.Boolean  pClearCells)
static

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.

◆ SynchronizeCube()

_.Library.Status SynchronizeCube ( _.Library.String  pCubeName,
_.Library.Boolean  pVerbose,
_.Library.Integer  pFactsUpdated,
_.Library.Boolean  pReadCommitted,
_.Library.Boolean  pCheckReferences,
_.Library.Boolean  pAsync,
_.Library.String  pSynchronizeStatistics 
)
static

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.
If the pFactList is supplied the build will only update the columns listed in that fact list. The list must consist of the specific fact names and can have either a comma-delimited or $LB format.