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 (24.3.0.1000)
Syntax
public interface IDataCubeService : IEntityService<DataCube>

The IDataCubeService type exposes the following members.

Methods
  NameDescription
Public methodAddDataInputTransform
Adds a new data input transform to the process definition and saves the data cube.
Public methodAddSelectTransform
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.
Public methodAddTransform
Adds a new transform to the process definition and saves the data cube. No connection are made for this type of operation.
Public methodAnalyzeCubeQueries
Analyzes the specified dataCube to determine which transforms are pushed to the provider for query execution, and flags this transforms accordingly.
Public methodAnalyzeDataCube
Analyzes the data cube transforms if executed in-memory and saves the data cube.
Public methodAppendTransform
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.
Public methodCode exampleBuildDataWarehouseAsync
Starts the build of the data warehouse for the specified data cube.
Public methodBuildInMemoryCubeAsync
Starts the build of the in-memory cube for the specified data cube.
Public methodChangeAnalysisElementUniqueName
Changes the unique name for the specified analysis element.
Public methodCheckUserHierarchyCompatibility
Checks if a connector element can be promoted to the specified user hierarchy.
Public methodClearDataResultCache
Clears all the results based on the specified cube from the data result cache.
Public methodConfigureCubeStorage(Guid, StorageType, IEnumerableGuid, Boolean, Boolean, NullableTimeSpan)
Configures the storage, memory and caching options for the specified data cube.
Public methodConfigureCubeStorage(Guid, StorageType, IEnumerableGuid, Boolean, Boolean, NullableTimeSpan, EntitySaveOptions)
Configures the storage, memory and caching options for the specified data cube.
Public methodConfigureCubeStorage(Guid, StorageType, IEnumerableGuid, Boolean, Boolean, NullableTimeSpan, Boolean)
Configures the storage, memory and caching options for the specified data cube.
Public methodConfigureCubeStorage(Guid, StorageType, IEnumerableGuid, Boolean, Boolean, NullableTimeSpan, EntitySaveOptions, Boolean)
Configures the storage, memory and caching options for the specified data cube.
Public methodConfigureIncrementalCubeStorage(Guid, StorageType, IEnumerableGuid)
Configures the incremental storage for the specified data cube.
Public methodConfigureIncrementalCubeStorage(Guid, StorageType, IEnumerableGuid, Boolean)
Configures the incremental storage for the specified data cube.
Public methodConfigurePlaceholderStructureParameter
Configures the specified a PlaceholderStructureParameter to enable switching the native structure being queried by the specified transform.
Public methodConnectTransforms
Connects the specified transforms within a data cube.
Public methodCreateSelectStructureParameter
Creates a Parameter to enable switching the native structure being queried by the specified transform.
Public methodDataCubeInfoQuery
Queries for DataCubeInfo objects according to the specified criteria.
Public methodDeleteDataCubeJoin(Guid, Guid)
Allows the user to delete the specified join or select transform from the DataCube definition.
Public methodDeleteDataCubeJoin(Guid, Guid, EntitySaveOptions)
Allows the user to delete the specified join or select transform from the DataCube definition.
Public methodGenerateDataCube(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.
Public methodGenerateDataCube(Guid, Guid, IEnumerableString, PersistencePolicy)
Creates and saves a DataCube using a compatible structure as the starting SelectTransform. A final ResultTransform is added automatically and connected automatically.
Public methodGenerateDataCube(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.
Public methodGenerateDataCube(Guid, Guid, IEnumerableString, IEnumerableString, PersistencePolicy)
Creates and saves a DataCube using a native structure as the starting SelectTransform. A final ResultTransform is added automatically and connected automatically.
Public methodGenerateDataCube(String, Guid, Guid, IEnumerableString, EntityCreationOptions)
Creates and saves a DataCube using a compatible structure as the starting SelectTransform. A final ResultTransform is added automatically and connected automatically.
Public methodGenerateDataCube(String, Guid, Guid, IEnumerableString, IEnumerableString, EntityCreationOptions)
Creates and saves a DataCube using a compatible structure as the starting SelectTransform. A final ResultTransform is added automatically and connected automatically.
Public methodGenerateDataInputDataCube
Creates and saves a DataCube that contains a single DataInputTransform.
Public methodGenerateExpressionDataCube(Guid, Guid, PersistencePolicy)
Creates and saves a DataCube using an expression based SelectTransform. A final ResultTransform is added automatically and connected automatically.
Public methodGenerateExpressionDataCube(String, Guid, Guid, EntityCreationOptions)
Creates and saves a DataCube using an expression based SelectTransform.
Public methodGet(Guid)
Gets an entity by its ID and revision number.
Public methodGet(Guid, EntityGetOptions)
Gets an entity by its ID and revision number.
(Inherited from IEntityServiceT.)
Public methodGet(String, Guid)
Gets an entity by its name.
(Inherited from IEntityServiceT.)
Public methodGet(Guid, Int64)
Gets an entity by its ID and revision number.
Public methodGet(Guid, Int64, EntityGetOptions)
Gets an entity by its ID and revision number.
(Inherited from IEntityServiceT.)
Public methodGet(String, Guid, EntityGetOptions)
Gets an entity by its name.
(Inherited from IEntityServiceT.)
Public methodGet(String, Guid, Int64)
Gets an entity by its name and revision number.
(Inherited from IEntityServiceT.)
Public methodGet(String, Guid, Int64, EntityGetOptions)
Gets an entity by its name and revision number.
(Inherited from IEntityServiceT.)
Public methodGetDataCubeInfos(IEnumerableGuid, NullableGuid)
Return the collection of DataCubeInfo for the specified data cube IDs.
Public methodGetDataCubeInfos(ICollectionGuid, NullableGuid, NullableStorageType, NullableJobRunResult)
Public methodGetDataCubeRelationships
Gets the join relationships used in the definition of the specified DataCube.
Public methodGetSchedule(Guid)
Gets the schedule if a task exists for the data cube.
Public methodGetSchedule(Guid, NullableGuid)
Gets the schedule if a task exists for the data cube.
Public methodGetUndoContext
Gets the undo context.
(Inherited from IEntityServiceT.)
Public methodIsTenantWarehouseScheduleSupported
Gets a value indicating whether a tenant-specific schedule is allowed for the specified data cube.
Public methodJoinDataCubes
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.
Public methodJoinNativeStructure(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.
Public methodJoinNativeStructure(DataCube, Guid, IEnumerableString)
Joins the data cube with the specified native structure, selects the specified elements of the native structure and then saves the data cube.
Public methodModifyDataCubeJoin(Guid, Guid, JoinOperation, IListString, IListString)
Allows the user to change the keys for a specified join operation within a DataCube.
Public methodModifyDataCubeJoin(Guid, Guid, JoinOperation, IListString, IListString, EntitySaveOptions)
Allows the user to change the keys for a specified join operation within a DataCube.
Public methodModifyDataCubeJoinType
Allows the user to change the relationship type for the specified join Transform in the data cube.
Public methodModifyDataCubeRelationshipKeys
Allows the user to change the keys for a specified join operation within a DataCube.
Public methodPreviewTransformOutput(Guid, Guid, Int32, Int32, IEnumerableParameterValue, IEnumerableConnectorElementSortRule)
Previews the data from the output of one of the data cube underlying transforms.
Public methodPreviewTransformOutput(DataCube, Guid, Int32, Int32, IEnumerableParameterValue, IEnumerableConnectorElementSortRule)
Previews the data from the output of one of the data cube underlying transforms.
Public methodPreviewTransformStatistics(DataCube, Guid, IEnumerableParameterValue)
Previews the statistics for the specified transform.
Public methodPreviewTransformStatistics(DataCube, Guid, IEnumerableGuid, IEnumerableParameterValue)
Previews the statistics for the specified transform output elements.
Public methodProcessNativeStructure(DataCube, Guid)
Adds the specified native structure to the cube, either through a join or a time alignment union operation, select all the elements of the native structure and then saves the data cube. If the relationship keys are DateTime fields, the operation is a union, otherwise it is a standard join.
Public methodProcessNativeStructure(DataCube, Guid, IEnumerableString)
Adds the specified native structure to the cube, either through a join or a time alignment union operation, selects the specified elements of the native structure and then saves the data cube. If the relationship keys are DateTime fields, the operation is a union, otherwise it is a standard join.
Public methodRemoveSchedule
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.
Public methodRemoveTransform
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.
Public methodReplaceDataConnector
Replaces the data connector in a given Manual Select Transform with a new data connector.
Public methodReplaceElementNames
Replaces element native names in given Select Transform.
Public methodReplaceStructure(DataCube, Guid, IDataSource, IDictionaryString, String)
Replaces the structure in given Select Transform with new data source.
Public methodReplaceStructure(DataCube, Guid, NativeStructure, IDictionaryString, String)
Replaces the structure in given Select Transform with new native structure.
Public methodRestoreUndoFrame
Restores the entity to the undo frame.
(Inherited from IEntityServiceT.)
Public methodRewire
Rewires the specified entity.
(Inherited from IEntityServiceT.)
Public methodSave(T)
Saves the specified entity.
(Inherited from IEntityServiceT.)
Public methodSave(T, String, Guid, EntityCreationOptions)
Saves the specified entity.
(Inherited from IEntityServiceT.)
Public methodSave(T, String, Guid, Boolean)
Saves the specified entity.
(Inherited from IEntityServiceT.)
Public methodScheduleDataWarehouse(Guid, ScheduleRule)
Creates a scheduled task for warehousing the data cube.
Public methodScheduleDataWarehouse(Guid, ScheduleRule, NullableGuid)
Creates a scheduled task for warehousing the data cube.
Public methodScheduleDataWarehouseCubes
Configure the data warehousing storage and the referenced cubes processing priorities for the specified data cubes.
Public methodScheduleDataWarehouseSequenceCubes
Configure a single sequence of data cubes for data warehousing storage. The storage process is executed sequentially for each reference data cube.
Public methodScheduleInMemoryCube(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.
Public methodScheduleInMemoryCube(Guid, ScheduleRule, NullableGuid)
Creates a scheduled task to build an in-memory cube for specific data cube.
Public methodScheduleInMemoryCubes
Configure the in-memory storage and the referenced cubes processing priorities for the specified data cubes.
Public methodScheduleInMemorySequenceCubes
Configure a single sequence of data cubes for in-memory storage. The storage process is executed sequentially for each reference data cube.
Public methodScheduleTenantCubeOverride
Configure a tenant processing schedule override.
Public methodSetupCubeReferencesProcess
Configure the referenced cubes processing priorities for the specified data cubes.
Public methodTryRedo
Tries to redo the last change done to the entity.
(Inherited from IEntityServiceT.)
Public methodTryUndo
Tries to undo the last change done to the entity.
(Inherited from IEntityServiceT.)
Top
See Also