Database Class

  • Article

Defines a Microsoft Analysis Services 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.
Public method Database(ModelType, Int32)

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.
Public property Collation Gets or sets the collation type for a Database.
Public property CompatibilityLevel Gets or sets the compatibility level for the database.
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 Gets or sets the database storage location.
Public property Description Gets or sets a description string of current object. (Inherited from MajorObject.)
Public property Dimensions Gets the collection of dimensions associated with a Database.
Public property DirectQueryMode Contains a read-only value that describes the query mode the current database is using.
Public property DismissedValidationResults Gets a collection of DismissedValidationResult associated with the Database.
Public property DismissedValidationRules Gets a collection of DismissedValidationRule associated with the Database.
Public property EstimatedSize Gets or sets the read-only estimated size, in bytes, of the parent Database.
Protected property FriendlyName Returns a user-friendly name. (Inherited from NamedComponent.)
Public property ID Gets or sets the identifier of the component. (Inherited from NamedComponent.)
Public property ImagePath Gets or sets the image path.
Public property ImageUniqueID Gets or sets the image unique identifier.
Public property ImageUrl Gets or sets the path to an image to display for the database.
Public property ImageVersion Gets or sets the version of the image in the database.
Public property IsLoaded Infrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.)
Protected property KeyForCollection Returns the key used in collections. (Inherited from NamedComponent.)
Public property Language Gets or sets the language value for a Database.
Public property LastProcessed Gets or sets the DateTime on which the object was last processed. (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 ModelType
Public property Name Gets or sets the name of the component. (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 Gets or sets the ReadWriteMode of the database.
Public property Roles Gets the collection of roles associated with a Database.
Public property Site Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public property SiteID Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
Public property State Gets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)
Public property StorageEngineUsed Contains a read-only value that describes the storage engine used in the current database.
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. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (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. Removes the ModelComponent object before the cleanup. (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. Creates a new copy of the MajorObject object. (Inherited from MajorObject.)
Public method CopyTo(Database) Copies a Database object to the specified object.
Protected method CopyTo(MajorObject, Boolean) Copies the object to the specified destination. (Inherited from ProcessableMajorObject.)
Public method CreateObjRef Security Critical. (Inherited from MarshalByRefObject.)
Public method Detach() Detaches a database that is not in use.
Public method Detach(String) Detaches a database with a specified password.
Public method Dispose (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 GetCreateReferences Infrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.)
Public method GetDependents Infrastructure. Gets the dependents to the specified Hashtable. (Inherited from MajorObject.)
Protected method GetDropDependents Infrastructure. Gets the drop dependents. (Inherited from MajorObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService Security Critical. (Inherited from MarshalByRefObject.)
Public method GetReferences Infrastructure. Gets the objects that the database references. (Overrides MajorObject.GetReferences(Hashtable, Boolean).)
Public method GetType (Inherited from Object.)
Public method GetUpdateOverwrites Infrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.)
Public method InitializeLifetimeService Security Critical. (Inherited from MarshalByRefObject.)
Public method LinkDimension(Dimension, String) Links the database to a specified dimension.
Public method LinkDimension(Dimension, String, String) Links the database to a specified dimension.
Public method Process() Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, Binding) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, WriteBackTableCreation) Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) Processes the ProcessableMajorObject with the specified process type. (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. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public method Submit() Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public method ToString Returns a string containing the name of the component. (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) Indicates whether the MajorObject is valid. (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) Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) Determines whether the Database is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public method Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Indicates whether the MajorObject is valid. (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 Creates a new copy of the object instance.
Explicit interface implemetationPrivate method IDeserializationCallback.OnDeserialization Runs when the entire object graph has been deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate method IFormattable.ToString Formats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate property IConnectionStringHolder.ReturnPassword Infrastructure. Gets or sets a value that indicates whether the database returns password.
Explicit interface implemetationPrivate method IDeserializationStartCallback.OnDeserializationBegin Runs when the entire object graph starts to deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate property IHostableComponent.Host Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IMajorObject.BaseType Infrastructure. Gets the base type implementation of the Database.
Explicit interface implemetationPrivate method IMajorObject.CreateBody Creates a new body for the Database.
Explicit interface implemetationPrivate method IMajorObject.DependsOn Determines whether the Database depends on an object.
Explicit interface implemetationPrivate property IMajorObject.ObjectReference Infrastructure. Gets the object reference implementation of the Database.
Explicit interface implemetationPrivate property IMajorObject.ParentDatabase Infrastructure. Gets the parent database referred by the Database.
Explicit interface implemetationPrivate property IMajorObject.ParentServer Infrastructure. Gets the parent server referred by the Database.
Explicit interface implemetationPrivate property IMajorObject.Path Infrastructure. Gets the path implementation of the Database.
Explicit interface implemetationPrivate method IMajorObject.WriteRef Writes a reference for the Database.
Explicit interface implemetationPrivate property IModelComponent.FriendlyPath Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IModelComponent.OwningCollection Gets or sets the collection that owns the current object. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IProcessable.LastProcessed Gets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Explicit interface implemetationPrivate property IProcessable.State Gets or sets the AnalysisState of this current instance. (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.

See Also

Reference

Microsoft.AnalysisServices Namespace