AggregationDesign Class

Definition

Defines a set of aggregation definitions that can be shared across multiple partitions in a database. This class cannot be inherited.

[System.Runtime.InteropServices.Guid("85599CD4-B502-429b-85E9-51DECA0284C0")]
public sealed class AggregationDesign : Microsoft.AnalysisServices.MajorObject, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject
[<System.Runtime.InteropServices.Guid("85599CD4-B502-429b-85E9-51DECA0284C0")>]
type AggregationDesign = class
    inherit MajorObject
    interface IMajorObject
    interface INamedComponent
    interface IModelComponent
    interface IComponent
    interface IDisposable
    interface ICloneable
Public NotInheritable Class AggregationDesign
Inherits MajorObject
Implements ICloneable, IDisposable, IMajorObject
Inheritance
Attributes
Implements

Constructors

AggregationDesign()

Initializes a new instance of AggregationDesign using the default values.

AggregationDesign(String)

Initializes a new instance of AggregationDesign using the specified name.

AggregationDesign(String, String)

Initializes a new instance of AggregationDesign using the specified name and an identifier.

Fields

MaxIDLength

Specifies the maximum length of the identifier.

(Inherited from NamedComponent)
MaxNameLength

Specifies the maximum length of the name.

(Inherited from NamedComponent)

Properties

Aggregations

Gets the aggregations designed for the AggregationDesign.

Annotations

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

(Inherited from MajorObject)
CreatedTimestamp

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

(Inherited from MajorObject)
Description

Gets or sets the description of major object.

(Inherited from MajorObject)
Dimensions

Gets the dimensions associated with an AggregationDesign.

EstimatedPerformanceGain

Gets or sets the estimated performance gain of a partition (as a percentage increase).

EstimatedRows

Gets or sets the number of estimated rows (average) in the partition associated with the AggregationDesign.

FriendlyName

Gets a user-friendly name for the component.

(Inherited from NamedComponent)
ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
IsLoaded

Gets a value that indicates whether MajorObject have been loaded.

(Inherited from MajorObject)
KeyForCollection

Gets the key used in collections.

(Inherited from NamedComponent)
LastSchemaUpdate

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

(Inherited from MajorObject)
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 MeasureGroup object of the AggregationDesign object.

ParentCube

Gets the parent Cube object of the AggregationDesign object.

ParentDatabase

Gets the parent Database object of the AggregationDesign object.

ParentServer

Gets the parent Server object of the AggregationDesign object.

Site

Gets or sets the site associated with the component.

(Inherited from NamedComponent)
SiteID

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

(Inherited from NamedComponent)

Methods

AddToContainer(IContainer)

Adds the ModelComponent object to the specified container.

(Inherited from ModelComponent)
AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.

(Inherited from ModelComponent)
AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.

(Inherited from ModelComponent)
AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.

(Inherited from ModelComponent)
BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.

(Inherited from ModelComponent)
CancelDesign()

Rollsback the transaction and closes the connection.

Clone()

Returns a clone of the object.

Clone(Boolean)

Creates a new copy of the MajorObject object.

(Inherited from MajorObject)
CopyTo(AggregationDesign)

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

CopyTo(MajorObject, Boolean)

Copies a MajorObject object to the specified destination.

(Inherited from MajorObject)
CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.

(Inherited from ModelComponent)
CopyTo(NamedComponent)

Copies a NamedComponent object to the specified object.

(Inherited from NamedComponent)
DesignAggregations(Double, Double, Int64, Boolean)

Creates aggregations for an aggregation design on the Analysis Services instance.

DesignAggregations(Double, Double, Int64, Boolean, StringCollection)

Creates aggregations for an aggregation design on the Analysis Services instance.

DesignAggregations(TimeSpan, Int32, Double, Int64, StringCollection)

Creates aggregations for an aggregation design on the Analysis Services instance.

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)
FinalizeDesign()

Gets the generated aggregations from engine, rollbacks the transaction, and closes the connection.

GetCreateReferences(Hashtable, Boolean, Boolean)

Gets a Hashtable to create references.

(Inherited from MajorObject)
GetDependents(Hashtable)

Gets the dependents to the specified Hashtable.

(Inherited from MajorObject)
GetDropDependents(Hashtable, Hashtable)

Gets the drop dependents.

(Inherited from MajorObject)
GetReferences(Hashtable, Boolean)

Gets the objects that the MajorObject references.

(Inherited from MajorObject)
GetUpdateOverwrites(Boolean)

Gets the Hashtable object that overwrites the updated MajorObject.

(Inherited from MajorObject)
InitializeDesign()

Connects to engine, starts a transaction, and saves the full parent database.

InitializeDesign(String)

Connects to engine using the specified connection string, starts a transaction, and saves the full parent database.

Refresh()

Updates the object from server definitions.

(Inherited from MajorObject)
Refresh(Boolean)

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

(Inherited from MajorObject)
Refresh(Boolean, RefreshType)

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

(Inherited from MajorObject)
RemoveFromContainer(IContainer)

Removes the ModelComponent object from the specified container.

(Inherited from ModelComponent)
Reset()

Resets the component to its initial state.

(Inherited from NamedComponent)
Submit()

Submits a ModelComponent object.

(Inherited from ModelComponent)
Submit(Boolean)

Submits a ModelComponent object.

(Inherited from ModelComponent)
ToString()

Returns a string representing the named-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(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, ServerEdition)

Validates the object; returns any errors encountered into a collection. Also contains a parameter to enable return of detailed errors.

Validate(ValidationResultCollection)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions)

Indicates whether the MajorObject is valid.

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

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)

Explicit Interface Implementations

ICloneable.Clone()
IDeserializationCallback.OnDeserialization(Object) (Inherited from MajorObject)
IDeserializationStartCallback.OnDeserializationBegin(Object) (Inherited from MajorObject)
IFormattable.ToString(String, IFormatProvider) (Inherited from NamedComponent)
IHostableComponent.Host (Inherited from ModelComponent)
IMajorObject.BaseType
IMajorObject.CreateBody()
IMajorObject.DependsOn(IMajorObject)
IMajorObject.ObjectReference
IMajorObject.Path
IMajorObject.WriteRef(XmlWriter)
IModelComponent.FriendlyPath (Inherited from ModelComponent)
IModelComponent.OwningCollection (Inherited from ModelComponent)

Applies to