Share via

  • Article

Cube Class

Represents a cube from a database. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.AnalysisServices.ModelComponent
        Microsoft.AnalysisServices.NamedComponent
          Microsoft.AnalysisServices.MajorObject
            Microsoft.AnalysisServices.ProcessableMajorObject
              Microsoft.AnalysisServices.Cube

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)

Syntax

'Declaration
<GuidAttribute("127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")> _
Public NotInheritable Class Cube _
    Inherits ProcessableMajorObject _
    Implements IMajorObject, INamedComponent, IModelComponent, IComponent,  _
    IDisposable, ICloneable
'Usage
Dim instance As Cube

[GuidAttribute("127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")]
public sealed class Cube : ProcessableMajorObject, IMajorObject, 
    INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable

[GuidAttribute(L"127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")]
public ref class Cube sealed : public ProcessableMajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

[<SealedAttribute>]
[<GuidAttribute("127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")>]
type Cube =  
    class
        inherit ProcessableMajorObject
        interface IMajorObject
        interface INamedComponent
        interface IModelComponent
        interface IComponent
        interface IDisposable
        interface ICloneable
    end

public final class Cube extends ProcessableMajorObject implements IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable

The Cube type exposes the following members.

Constructors

  Name Description
Public method Cube() Initializes a new instance of the Cube class using the default values.
Public method Cube(String) Initializes a new instance of Cube using a name.
Public method Cube(String, String) Initializes a new instance of the Cube class, using a name and an identifier.

Top

Properties

  Name Description
Public property Actions Gets the actions collection for the cube.
Public property AggregationPrefix Gets or sets the prefix for aggregations in the cube.
Public property AllMeasures Gets all measures as an enumeration object.
Public property Annotations Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
Protected property CanRaiseEvents (Inherited from Component.)
Public property Collation Gets or sets the collation string for a Cube.
Public property Container (Inherited from Component.)
Public property CreatedTimestamp Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public property CubePermissions Gets the permissions collection associated with a cube.
Public property DataSource Gets the DataSource object associated with a Cube.
Public property DataSourceView Gets the DataSourceView object associated with a Cube.
Public property DefaultMdxScript Gets the defaultmdxscript object associated with a Cube.
Public property DefaultMeasure Gets or sets the DefaultMeasure associated with a Cube.
Public property Description Gets or sets a description string of current object. (Inherited from MajorObject.)
Protected property DesignMode (Inherited from Component.)
Public property Dimensions Gets the dimensions collection associated with a Cube.
Public property ErrorConfiguration Gets or sets the ErrorConfiguration associated with a Cube.
Public property EstimatedRows Gets or sets the number of EstimatedRows for a Cube.
Protected property Events (Inherited from Component.)
Protected property FriendlyName (Inherited from NamedComponent.)
Public property ID (Inherited from NamedComponent.)
Public property IsLoaded Infrastructure. (Inherited from MajorObject.)
Protected property KeyForCollection (Inherited from NamedComponent.)
Public property Kpis Gets a collection of Kpis associated with a Cube.
Public property Language Gets or sets the default Language to use for the Cube.
Public property LastProcessed (Inherited from ProcessableMajorObject.)
Public property LastSchemaUpdate Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public property MdxScripts Gets a collection of MdxScripts associated with a Cube.
Public property MeasureGroups Gets a collection of MeasureGroups associated with a Cube.
Public property Name (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Gets the parent Database of the Cube object.
Public property ParentServer Gets the Server object that is the parent of the Cube.
Public property Perspectives Gets the perspectives for the cube.
Public property ProactiveCaching Gets or sets the proactive caching settings for the cube.
Public property ProcessingMode Gets or sets the index and aggregation settings for cube processing.
Public property ProcessingPriority Gets or sets the processing priority for the cube.
Public property ScriptCacheProcessingMode Gets or sets the script cache settings for processing.
Public property ScriptErrorHandlingMode
Public property Site (Inherited from NamedComponent.)
Public property SiteID (Inherited from NamedComponent.)
Public property Source Gets or sets the source for a relational cube.
Public property State (Inherited from ProcessableMajorObject.)
Public property StorageLocation Gets or sets the storage location for the cube.
Public property StorageMode Gets or sets the storage mode for the cube.
Public property Translations Gets the translations for the cube.
Public property Visible Gets or sets a value that indicates whether a cube can be viewed.

Top

Methods

  Name Description
Protected method AddToContainer Infrastructure. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. (Inherited from ModelComponent.)
Protected method BeforeRemove Infrastructure. (Inherited from ModelComponent.)
Public method CanProcess Indicates whether the cube can perform the specified processing. (Overrides ProcessableMajorObject.CanProcess(ProcessType).)
Public method Clone() Creates a new, full copy of an object.
Protected method Clone(Boolean) Infrastructure. (Inherited from MajorObject.)
Public method CopyTo(Cube) Copies a Cube to the specified object.
Protected method CopyTo(ModelComponent) Infrastructure. (Inherited from ModelComponent.)
Protected method CopyTo(NamedComponent) (Inherited from NamedComponent.)
Protected method CopyTo(MajorObject, Boolean) (Inherited from ProcessableMajorObject.)
Public method CreateObjRef (Inherited from MarshalByRefObject.)
Public method Dispose() (Inherited from Component.)
Protected method Dispose(Boolean) (Inherited from Component.)
Public method Drop() Removes current object and updates server. (Inherited from MajorObject.)
Public method Drop(DropOptions) Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public method Drop(DropOptions, XmlaWarningCollection) Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings object. (Inherited from MajorObject.)
Public method Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.)
Public method Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Component.)
Protected method GetCreateReferences Infrastructure. (Inherited from MajorObject.)
Public method GetDependents Adds the mining structures and subsequent dependants to the specified Hashtable. (Overrides MajorObject.GetDependents(Hashtable).)
Protected method GetDropDependents Infrastructure. (Inherited from MajorObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Public method GetReferences Gets the objects that the cube references. (Overrides MajorObject.GetReferences(Hashtable, Boolean).)
Protected method GetService (Inherited from Component.)
Public method GetType (Inherited from Object.)
Public method GetUpdateOverwrites Infrastructure. (Inherited from MajorObject.)
Public method InitializeLifetimeService (Inherited from MarshalByRefObject.)
Public method LinkMeasureGroup(MeasureGroup, String) Generates a regular measure group, but it is set up to point to other measure groups. As parameters, this method takes the measure group (source) you want to link to and a data source identifier.
Public method LinkMeasureGroup(MeasureGroup, String, String) Generates a regular measure group, but it is set up to point to other measure groups. As parameters, this method takes the measure group (source) you want to link to and a data source identifier.
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method Process() (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, Binding) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, WriteBackTableCreation) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) (Inherited from ProcessableMajorObject.)
Public method Refresh() Updates current object from server definitions. (Inherited from MajorObject.)
Public method Refresh(Boolean) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public method Refresh(Boolean, RefreshType) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected method RemoveFromContainer Infrastructure. (Inherited from ModelComponent.)
Protected method Reset (Inherited from NamedComponent.)
Public method Submit() Infrastructure. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. (Inherited from ModelComponent.)
Public method ToString (Inherited from NamedComponent.)
Public method Update() Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode, XmlaWarningCollection) Updates server definition of current object to actual values using the specified options to update dependent objects and reports any warnings from operation. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. If analyzeImpactOnly is true, an impact analysis operation is performed with no update operation. (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection) Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public method Validate(ValidationResultCollection) (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean) Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors. (Inherited from ModelComponent.)
Public method Validate(ValidationResultCollection, ValidationOptions) (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public method Validate(ValidationResultCollection, ValidationOptions, ServerEdition) (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, Boolean, ServerEdition)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Remarks

Cubes are managed from a cubes collection in a database. Cubes are created by adding them to the cubes collection in the database. Cubes are deleted by removing them from the cubes collection in the database.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.