Cube Cube Cube Class

Definition

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

[System.Runtime.InteropServices.Guid("127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")]
public sealed class Cube : Microsoft.AnalysisServices.ProcessableMajorObject, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject
type Cube = class
    inherit ProcessableMajorObject
    interface IMajorObject
    interface INamedComponent
    interface IModelComponent
    interface IComponent
    interface IDisposable
    interface ICloneable
Public NotInheritable Class Cube
Inherits ProcessableMajorObject
Implements ICloneable, IDisposable, IMajorObject
Inheritance
Attributes
Implements

Constructors

Cube() Cube() Cube()

Initializes a new instance of the Cube class using the default values.

Cube(String) Cube(String) Cube(String)

Initializes a new instance of Cube using the specified name.

Cube(String, String) Cube(String, String) Cube(String, String)

Initializes a new instance of the Cube class, using the specified name and identifier.

Properties

Actions Actions Actions

Gets the actions collection for the cube.

AggregationPrefix AggregationPrefix AggregationPrefix

Gets or sets the prefix for aggregations in the cube.

AllMeasures AllMeasures AllMeasures

Gets all measures as an enumeration object.

Annotations Annotations Annotations

Gets the collection of all annotations associated with the major object.

(Inherited from MajorObject)
Collation Collation Collation

Gets or sets the collation for a Cube.

CreatedTimestamp CreatedTimestamp CreatedTimestamp

Gets or sets the date and time of the creation of the object.

(Inherited from MajorObject)
CubePermissions CubePermissions CubePermissions

Gets the collection of permissions associated with a cube.

DataSource DataSource DataSource

Gets the DataSource object associated with a Cube.

DataSourceView DataSourceView DataSourceView

Gets the DataSourceView object associated with a Cube.

DefaultMdxScript DefaultMdxScript DefaultMdxScript

Gets the default MdxScript object associated with a Cube.

DefaultMeasure DefaultMeasure DefaultMeasure

Gets or sets the DefaultMeasure associated with a Cube.

Description Description Description

Gets or sets the description of major object.

(Inherited from MajorObject)
Dimensions Dimensions Dimensions

Gets the dimensions collection associated with a Cube.

ErrorConfiguration ErrorConfiguration ErrorConfiguration

Gets or sets the ErrorConfiguration associated with a Cube.

EstimatedRows EstimatedRows EstimatedRows

Gets or sets the number of EstimatedRows for a Cube.

FriendlyName FriendlyName FriendlyName

Gets a user-friendly name for the component.

(Inherited from NamedComponent)
ID ID ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
IHostableComponent.Host IHostableComponent.Host IHostableComponent.Host Inherited from ModelComponent
IModelComponent.FriendlyPath IModelComponent.FriendlyPath IModelComponent.FriendlyPath Inherited from ModelComponent
IModelComponent.OwningCollection IModelComponent.OwningCollection IModelComponent.OwningCollection Inherited from ModelComponent
IProcessable.LastProcessed IProcessable.LastProcessed IProcessable.LastProcessed Inherited from ProcessableMajorObject
IProcessable.State IProcessable.State IProcessable.State Inherited from ProcessableMajorObject
IsLoaded IsLoaded IsLoaded

Gets a value that indicates whether MajorObject have been loaded.

(Inherited from MajorObject)
KeyForCollection KeyForCollection KeyForCollection

Gets the key used in collections.

(Inherited from NamedComponent)
Kpis Kpis Kpis

Gets a collection of Kpis associated with a Cube.

Language Language Language

Gets or sets the default Language to use for the Cube.

LastProcessed LastProcessed LastProcessed

Gets or sets the DateTime on which the object was last processed.

(Inherited from ProcessableMajorObject)
LastSchemaUpdate LastSchemaUpdate LastSchemaUpdate

Gets or sets the date and time when current object schema was last updated.

(Inherited from MajorObject)
MdxScripts MdxScripts MdxScripts

Gets a collection of MdxScripts associated with a Cube.

MeasureGroups MeasureGroups MeasureGroups

Gets a collection of MeasureGroups associated with a Cube.

Name Name Name

Gets or sets the name of the component.

(Inherited from NamedComponent)
OwningCollection OwningCollection OwningCollection

Gets or sets the collection that contains the ModelComponent.

(Inherited from ModelComponent)
Parent Parent Parent

Gets the parent Database object of the Cube object.

ParentServer ParentServer ParentServer

Gets the parent Server object of the Cube object.

Perspectives Perspectives Perspectives

Gets the perspectives for the cube.

ProactiveCaching ProactiveCaching ProactiveCaching

Gets or sets the proactive caching settings for the cube.

ProcessingMode ProcessingMode ProcessingMode

Gets or sets the index and aggregation settings for cube processing.

ProcessingPriority ProcessingPriority ProcessingPriority

Gets or sets the processing priority for the cube.

ScriptCacheProcessingMode ScriptCacheProcessingMode ScriptCacheProcessingMode

Gets or sets the script cache settings for processing.

ScriptErrorHandlingMode ScriptErrorHandlingMode ScriptErrorHandlingMode

Gets or sets the script error handling mode.

Site Site Site

Gets or sets the site associated with the component.

(Inherited from NamedComponent)
SiteID SiteID SiteID

Gets or sets the identifier for the site associated with the component.

(Inherited from NamedComponent)
Source Source Source

Gets or sets the source for a relational cube.

State State State

Gets or sets the AnalysisState of this current instance.

(Inherited from ProcessableMajorObject)
StorageLocation StorageLocation StorageLocation

Gets or sets the storage location for the cube.

StorageMode StorageMode StorageMode

Gets or sets the storage mode for the cube.

Translations Translations Translations

Gets the translations for the cube.

Visible Visible Visible

Gets or sets a value that indicates whether a cube can be viewed.

Methods

AddToContainer(IContainer) AddToContainer(IContainer) AddToContainer(IContainer)

Adds the ModelComponent object to the specified container.

(Inherited from ModelComponent)
AfterInsert(Int32) AfterInsert(Int32) AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.

(Inherited from ModelComponent)
AfterMove(Int32, Int32) AfterMove(Int32, Int32) AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.

(Inherited from ModelComponent)
AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.

(Inherited from ModelComponent)
BeforeRemove(Boolean) BeforeRemove(Boolean) BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.

(Inherited from ModelComponent)
CanProcess(ProcessType) CanProcess(ProcessType) CanProcess(ProcessType)

Indicates whether the cube can perform the specified processing.

Clone() Clone() Clone()

Returns a clone of the object.

Clone(Boolean) Clone(Boolean) Clone(Boolean)

Creates a new copy of the MajorObject object.

(Inherited from MajorObject)
CopyTo(Cube) CopyTo(Cube) CopyTo(Cube)

Copies the content of this object to another object (the destination).

CopyTo(MajorObject, Boolean) CopyTo(MajorObject, Boolean) CopyTo(MajorObject, Boolean)

Copies the object to the specified destination.

(Inherited from ProcessableMajorObject)
CopyTo(ModelComponent) CopyTo(ModelComponent) CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.

(Inherited from ModelComponent)
CopyTo(NamedComponent) CopyTo(NamedComponent) CopyTo(NamedComponent)

Copies a NamedComponent object to the specified object.

(Inherited from NamedComponent)
Drop() Drop() Drop()

Removes current object and updates server.

(Inherited from MajorObject)
Drop(DropOptions) Drop(DropOptions) Drop(DropOptions)

Removes current object and updates server using specified options.

(Inherited from MajorObject)
Drop(DropOptions, XmlaWarningCollection) Drop(DropOptions, XmlaWarningCollection) 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)
Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) 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)
Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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)
GetCreateReferences(Hashtable, Boolean, Boolean) GetCreateReferences(Hashtable, Boolean, Boolean) GetCreateReferences(Hashtable, Boolean, Boolean)

Gets a Hashtable to create references.

(Inherited from MajorObject)
GetDependents(Hashtable) GetDependents(Hashtable) GetDependents(Hashtable)

Adds the subsequent dependants to the specified Hashtable.

GetDropDependents(Hashtable, Hashtable) GetDropDependents(Hashtable, Hashtable) GetDropDependents(Hashtable, Hashtable)

Gets the drop dependents.

(Inherited from MajorObject)
GetReferences(Hashtable, Boolean) GetReferences(Hashtable, Boolean) GetReferences(Hashtable, Boolean)

Gets the objects that the cube references.

GetUpdateOverwrites(Boolean) GetUpdateOverwrites(Boolean) GetUpdateOverwrites(Boolean)

Gets the Hashtable object that overwrites the updated MajorObject.

(Inherited from MajorObject)
LinkMeasureGroup(MeasureGroup, String) LinkMeasureGroup(MeasureGroup, String) 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.

LinkMeasureGroup(MeasureGroup, String, String) LinkMeasureGroup(MeasureGroup, String, String) 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.

Process() Process() Process()

Processes the ProcessableMajorObject.

(Inherited from ProcessableMajorObject)
Process(ProcessType) Process(ProcessType) Process(ProcessType)

Processes the ProcessableMajorObject with the specified process type.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration) Process(ProcessType, ErrorConfiguration) Process(ProcessType, ErrorConfiguration)

Processes the ProcessableMajorObject with the specified process type and error handling configuration.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection)

Processes the ProcessableMajorObject with the specified process type, error handling configuration and warnings.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)

Processes the ProcessableMajorObject with the specified process type, error handling configuration, warnings and impact details.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)

Processes the ProcessableMajorObject with the specified process type, error handling configuration, warnings and impact details.

(Inherited from ProcessableMajorObject)
Process(ProcessType, IBinding) Process(ProcessType, IBinding) Process(ProcessType, IBinding)

Processes the ProcessableMajorObject with the specified process type and binding.

(Inherited from ProcessableMajorObject)
Process(ProcessType, WriteBackTableCreation) Process(ProcessType, WriteBackTableCreation) Process(ProcessType, WriteBackTableCreation)

Processes the ProcessableMajorObject with the specified process type and writeback option.

(Inherited from ProcessableMajorObject)
Refresh() Refresh() Refresh()

Updates the object from server definitions.

(Inherited from MajorObject)
Refresh(Boolean) Refresh(Boolean) Refresh(Boolean)

Updates the object from server definitions, as well as loaded dependent objects [if specified].

(Inherited from MajorObject)
Refresh(Boolean, RefreshType) Refresh(Boolean, RefreshType) Refresh(Boolean, RefreshType)

Updates the object from server definitions, as well as loaded dependent objects [if specified].

(Inherited from MajorObject)
RemoveFromContainer(IContainer) RemoveFromContainer(IContainer) RemoveFromContainer(IContainer)

Removes the ModelComponent object from the specified container.

(Inherited from ModelComponent)
Reset() Reset() Reset()

Resets the component to its initial state.

(Inherited from NamedComponent)
Submit() Submit() Submit()

Submits a ModelComponent object.

(Inherited from ModelComponent)
Submit(Boolean) Submit(Boolean) Submit(Boolean)

Submits a ModelComponent object.

(Inherited from ModelComponent)
ToString() ToString() ToString()

Returns a string representing the named-component.

(Inherited from NamedComponent)
Update() Update() Update()

Updates server definition of current object to actual values using the default values to update dependent objects.

(Inherited from MajorObject)
Update(UpdateOptions) Update(UpdateOptions) Update(UpdateOptions)

Updates server definition of current object to actual values using the specified options to update dependent objects.

(Inherited from MajorObject)
Update(UpdateOptions, UpdateMode) Update(UpdateOptions, UpdateMode) Update(UpdateOptions, UpdateMode)

Updates server definition of current object to actual values using the specified options to update dependent objects.

(Inherited from MajorObject)
Update(UpdateOptions, UpdateMode, XmlaWarningCollection) Update(UpdateOptions, UpdateMode, XmlaWarningCollection) 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)
Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) 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)
Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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)
Validate(ValidationErrorCollection) Validate(ValidationErrorCollection) Validate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.

(Inherited from ModelComponent)
Validate(ValidationErrorCollection, Boolean) Validate(ValidationErrorCollection, Boolean) 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)
Validate(ValidationErrorCollection, Boolean, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, Boolean, ServerEdition)

Determines whether the Cube is valid.

Validate(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition)

Determines whether the Cube is valid.

Validate(ValidationResultCollection) Validate(ValidationResultCollection) Validate(ValidationResultCollection)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions) Validate(ValidationResultCollection, ValidationOptions) Validate(ValidationResultCollection, ValidationOptions)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Validate(ValidationResultCollection, ValidationOptions, ServerEdition)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)

Explicit Interface Implementations

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()
IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) Inherited from MajorObject
IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) Inherited from MajorObject
IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) Inherited from NamedComponent
IMajorObject.BaseType IMajorObject.BaseType IMajorObject.BaseType
IMajorObject.CreateBody() IMajorObject.CreateBody() IMajorObject.CreateBody()
IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject)
IMajorObject.ObjectReference IMajorObject.ObjectReference IMajorObject.ObjectReference
IMajorObject.ParentDatabase IMajorObject.ParentDatabase IMajorObject.ParentDatabase
IMajorObject.Path IMajorObject.Path IMajorObject.Path
IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter)

Fields

MaxIDLength MaxIDLength MaxIDLength

Specifies the maximum length of the identifier.

(Inherited from NamedComponent)
MaxNameLength MaxNameLength MaxNameLength

Specifies the maximum length of the name.

(Inherited from NamedComponent)

Applies to