A Sandcastle Documented Class Library

# IDataCubeService Interface

Interface for service providing functionality for DataCube objects.

Namespace: Dundas.BI.Entities.DataCubes
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public interface IDataCubeService : IEntityService<DataCube>

    Public Interface IDataCubeService
    	Inherits IEntityService(Of DataCube)

    public interface class IDataCubeService : IEntityService<DataCube^>

    type IDataCubeService =
        interface
            interface IEntityService<DataCube>
        end

The IDataCubeService type exposes the following members.

Methods

| Name | Description
--- | --- | ---
| AddDataInputTransform | Adds a new data input transform to the process definition and saves the data cube.
| AddSelectTransform | Adds a new select transform to the process definition and saves the data cube. The input generates a SelectTransform transform, compatible with the type of the structure referenced by structureId.
| AddTransform | Adds a new transform to the process definition and saves the data cube. No connection are made for this type of operation.
| AnalyzeCubeQueries | Analyzes the specified dataCube to determine which transforms are pushed to the provider for query execution, and flags this transforms accordingly.
| AnalyzeDataCube | Analyzes the data cube transforms if executed in-memory and saves the data cube.
| AppendTransform | Appends the transform in the process definition immediately after the specified OutputConnector and saves the data cube. The transform input is automatically connected to upstream output. If the specified output is already connected to a downstream transform, then the appended transform main output is connected to the downstream transform as well.
| BuildDataWarehouseAsync | Starts the build of the data warehouse for the specified data cube.
| BuildInMemoryCubeAsync | Starts the build of the in-memory cube for the specified data cube.
| ChangeAnalysisElementUniqueName | Changes the unique name for the specified analysis element.
| CheckUserHierarchyCompatibility | Checks if a connector element can be promoted to the specified user hierarchy.
| ClearDataResultCache | Clears all the results based on the specified cube from the data result cache.
| ConfigureCubeStorage(Guid, StorageType, IEnumerable Guid , Boolean, Boolean, Nullable TimeSpan ) | Configures the storage, memory and caching options for the specified data cube.
| ConfigureCubeStorage(Guid, StorageType, IEnumerable Guid , Boolean, Boolean, Nullable TimeSpan , EntitySaveOptions) | Configures the storage, memory and caching options for the specified data cube.
| ConfigureCubeStorage(Guid, StorageType, IEnumerable Guid , Boolean, Boolean, Nullable TimeSpan , Boolean) | Configures the storage, memory and caching options for the specified data cube.
| ConfigureCubeStorage(Guid, StorageType, IEnumerable Guid , Boolean, Boolean, Nullable TimeSpan , EntitySaveOptions, Boolean) | Configures the storage, memory and caching options for the specified data cube.
| ConfigureIncrementalCubeStorage(Guid, StorageType, IEnumerable Guid ) | Configures the incremental storage for the specified data cube.
| ConfigureIncrementalCubeStorage(Guid, StorageType, IEnumerable Guid , Boolean) | Configures the incremental storage for the specified data cube.
| ConnectTransforms | Connects the specified transforms within a data cube.
| DeleteDataCubeJoin(Guid, Guid) | Allows the user to delete the specified join or select transform from the DataCube definition.
| DeleteDataCubeJoin(Guid, Guid, EntitySaveOptions) | Allows the user to delete the specified join or select transform from the DataCube definition.
| GenerateDataCube(Guid, Guid, PersistencePolicy) | Creates and saves a DataCube using a compatible structure as the starting SelectTransform. All the native structure elements are queried. A final ResultTransform is added automatically and connected automatically.
| GenerateDataCube(Guid, Guid, IEnumerable String , PersistencePolicy) | Creates and saves a DataCube using a compatible structure as the starting SelectTransform. A final ResultTransform is added automatically and connected automatically.
| GenerateDataCube(String, Guid, Guid, EntityCreationOptions) | Creates and saves a DataCube using a compatible structure as the starting SelectTransform. All the native structure elements are queried. A final ResultTransform is added automatically and connected automatically.
| GenerateDataCube(Guid, Guid, IEnumerable String , IEnumerable String , PersistencePolicy) | Creates and saves a DataCube using a native structure as the starting SelectTransform. A final ResultTransform is added automatically and connected automatically.
| GenerateDataCube(String, Guid, Guid, IEnumerable String , EntityCreationOptions) | Creates and saves a DataCube using a compatible structure as the starting SelectTransform. A final ResultTransform is added automatically and connected automatically.
| GenerateDataCube(String, Guid, Guid, IEnumerable String , IEnumerable String , EntityCreationOptions) | Creates and saves a DataCube using a compatible structure as the starting SelectTransform. A final ResultTransform is added automatically and connected automatically.
| GenerateDataInputDataCube | Creates and saves a DataCube that contains a single DataInputTransform.
| GenerateExpressionDataCube(Guid, Guid, PersistencePolicy) | Creates and saves a DataCube using an expression based SelectTransform. A final ResultTransform is added automatically and connected automatically.
| GenerateExpressionDataCube(String, Guid, Guid, EntityCreationOptions) | Creates and saves a DataCube using an expression based SelectTransform.
| Get(Guid) | Gets an entity by its ID and revision number.
| Get(String, Guid) | Gets an entity by its name. (Inherited from IEntityService T .)
| Get(Guid, Int64) | Gets an entity by its ID and revision number.
| Get(String, Guid, Int64) | Gets an entity by its name and revision number. (Inherited from IEntityService T .)
| GetDataCubeInfos(IEnumerable Guid , Nullable Guid ) | Return the collection of DataCubeInfo for the specified data cube IDs.
| GetDataCubeInfos(ICollection Guid , Nullable Guid , Nullable StorageType , Nullable JobRunResult ) | Return the collection of DataCubeInfo for the specified project and tenant ID.
| GetDataCubeRelationships | Gets the join relationships used in the definition of the specified DataCube.
| GetSchedule(Guid) | Gets the schedule if a task exists for the data cube.
| GetSchedule(Guid, Nullable Guid ) | Gets the schedule if a task exists for the data cube.
| GetUndoContext | Gets the undo context. (Inherited from IEntityService T .)
| JoinDataCubes | Joins the two specified data cubes for the purpose of providing an enhanced analysis structure for the specified metric set. If the target cube is auto-generated, then the result of the operation is a modified target cube. If the target cube is explicitly defined, then the result of the operation is a new data cube.
| JoinNativeStructure(DataCube, Guid) | Joins the data cube with the specified native structure, select all the elements of the native structure and then saves the data cube.
| JoinNativeStructure(DataCube, Guid, IEnumerable String ) | Joins the data cube with the specified native structure, select the specified elements of the native structure and then saves the data cube.
| ModifyDataCubeJoin(Guid, Guid, JoinOperation, IList String , IList String ) | Allows the user to change the keys for a specified join operation within a DataCube.
| ModifyDataCubeJoin(Guid, Guid, JoinOperation, IList String , IList String , EntitySaveOptions) | Allows the user to change the keys for a specified join operation within a DataCube.
| ModifyDataCubeJoinType | Allows the user to change the relationship type for the specified join Transform in the data cube.
| ModifyDataCubeRelationshipKeys | Allows the user to change the keys for a specified join operation within a DataCube.
| PreviewTransformOutput(Guid, Guid, Int32, Int32, IEnumerable ParameterValue , IEnumerable ConnectorElementSortRule ) | Previews the data from the output of one of the data cube underlying transforms.
| PreviewTransformOutput(DataCube, Guid, Int32, Int32, IEnumerable ParameterValue , IEnumerable ConnectorElementSortRule ) | Previews the data from the output of one of the data cube underlying transforms.
| PreviewTransformStatistics(DataCube, Guid, IEnumerable ParameterValue ) | Previews the statistics for the specified transform.
| PreviewTransformStatistics(DataCube, Guid, IEnumerable Guid , IEnumerable ParameterValue ) | Previews the statistics for the specified transform output elements.
| RemoveSchedule | Deletes any existing schedule for specified the data cube. A schedule will be deleted for the storage job associated with data cube tenant, or for non-tenant job otherwise.
| RemoveTenantCubeOverride | Removes a tenant processing schedule override.
| RemoveTransform | Removes the specified transform from the process definition and saves the data cube. When the current transform has connected inputs and outputs, the process will try to automatically connect upstream transforms to downstream transforms.
| ReplaceElementNames | Replaces element native names in given Select Transform.
| ReplaceStructure(DataCube, Guid, IDataSource, IDictionary String, String ) | Replaces the structure in given Select Transform with new data source.
| ReplaceStructure(DataCube, Guid, NativeStructure, IDictionary String, String ) | Replaces the structure in given Select Transform with new native structure.
| RestoreUndoFrame | Restores the entity to the undo frame. (Inherited from IEntityService T .)
| Rewire | Rewires the specified entity. (Inherited from IEntityService T .)
| Save(T) | Saves the specified entity. (Inherited from IEntityService T .)
| Save(T, String, Guid, EntityCreationOptions) | Saves the specified entity. (Inherited from IEntityService T .)
| Save(T, String, Guid, Boolean) | Saves the specified entity. (Inherited from IEntityService T .)
| ScheduleDataWarehouse(Guid, ScheduleRule) | Creates a scheduled task for warehousing the data cube.
| ScheduleDataWarehouse(Guid, ScheduleRule, Nullable Guid ) | Creates a scheduled task for warehousing the data cube.
| ScheduleDataWarehouseCubes | Configure the data warehousing storage and the referenced cubes processing priorities for the specified data cubes.
| ScheduleDataWarehouseSequenceCubes | Configure a single sequence of data cubes for data warehousing storage. The storage process is executed sequentially for each reference data cube.
| ScheduleInMemoryCube(Guid, ScheduleRule) | Creates a scheduled task to build an in-memory cube for specific data cube. A schedule will be created for the storage job associated with data cube tenant, or for non-tenant job otherwise.
| ScheduleInMemoryCube(Guid, ScheduleRule, Nullable Guid ) | Creates a scheduled task to build an in-memory cube for specific data cube.
| ScheduleInMemoryCubes | Configure the in-memory storage and the referenced cubes processing priorities for the specified data cubes.
| ScheduleInMemorySequenceCubes | Configure a single sequence of data cubes for in-memory storage. The storage process is executed sequentially for each reference data cube.
| ScheduleTenantCubeOverride | Configure a tenant processing schedule override.
| SetupCubeReferencesProcess | Configure the referenced cubes processing priorities for the specified data cubes.
| TryRedo | Tries to redo the last change done to the entity. (Inherited from IEntityService T .)
| TryUndo | Tries to undo the last change done to the entity. (Inherited from IEntityService T .)

Top
See Also

#### Reference

Dundas.BI.Entities.DataCubes Namespace