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 | |
|---|---|---|
.gif "Public method") |
Cube() | Initializes a new instance of the Cube class using the default values. |
|
Cube(String) | Initializes a new instance of Cube using a name. |
|
Cube(String, String) | Initializes a new instance of the Cube class, using a name and an identifier. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Actions | Gets the actions collection for the cube. |
|
AggregationPrefix | Gets or sets the prefix for aggregations in the cube. |
|
AllMeasures | Gets all measures as an enumeration object. |
|
Annotations | Gets the collection object of all annotations to current object. (Inherited from MajorObject.) |
|
Collation | Gets or sets the collation string for a Cube. |
|
Container | (Inherited from Component.) |
|
CreatedTimestamp | Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.) |
|
CubePermissions | Gets the permissions collection associated with a cube. |
|
DataSource | Gets the DataSource object associated with a Cube. |
|
DataSourceView | Gets the DataSourceView object associated with a Cube. |
|
DefaultMdxScript | Gets the defaultmdxscript object associated with a Cube. |
|
DefaultMeasure | Gets or sets the DefaultMeasure associated with a Cube. |
|
Description | Gets or sets a description string of current object. (Inherited from MajorObject.) |
|
Dimensions | Gets the dimensions collection associated with a Cube. |
|
ErrorConfiguration | Gets or sets the ErrorConfiguration associated with a Cube. |
|
EstimatedRows | Gets or sets the number of EstimatedRows for a Cube. |
.gif "Protected property") |
FriendlyName | Returns a user-friendly name. (Inherited from NamedComponent.) |
|
ID | Gets or sets the identifier of the component. (Inherited from NamedComponent.) |
|
IsLoaded | Infrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.) |
|
KeyForCollection | Returns the key used in collections. (Inherited from NamedComponent.) |
|
Kpis | Gets a collection of Kpis associated with a Cube. |
|
Language | Gets or sets the default Language to use for the Cube. |
|
LastProcessed | Gets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.) |
|
LastSchemaUpdate | Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.) |
|
MdxScripts | Gets a collection of MdxScripts associated with a Cube. |
|
MeasureGroups | Gets a collection of MeasureGroups associated with a Cube. |
|
Name | Gets or sets the name of the component. (Inherited from NamedComponent.) |
|
OwningCollection | Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.) |
|
Parent | Gets the parent Database of the Cube object. |
|
ParentServer | Gets the Server object that is the parent of the Cube. |
|
Perspectives | Gets the perspectives for the cube. |
|
ProactiveCaching | Gets or sets the proactive caching settings for the cube. |
|
ProcessingMode | Gets or sets the index and aggregation settings for cube processing. |
|
ProcessingPriority | Gets or sets the processing priority for the cube. |
|
ScriptCacheProcessingMode | Gets or sets the script cache settings for processing. |
|
ScriptErrorHandlingMode | Gets or sets the script error handling mode. |
|
Site | Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.) |
|
SiteID | Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.) |
|
Source | Gets or sets the source for a relational cube. |
|
State | Gets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.) |
|
StorageLocation | Gets or sets the storage location for the cube. |
|
StorageMode | Gets or sets the storage mode for the cube. |
|
Translations | Gets the translations for the cube. |
|
Visible | Gets or sets a value that indicates whether a cube can be viewed. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AddToContainer | Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.) |
|
AfterInsert | Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.) |
|
AfterMove | Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.) |
|
AfterRemove | Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.) |
|
BeforeRemove | Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.) |
|
CanProcess | Indicates whether the cube can perform the specified processing. (Overrides ProcessableMajorObject.CanProcess(ProcessType).) |
|
Clone() | Creates a new, full copy of an object. |
|
Clone(Boolean) | Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.) |
|
CopyTo(Cube) | Copies a Cube to the specified object. |
|
CopyTo(MajorObject, Boolean) | Copies the object to the specified destination. (Inherited from ProcessableMajorObject.) |
|
CreateObjRef | Security Critical. (Inherited from MarshalByRefObject.) |
|
Dispose | (Inherited from Component.) |
|
Drop() | Removes current object and updates server. (Inherited from MajorObject.) |
|
Drop(DropOptions) | Removes current object and updates server using specified options. (Inherited from MajorObject.) |
|
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) | 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) | 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.) |
|
Equals | (Inherited from Object.) |
|
GetCreateReferences | Infrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.) |
|
GetDependents | Adds the mining structures and subsequent dependants to the specified Hashtable. (Overrides MajorObject.GetDependents(Hashtable).) |
|
GetDropDependents | Infrastructure. Gets the drop dependents. (Inherited from MajorObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
GetReferences | Gets the objects that the cube references. (Overrides MajorObject.GetReferences(Hashtable, Boolean).) |
|
GetType | (Inherited from Object.) |
|
GetUpdateOverwrites | Infrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.) |
|
InitializeLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
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) | 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() | Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, Binding) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, WriteBackTableCreation) | Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Refresh() | Updates current object from server definitions. (Inherited from MajorObject.) |
|
Refresh(Boolean) | Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.) |
|
Refresh(Boolean, RefreshType) | Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.) |
|
RemoveFromContainer | Infrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.) |
|
Submit() | Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.) |
|
Submit(Boolean) | Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.) |
|
ToString | Returns a string containing the name of the component. (Inherited from NamedComponent.) |
|
Update() | Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.) |
|
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) | Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.) |
|
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) | 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) | 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) | Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.) |
|
Validate(ValidationResultCollection) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
|
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(ValidationResultCollection, ValidationOptions) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection, Boolean, ServerEdition) | Determines whether the Cube is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).) |
|
Validate(ValidationResultCollection, ValidationOptions, ServerEdition) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection, Boolean, Boolean, ServerEdition) | Determines whether the Cube is valid. |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Disposed | (Inherited from Component.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICloneable.Clone | Creates a new copy of the object instance. |
|
IDeserializationCallback.OnDeserialization | Runs when the entire object graph has been deserialized. (Inherited from MajorObject.) |
|
IFormattable.ToString | Formats the value of the current instance using the specified format. (Inherited from NamedComponent.) |
|
IDeserializationStartCallback.OnDeserializationBegin | Runs when the entire object graph starts to deserialized. (Inherited from MajorObject.) |
.gif "Private property") |
IHostableComponent.Host | Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.) |
|
IMajorObject.BaseType | Gets the base type implementation of the Cube. |
|
IMajorObject.CreateBody | Creates a new body for the Cube. |
|
IMajorObject.DependsOn | Determines whether the Cube depends on an object. |
|
IMajorObject.ObjectReference | Gets the object reference implementation of the Cube. |
|
IMajorObject.ParentDatabase | Gets the parent database referred by the Cube. |
|
IMajorObject.Path | Gets the path implementation of the Cube. |
|
IMajorObject.WriteRef | Writes a reference for the Cube. |
|
IModelComponent.FriendlyPath | Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.) |
|
IModelComponent.OwningCollection | Gets or sets the collection that owns the current object. (Inherited from ModelComponent.) |
|
IProcessable.LastProcessed | Gets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.) |
|
IProcessable.State | Gets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.) |
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.