Database Database Database Class

Definition

Defines a MicrosoftAnalysis Services database. This class cannot be inherited.

public ref class Database sealed : Microsoft::AnalysisServices::Core::Database, ICloneable, IDisposable, Microsoft::AnalysisServices::IConnectionStringHolder, Microsoft::AnalysisServices::IMajorObject
[System.ComponentModel.Design.Serialization.DesignerSerializer("Microsoft.AnalysisServices.Project.ComponentModel.DatabaseOnlineSerializer, Microsoft.AnalysisServices.Project, PublicKeyToken=89845dcd8080cc91", "Microsoft.DataWarehouse.Serialization.OnlineComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91")]
[System.ComponentModel.Design.Serialization.DesignerSerializer("Microsoft.DataWarehouse.Serialization.DesignXmlSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91", "Microsoft.DataWarehouse.Serialization.DesignerComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91")]
[System.ComponentModel.Designer("Microsoft.AnalysisServices.Design.DatabaseDesigner,Microsoft.AnalysisServices.Design", typeof(System.ComponentModel.Design.IRootDesigner))]
[System.ComponentModel.DesignerCategory("Designer")]
[System.Runtime.InteropServices.Guid("47922F3A-A6AF-4f2a-AE68-8B08E0CF38A8")]
[System.Xml.Serialization.XmlRoot(Namespace="http://schemas.microsoft.com/analysisservices/2003/engine")]
public sealed class Database : Microsoft.AnalysisServices.Core.Database, ICloneable, IDisposable, Microsoft.AnalysisServices.IConnectionStringHolder, Microsoft.AnalysisServices.IMajorObject
Public NotInheritable Class Database
Inherits Database
Implements ICloneable, IConnectionStringHolder, IDisposable, IMajorObject
Inheritance
Attributes
Implements

Constructors

Database() Database() Database()

Initializes a new instance of Database using the default values.

Database(ModelType, Int32) Database(ModelType, Int32) Database(ModelType, Int32)

Initializes a new instance of the Database object using the model type and compatibility level.

Database(String) Database(String) Database(String)

Initializes a new instance of Database using a name.

Database(String, String) Database(String, String) Database(String, String)

Initializes a new instance of Database using a name and an identifier.

Properties

Accounts Accounts Accounts

Gets the collection of account types that are defined in a Database element.

AggregationPrefix AggregationPrefix AggregationPrefix

Defines the common prefix to be used for aggregation names throughout the associated Database.

Annotations Annotations Annotations

Gets the collection object of all annotations to current object.

(Inherited from MajorObject)
Assemblies Assemblies Assemblies

Gets the collection of assemblies associated with a Database.

Collation Collation Collation

Gets or sets the collation type for a Database.

(Inherited from Database)
CompatibilityLevel CompatibilityLevel CompatibilityLevel

Gets or sets the compatibility level for the database.

(Inherited from Database)
CreatedTimestamp CreatedTimestamp CreatedTimestamp

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

(Inherited from MajorObject)
Cubes Cubes Cubes

Gets the collection of cubes in a Database.

DatabasePermissions DatabasePermissions DatabasePermissions

Gets the collection of database permission elements associated with a Database element.

DataSourceImpersonationInfo DataSourceImpersonationInfo DataSourceImpersonationInfo

Gets or sets the impersonation information associated with a Database.

DataSources DataSources DataSources

Gets the collection of data sources associated with a Database.

DataSourceViews DataSourceViews DataSourceViews

Gets the collection of data source views associated with a Database.

DbStorageLocation DbStorageLocation DbStorageLocation

Gets or sets the database storage location.

(Inherited from Database)
Description Description Description

Gets or sets a description string of current object.

(Inherited from MajorObject)
Dimensions Dimensions Dimensions

Gets the collection of dimensions associated with a Database.

DirectQueryMode DirectQueryMode DirectQueryMode

Contains a read-only value that describes the query mode the current database is using.

DismissedValidationResults DismissedValidationResults DismissedValidationResults

Gets a collection of DismissedValidationResult associated with the Database.

(Inherited from Database)
DismissedValidationRules DismissedValidationRules DismissedValidationRules

Gets a collection of DismissedValidationRule associated with the Database.

(Inherited from Database)
EstimatedSize EstimatedSize EstimatedSize

Gets or sets the read-only estimated size, in bytes, of the parent Database.

(Inherited from Database)
FriendlyName FriendlyName FriendlyName

Returns a user-friendly name.

(Inherited from NamedComponent)
ID ID ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
IHostableComponent.Host IHostableComponent.Host IHostableComponent.Host

Gets or sets the IServiceProvider that is the host of the ModelComponent.

(Inherited from ModelComponent)
ImagePath ImagePath ImagePath

Gets or sets the image path.

(Inherited from Database)
ImageUniqueID ImageUniqueID ImageUniqueID

Gets or sets the image unique identifier.

(Inherited from Database)
ImageUrl ImageUrl ImageUrl

Gets or sets the URL path to an image to display for the database.

(Inherited from Database)
ImageVersion ImageVersion ImageVersion

Gets or sets the version of the image in the database.

(Inherited from Database)
IModelComponent.FriendlyPath IModelComponent.FriendlyPath IModelComponent.FriendlyPath

Gets a friendly path for the ModelComponent.

(Inherited from ModelComponent)
IModelComponent.OwningCollection IModelComponent.OwningCollection IModelComponent.OwningCollection

Gets or sets the collection that owns the current object.

(Inherited from ModelComponent)
IProcessable.LastProcessed IProcessable.LastProcessed IProcessable.LastProcessed

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

(Inherited from ProcessableMajorObject)
IProcessable.State IProcessable.State IProcessable.State

Gets or sets the AnalysisState of this current instance.

(Inherited from ProcessableMajorObject)
IsInTransaction IsInTransaction IsInTransaction

Gets a value that indicates whether the database is in transaction.

IsLoaded IsLoaded IsLoaded

Gets a value that indicates whether MajorObject have been loaded.

(Inherited from MajorObject)
KeyForCollection KeyForCollection KeyForCollection

Returns the key used in collections.

(Inherited from NamedComponent)
Language Language Language

Gets or sets the language value for a Database.

(Inherited from Database)
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)
LastUpdate LastUpdate LastUpdate

Gets or sets the time of last update for a Database.

(Inherited from Database)
MasterDataSourceID MasterDataSourceID MasterDataSourceID

Gets or sets the master data source identifier for a Database.

MiningStructures MiningStructures MiningStructures

Gets the collection of mining structures associated with a Database.

Model Model Model

Gets or sets the model object of the parent database.

ModelType ModelType ModelType

Gets or sets the type of model from which the database was deployed. Expected values include Default (same as multidimensional), Multidimensional, or Tabular.

(Inherited from Database)
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 Server of a Database.

ProcessingPriority ProcessingPriority ProcessingPriority

Gets or sets the processing priority of a Database.

ReadWriteMode ReadWriteMode ReadWriteMode

Gets or sets the ReadWriteMode of the database.

(Inherited from Database)
Roles Roles Roles

Gets the collection of roles associated with a Database.

Site Site Site

Gets or sets the site of the component.

(Inherited from NamedComponent)
SiteID SiteID SiteID

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

(Inherited from NamedComponent)
State State State

Gets or sets the AnalysisState of this current instance.

(Inherited from ProcessableMajorObject)
StorageEngineUsed StorageEngineUsed StorageEngineUsed

Contains a read-only value that describes the storage engine used in the current database.

(Inherited from Database)
Translations Translations Translations

Gets the collection of translations associated with a Database.

(Inherited from Database)
Version Version Version

Gets or sets the database version.

(Inherited from Database)
Visible Visible Visible

Gets or sets the Boolean visibility property associated with a Database.

(Inherited from Database)

Methods

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

Do not reference this member directly in your code. It supports the Analysis Services infrastructure and will be hidden in a future release.

(Inherited from Database)
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)
Backup(BackupInfo) Backup(BackupInfo) Backup(BackupInfo)

Provides programmatic access to Backup operations for a Database with BackupInfo parameter.

(Inherited from Database)
Backup(String) Backup(String) Backup(String)

Provides programmatic access to Backup operations for a Database with file parameter.

(Inherited from Database)
Backup(String, Boolean) Backup(String, Boolean) Backup(String, Boolean)

Provides programmatic access to Backup operations for a Database with file and AllowOverWrite parameters.

(Inherited from Database)
Backup(String, Boolean, Boolean) Backup(String, Boolean, Boolean) Backup(String, Boolean, Boolean)

Provides programmatic access to Backup operations for a Database with file, AllowOverWrite, and BackupRemotePartitions parameters.

(Inherited from Database)
Backup(String, Boolean, Boolean, BackupLocation[]) Backup(String, Boolean, Boolean, BackupLocation[]) Backup(String, Boolean, Boolean, BackupLocation[])

Provides programmatic access to backup operations for a Database with file, AllowOverWrite, BackupRemotePartitions, and locations parameters.

(Inherited from Database)
Backup(String, Boolean, Boolean, BackupLocation[], Boolean) Backup(String, Boolean, Boolean, BackupLocation[], Boolean) Backup(String, Boolean, Boolean, BackupLocation[], Boolean)

Provides programmatic access to backup operations for a Database with five parameters.

(Inherited from Database)
Backup(String, Boolean, Boolean, BackupLocation[], Boolean, String) Backup(String, Boolean, Boolean, BackupLocation[], Boolean, String) Backup(String, Boolean, Boolean, BackupLocation[], Boolean, String)

Provides programmatic access to Backup operations for a Database with six parameters.

(Inherited from Database)
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.

(Inherited from Database)
Clone() Clone() Clone()

Creates a new, full copy of an object.

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

Creates a new copy of the MajorObject object.

(Inherited from MajorObject)
CopyTo(Database) CopyTo(Database) CopyTo(Database)

Copies a Database object to the specified object.

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

Copies the object to the specified destination. Do not reference this member directly in your code. It supports the Analysis Services infrastructure and will be hidden in a future release.

(Inherited from Database)
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)
Detach() Detach() Detach()

Detaches a database that is not in use.

(Inherited from Database)
Detach(String) Detach(String) Detach(String)

Detaches a database with a specified password.

(Inherited from Database)
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)
GetConnectedParentServer() GetConnectedParentServer() GetConnectedParentServer()

Defines the parent server to connect with the database object.

(Inherited from Database)
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)

Gets the dependents to the specified Hashtable.

(Inherited from MajorObject)
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 database references.

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

Gets the Hashtable object that overwrites the updated MajorObject.

(Inherited from MajorObject)
LinkDimension(Dimension, String) LinkDimension(Dimension, String) LinkDimension(Dimension, String)

Links the database to a specified dimension.

LinkDimension(Dimension, String, String) LinkDimension(Dimension, String, String) LinkDimension(Dimension, String, String)

Links the database to a specified dimension.

OnCompatibilityLevelChange(Int32, Int32) OnCompatibilityLevelChange(Int32, Int32) OnCompatibilityLevelChange(Int32, Int32) Inherited from Database
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.

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

Processes the ProcessableMajorObject with the specified process type.

(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.

(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.

(Inherited from ProcessableMajorObject)
Process(ProcessType, IBinding) Process(ProcessType, IBinding) Process(ProcessType, IBinding) 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 current object from server definitions.

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

Updates current object from server definitions and loaded dependent objects if specified.

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

Updates current object from server definitions and loaded dependent objects if specified.

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

Removes a 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 containing the name of the 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, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition)

Determines whether the Database 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()

Creates a new copy of the object instance.

IConnectionStringHolder.ReturnPassword IConnectionStringHolder.ReturnPassword IConnectionStringHolder.ReturnPassword

Gets or sets a value that indicates whether the database returns password.

IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object)

Runs when the entire object graph has been deserialized.

(Inherited from MajorObject)
IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object)

Runs when the entire object graph starts to deserialized.

(Inherited from MajorObject)
IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.

(Inherited from NamedComponent)
IMajorObject.BaseType IMajorObject.BaseType IMajorObject.BaseType

Gets the base type implementation of the Database.

IMajorObject.CreateBody() IMajorObject.CreateBody() IMajorObject.CreateBody()

Creates a new body for the Database.

IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject)

Determines whether the Database depends on an object.

IMajorObject.ObjectReference IMajorObject.ObjectReference IMajorObject.ObjectReference

Gets the object reference implementation of the Database.

IMajorObject.ParentDatabase IMajorObject.ParentDatabase IMajorObject.ParentDatabase

Gets the parent database referred by the Database.

IMajorObject.ParentServer IMajorObject.ParentServer IMajorObject.ParentServer

Gets the parent server referred by the Database.

IMajorObject.Path IMajorObject.Path IMajorObject.Path

Gets the path implementation of the Database.

IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter)

Writes a reference for the Database.

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