Database Class

Reference

Definition

Namespace:: Microsoft.AnalysisServices

Assembly:: Microsoft.AnalysisServices.dll

Package:: Microsoft.AnalysisServices v19.86.2.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

[System.Runtime.InteropServices.Guid("47922F3A-A6AF-4f2a-AE68-8B08E0CF38A8")]
public sealed class Database : Microsoft.AnalysisServices.Core.Database, ICloneable, IDisposable, Microsoft.AnalysisServices.IConnectionStringHolder, Microsoft.AnalysisServices.IMajorObject

[<System.Runtime.InteropServices.Guid("47922F3A-A6AF-4f2a-AE68-8B08E0CF38A8")>]
type Database = class
    inherit Database
    interface IMajorObject
    interface INamedComponent
    interface IModelComponent
    interface IComponent
    interface IDisposable
    interface ICloneable
    interface IConnectionStringHolder

Public NotInheritable Class Database
Inherits Database
Implements ICloneable, IConnectionStringHolder, IDisposable, IMajorObject

Inheritance: Component

ModelComponent

NamedComponent

MajorObject

ProcessableMajorObject

Database
Database

Attributes: GuidAttribute

Implements: IConnectionStringHolder IMajorObject IModelComponent INamedComponent IComponent ICloneable IDisposable

Constructors

Database()	Initializes a new instance of a Tabular Database using the default values.
Database(ModelType, Int32)	Initializes a new instance of a Tabular Database object using the model type and compatibility level.
Database(String, String)	Initializes a new instance of a Tabular Database using a name and an identifier.
Database(String)	Initializes a new instance of a Tabular Database using a name.

Fields

MaxIDLength	Specifies the maximum length of the identifier. (Inherited from NamedComponent)
MaxNameLength	Specifies the maximum length of the name. (Inherited from NamedComponent)

Properties

Accounts	Gets the collection of account types that are defined in a Database element.
AggregationPrefix	Gets or sets the common prefix to be used for aggregation names throughout the associated Database.
Annotations	Gets the collection of all annotations associated with the major object. (Inherited from MajorObject)
Assemblies	Gets the collection of assemblies associated with a Database.
Collation	Gets or sets the collation type for a Database. (Inherited from Database)
CompatibilityLevel	Gets or sets the compatibility level for the database. (Inherited from Database)
CompatibilityMode	Gets or sets the compatibility level for the database. (Inherited from Database)
CreatedTimestamp	Gets or sets the date and time of the creation of the object. (Inherited from MajorObject)
Cubes	Gets the collection of cubes associated with a Database.
DatabasePermissions	Gets the collection of database permission elements associated with a Database element.
DataSourceImpersonationInfo	Gets or sets the impersonation information associated with a Database.
DataSources	Gets the collection of data sources associated with a Database.
DataSourceViews	Gets the collection of data source views associated with a Database.
DbStorageLocation	Gets or sets the database storage location. (Inherited from Database)
Description	Gets or sets the description of the component. (Inherited from Database)
Dimensions	Gets the collection of dimensions associated with a Database.
DirectQueryMode	Gets or sets the direct-query mode the current database is using.
DismissedValidationResults	Gets a collection of DismissedValidationResult associated with the Database. (Inherited from Database)
DismissedValidationRules	Gets a collection of DismissedValidationRule associated with the Database. (Inherited from Database)
EstimatedSize	Gets or sets the read-only estimated size, in bytes, of the parent Database. (Inherited from Database)
FriendlyName	Gets a user-friendly name for the component. (Inherited from NamedComponent)
ID	Gets or sets the identifier of the component. (Inherited from NamedComponent)
ImagePath	Gets or sets the image path. (Inherited from Database)
ImageUniqueID	Gets or sets the image unique identifier. (Inherited from Database)
ImageUrl	Gets or sets the URL path to an image to display for the database. (Inherited from Database)
ImageVersion	Gets or sets the version of the image in the database. (Inherited from Database)
IsInTransaction	Gets a value that indicates whether the database is affected by the current transaction.
IsLoaded	Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject)
KeyForCollection	Gets the key used in collections. (Inherited from NamedComponent)
Language	Gets or sets the language value for a Database. (Inherited from Database)
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)
LastUpdate	Gets or sets the time of last update for a Database. (Inherited from Database)
MasterDataSourceID	Gets or sets the master data source identifier for a Database.
MiningStructures	Gets the collection of mining structures associated with a Database.
Model	Gets the child Model of the Database.
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	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 Server object of the Database object.
ProcessingPriority	Gets or sets the processing priority of a Database.
ReadWriteMode	Gets or sets the ReadWriteMode of the database. (Inherited from Database)
Roles	Gets the collection of roles associated with a Database.
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)
State	Gets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject)
StorageEngineUsed	Gets or sets the storage engine used in the current database. (Inherited from Database)
Translations	Gets the collection of translations associated with a Database. (Inherited from Database)
Version	Gets or sets the database version. (Inherited from Database)
Visible	Gets or sets the Boolean visibility property associated with a Database. (Inherited from Database)

Methods

AddToContainer(IContainer)	Add the database to a container (Inherited from Database)
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)
Backup(BackupInfo)	Provides programmatic access to Backup operations for a Database with BackupInfo information. (Inherited from Database)
Backup(String, Boolean, Boolean, BackupLocation[], Boolean, String)	Provides programmatic access to backup operations for a Database with the specified file, AllowOverWrite indication, BackupRemotePartitions indication, locations information, ApplyCompression indication, and password. (Inherited from Database)
Backup(String, Boolean, Boolean, BackupLocation[], Boolean)	Provides programmatic access to backup operations for a Database with the specified file, AllowOverWrite indication, BackupRemotePartitions indication, locations information, and ApplyCompression indication. (Inherited from Database)
Backup(String, Boolean, Boolean, BackupLocation[])	Provides programmatic access to backup operations for a Database with the specified file, AllowOverWrite indication, BackupRemotePartitions indication, and locations information. (Inherited from Database)
Backup(String, Boolean, Boolean)	Provides programmatic access to Backup operations for a Database with the specified file, AllowOverWrite indication, and BackupRemotePartitions indication. (Inherited from Database)
Backup(String, Boolean)	Provides programmatic access to Backup operations for a Database with the specified file and AllowOverWrite indication. (Inherited from Database)
Backup(String)	Provides programmatic access to Backup operations for a Database with the specified file. (Inherited from Database)
BeforeRemove(Boolean)	Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent)
CanProcess(ProcessType)	Indicates whether the cube can perform the specified processing. (Inherited from Database)
Clone()	Returns a clone of the object.
Clone(Boolean)	Creates a new copy of the MajorObject object. (Inherited from MajorObject)
CopyTo(Database)	Copies the content of this object to another object (the destination).
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)	Copies a ModelComponent object to the specified object. (Inherited from ModelComponent)
CopyTo(NamedComponent)	Copies a NamedComponent object to the specified object. (Inherited from NamedComponent)
Detach()	Detaches a database that is not in use. (Inherited from Database)
Detach(String)	Detaches a database with a specified password. (Inherited from Database)
Drop()	Removes current object and updates server. (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)
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)	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)	Removes current object and updates server using specified options. (Inherited from MajorObject)
GetConnectedParentServer()	Obtains the parent server to connect with the database object. (Inherited from Database)
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 database references.
GetUpdateOverwrites(Boolean)	Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject)
LinkDimension(Dimension, String, String)	Links the database to a specified dimension.
LinkDimension(Dimension, String)	Links the database to a specified dimension.
Process()	Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)	Processes the ProcessableMajorObject with the specified process type, error handling configuration, warnings and impact details. (Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)	Processes the ProcessableMajorObject with the specified process type, error handling configuration, warnings and impact details. (Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection)	Processes the ProcessableMajorObject with the specified process type, error handling configuration and warnings. (Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration)	Processes the ProcessableMajorObject with the specified process type and error handling configuration. (Inherited from ProcessableMajorObject)
Process(ProcessType, IBinding)	Processes the ProcessableMajorObject with the specified process type and binding. (Inherited from ProcessableMajorObject)
Process(ProcessType, WriteBackTableCreation)	Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject)
Process(ProcessType)	Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject)
Refresh()	Updates the object from server definitions. (Inherited from MajorObject)
Refresh(Boolean, RefreshType)	Updates the object from server definitions, as well as loaded dependent objects [if specified]. (Inherited from MajorObject)
Refresh(Boolean)	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, 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)
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)	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)	Updates server definition of current object to actual values using the specified options 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)
Validate(ValidationErrorCollection, Boolean, ServerEdition)	Determines whether the Database is valid.
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)	Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent)
Validate(ValidationResultCollection, ValidationOptions, ServerEdition)	Indicates whether the MajorObject is valid. (Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions)	Indicates whether the MajorObject is valid. (Inherited from MajorObject)
Validate(ValidationResultCollection)	Indicates whether the MajorObject is valid. (Inherited from MajorObject)

Explicit Interface Implementations

ICloneable.Clone()
IConnectionStringHolder.ReturnPassword
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.ParentDatabase
IMajorObject.ParentServer
IMajorObject.Path
IMajorObject.WriteRef(XmlWriter)
IModelComponent.FriendlyPath	(Inherited from ModelComponent)
IModelComponent.OwningCollection	(Inherited from ModelComponent)
IProcessable.LastProcessed	(Inherited from ProcessableMajorObject)
IProcessable.State	(Inherited from ProcessableMajorObject)

Extension Methods

ToTmdl(Database, MetadataSerializationOptions)	Builds a set of TMDL documents based on the metadata of the secified database.
ToTmdl(Database)	Builds a set of TMDL documents based on the metadata of the secified database.

Applies to

Share via