ICubeCacheSaver

The ICubeCacheSaver interface contains properties and methods that are used to work with the storage of the cached data of the specified cube.

Comments

The use of caching in the cache storage is available in the repositories based on the following DBMS:

Starting from Foresight Analytics Platform 9.0, a cached data warehouse is not used. Instead of it In-Memory based data caching is used.

To work with cached data warehouse, one should force disable the In-Memory caching by setting in the registry or in the settings.xml file the UseInMem parameter to False.

When using later releases of Foresight Analytics Platform one may require to update the cached cube data warehouse structure. To do this, open the object described by the ICubeCacheSaver interface for edit and resave it.

Sub UpdateCacheSaver;
Var
    MB: IMetabase;
    MDesc, CacheDesc: IMetabaseObjectDescriptor;
    CacheSaver: ICubeCacheSaver;
Begin
    MB := MetabaseClass.Active;
    MDesc := MB.ItemById("<ID>");
    CacheDesc := GetCache(MDesc);
    If CacheDesc <> Null Then
        CacheSaver := CacheDesc.Edit As ICubeCacheSaver;
        (CacheSaver As IMetabaseObject).Save;
    End If;
End Sub UpdateCacheSaver;

Function GetCache(MObj: IMetabaseObjectDescriptor): IMetabaseObjectDescriptor;
Var
    Desc: IMetabaseObjectDescriptor;
Begin
    For Each Desc In MObj.Children Do
        If Desc.ClassId = MetabaseObjectClass.KE_CLASS_CUBE_CACHE_SAVER Then
            Return Desc;
        End If;
    End For;
    Return Null;
End Function GetCache;

Properties

Property name

Brief description

CheckSelection

The CheckSelection property determines whether to check the selection, by which cache is saved.

Database

The Database property determines the database, to which it is necessary to save the cache of the cube

Global

The Global property determines whether common cache is used for the cube on working of several users.

PartitionDimensionKey

The PartitionDimensionKey property determines a dimension key for the specified cube instance, in which the selection will be divided during simultaneous cache update.

Methods

Method name

Brief description

Clear

The Clear method clears cache of the specified cube display version.

ClearAllGlobalCaches

The ClearAllGlobalCaches method removes cached data of all cubes from the global cache.

ClearGlobalCache

The ClearGlobalCache method removes cached data of the current cube from the global cache.

FindAndLoadCache

The FindAndLoadCache method finds and loads cache of the cube for the specified cube display version with the specified values of the parameters into the specified matrix and returns whether the corresponding cache is in the database.

GetGlobalCache

The GetGlobalCache method returns the cube data matrix obtained from cache according to passed cube cache parameters.

GetGlobalWriteLock

The GetGlobalWriteLock method returns the object that controls write lock of cached data for the specified cube parameters.

GetItemsFromDatabase

The GetItemsFromDatabase method, according to the specified parameters, gets cache instances from caxche storage in DBMS.

GetItemsFromMemory

The GetItemsFromMemory method, according to the specified parameters, gets cache instances from computer RAM.

SaveCache

The SaveCache method saves cache for the specified cube display version by the specified parameters.

SaveCacheCustom

The SaveCacheCustom method saves cache according to the specified parameters and specified custom label.

SaveCube

The SaveCache method saves cache for the specified cube display version by the specified parameters.

ICubeCacheSaver

Description

Comments

Properties

Methods