• Article

Database Class

Defines a Microsoft SQL Server 2005 Analysis Services (SSAS) 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.Database

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

Syntax

'Declaration
<GuidAttribute("47922F3A-A6AF-4f2a-AE68-8B08E0CF38A8")> _
Public NotInheritable Class Database _
    Inherits ProcessableMajorObject _
    Implements IMajorObject, INamedComponent, IModelComponent, IComponent,  _
    IDisposable, ICloneable, IConnectionStringHolder
'Usage
Dim instance As Database

[GuidAttribute("47922F3A-A6AF-4f2a-AE68-8B08E0CF38A8")]
public sealed class Database : ProcessableMajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable, IConnectionStringHolder

[GuidAttribute(L"47922F3A-A6AF-4f2a-AE68-8B08E0CF38A8")]
public ref class Database sealed : public ProcessableMajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable, IConnectionStringHolder

[<SealedAttribute>]
[<GuidAttribute("47922F3A-A6AF-4f2a-AE68-8B08E0CF38A8")>]
type Database =  
    class
        inherit ProcessableMajorObject
        interface IMajorObject
        interface INamedComponent
        interface IModelComponent
        interface IComponent
        interface IDisposable
        interface ICloneable
        interface IConnectionStringHolder
    end

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

The Database type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property Accounts Gets the collection of account types that are defined in a Database element.
Public property AggregationPrefix Defines the common prefix to be used for aggregation names throughout the associated Database.
Public property Annotations Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public property Assemblies Gets the collection of assemblies associated with a Database.
Protected property CanRaiseEvents (Inherited from Component.)
Public property Collation Gets or sets the collation type for a Database.
Public property CompatibilityLevel
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 Cubes Gets the collection of cubes in a Database.
Public property DatabasePermissions Gets the collection of database permission elements associated with a Database element.
Public property DataSourceImpersonationInfo Gets or sets the impersonation information associated with a Database.
Public property DataSources Gets the collection of data sources associated with a Database.
Public property DataSourceViews Gets the collection of data source views associated with a Database.
Public property DbStorageLocation
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 collection of dimensions associated with a Database.
Public property DismissedValidationResults
Public property DismissedValidationRules
Public property EstimatedSize Gets or sets the read-only estimated size, in bytes, of the parent Database.
Protected property Events (Inherited from Component.)
Protected property FriendlyName (Inherited from NamedComponent.)
Public property ID (Inherited from NamedComponent.)
Public property ImagePath
Public property ImageUniqueID
Public property ImageUrl
Public property ImageVersion
Public property IsLoaded Infrastructure. (Inherited from MajorObject.)
Protected property KeyForCollection (Inherited from NamedComponent.)
Public property Language Gets or sets the language value for a Database.
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 LastUpdate Gets or sets the time of last update for a Database.
Public property MasterDataSourceID Gets or sets the master data source identifier for a Database.
Public property MiningStructures Gets the collection of mining structures associated with a Database.
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 Server of a Database.
Public property ProcessingPriority Gets or sets the processing priority of a Database.
Public property ReadWriteMode
Public property Roles Gets the collection of roles associated with a Database.
Public property Site (Inherited from NamedComponent.)
Public property SiteID (Inherited from NamedComponent.)
Public property State (Inherited from ProcessableMajorObject.)
Public property StorageEngineUsed
Public property Translations Gets the collection of translations associated with a Database.
Public property Visible Gets or sets the Boolean visibility property associated with a Database.

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.)
Public method Backup(String) Provides programmatic access to Backup operations for a Database with file parameter.
Public method Backup(BackupInfo) Provides programmatic access to Backup operations for a Database with BackupInfo parameter.
Public method Backup(String, Boolean) Provides programmatic access to Backup operations for a Database with file and AllowOverWrite parameters.
Public method Backup(String, Boolean, Boolean) Provides programmatic access to Backup operations for a Database with file, AllowOverWrite, and BackupRemotePartitions parameters.
Public method Backup(String, Boolean, Boolean, array<BackupLocation[]) Provides programmatic access to Backup operations for a Database with file, AllowOverWrite, BackupRemotePartitions, and locations parameters.
Public method Backup(String, Boolean, Boolean, array<BackupLocation[], Boolean) Provides programmatic access to Backup operations for a Database with five parameters.
Public method Backup(String, Boolean, Boolean, array<BackupLocation[], Boolean, String) Provides programmatic access to Backup operations for a Database with six parameters.
Protected method BeforeRemove Infrastructure. (Inherited from ModelComponent.)
Public method CanProcess Indicates whether a process type can be processed for a specified Database object. (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(Database) Copies a Database object 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 Detach()
Public method Detach(String)
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 Infrastructure. (Inherited from MajorObject.)
Protected method GetDropDependents Infrastructure. (Inherited from MajorObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Public method GetReferences Infrastructure. (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 LinkDimension(Dimension, String)
Public method LinkDimension(Dimension, String, String)
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.)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICloneable.Clone
Explicit interface implemetationPrivate method IDeserializationCallback.OnDeserialization (Inherited from MajorObject.)
Explicit interface implemetationPrivate method IFormattable.ToString (Inherited from NamedComponent.)
Explicit interface implemetationPrivate property IConnectionStringHolder.ReturnPassword Infrastructure.
Explicit interface implemetationPrivate method IDeserializationStartCallback.OnDeserializationBegin (Inherited from MajorObject.)
Explicit interface implemetationPrivate property IHostableComponent.Host (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IMajorObject.BaseType Infrastructure.
Explicit interface implemetationPrivate method IMajorObject.CreateBody
Explicit interface implemetationPrivate method IMajorObject.DependsOn
Explicit interface implemetationPrivate property IMajorObject.ObjectReference Infrastructure.
Explicit interface implemetationPrivate property IMajorObject.ParentDatabase Infrastructure.
Explicit interface implemetationPrivate property IMajorObject.ParentServer Infrastructure.
Explicit interface implemetationPrivate property IMajorObject.Path Infrastructure.
Explicit interface implemetationPrivate method IMajorObject.WriteRef
Explicit interface implemetationPrivate property IModelComponent.FriendlyPath (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IModelComponent.OwningCollection (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IProcessable.LastProcessed (Inherited from ProcessableMajorObject.)
Explicit interface implemetationPrivate property IProcessable.State (Inherited from ProcessableMajorObject.)

Top

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.