Database Class
Definition
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.
Specifies an Analysis Services Tabular or Multidimensional database. This class cannot be inherited. Server mode and model type will determine whether you can subsequently create or modify the model tree. Specifically, if you call Tabular.Database, you can modify its model only when the model is Tabular at compatibility level 1200.
public class Database : Microsoft.AnalysisServices.Core.Database, ICloneable, Microsoft.AnalysisServices.Tabular.IMajorObjecttype Database = class
inherit Database
interface ICloneable
interface IMajorObjectPublic Class Database
Inherits Database
Implements ICloneable, IMajorObject- Inheritance
- Implements
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) |
Initializes a new instance of a Tabular Database using a name. |
| Database(String, String) |
Initializes a new instance of a Tabular Database using a 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
| Annotations |
Gets the collection of all annotations associated with the major object. (Inherited from MajorObject) |
| 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) |
| DbStorageLocation |
Gets or sets the database storage location. (Inherited from Database) |
| Description |
Gets or sets the description of the component. (Inherited from Database) |
| 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) |
| Model | |
| 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 | |
| ReadWriteMode |
Gets or sets the ReadWriteMode of the database. (Inherited from Database) |
| Server |
Gets the parent Server of 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) |
Provides programmatic access to Backup operations for a Database with the specified file. (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, 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, 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, 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[], 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) |
| 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) |
This API is part of the Analysis Services infrastructure and is not intended to be called directly from your code. It creates a new copy of the MajorObject object. |
| CopyTo(Database) |
Copies the content of this object to another object (the destination). |
| CopyTo(MajorObject, Boolean) |
Infrastructure. Copies a MajorObject object to the specified destination. |
| 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) |
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) |
| 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. (Inherited from Database) |
| GetUpdateOverwrites(Boolean) |
Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject) |
| Process() |
Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject) |
| Process(ProcessType) |
Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject) |
| Process(ProcessType, ErrorConfiguration) |
Processes the ProcessableMajorObject with the specified process type and error handling configuration. (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, XmlaWarningCollection, ImpactDetailCollection) |
Processes the ProcessableMajorObject with the specified process type, error handling configuration, warnings and impact details. (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, 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) |
| 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) |
Determines whether the NamedComponent is valid. (Inherited from NamedComponent) |
| 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.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) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Builds a set of TMDL documents based on the metadata of the secified database. |
| ToTmdl(Database, MetadataSerializationOptions) |
IMPORTANT: TMDL is still in preview and the API surface might still be modified prior to GA! Builds a set of TMDL documents based on the metadata of the secified database. |