Export (0) Print
Expand All

Database Class

Defines a Microsoft Analysis Services database. This class cannot be inherited.

Object
  MarshalByRefObject
    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)

[DesignerSerializerAttribute("Microsoft.AnalysisServices.Project.ComponentModel.DatabaseOnlineSerializer, Microsoft.AnalysisServices.Project, PublicKeyToken=89845dcd8080cc91", 
	"Microsoft.DataWarehouse.Serialization.OnlineComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91")]
[GuidAttribute("47922F3A-A6AF-4f2a-AE68-8B08E0CF38A8")]
[XmlRootAttribute(Namespace = "http://schemas.microsoft.com/analysisservices/2003/engine")]
[DesignerSerializerAttribute("Microsoft.DataWarehouse.Serialization.DesignXmlSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91", 
	"Microsoft.DataWarehouse.Serialization.DesignerComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91")]
[DesignerAttribute("Microsoft.AnalysisServices.Design.DatabaseDesigner,Microsoft.AnalysisServices.Design", 
	typeof(IRootDesigner))]
[DesignerCategoryAttribute("Designer")]
public sealed class Database : ProcessableMajorObject, 
	IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
	ICloneable, IConnectionStringHolder

The Database type exposes the following members.

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

  NameDescription
Public propertyAccountsGets the collection of account types that are defined in a Database element.
Public propertyAggregationPrefixDefines the common prefix to be used for aggregation names throughout the associated Database.
Public propertyAnnotationsGets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public propertyAssembliesGets the collection of assemblies associated with a Database.
Public propertyCollationGets or sets the collation type for a Database.
Public propertyCompatibilityLevelGets or sets the compatibility level for the database.
Public propertyContainer (Inherited from Component.)
Public propertyCreatedTimestampGets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public propertyCubesGets the collection of cubes in a Database.
Public propertyDatabasePermissionsGets the collection of database permission elements associated with a Database element.
Public propertyDataSourceImpersonationInfoGets or sets the impersonation information associated with a Database.
Public propertyDataSourcesGets the collection of data sources associated with a Database.
Public propertyDataSourceViewsGets the collection of data source views associated with a Database.
Public propertyDbStorageLocationGets or sets the database storage location.
Public propertyDescriptionGets or sets a description string of current object. (Inherited from MajorObject.)
Public propertyDimensionsGets the collection of dimensions associated with a Database.
Public propertyDirectQueryModeContains a read-only value that describes the query mode the current database is using.
Public propertyDismissedValidationResultsGets a collection of DismissedValidationResult associated with the Database.
Public propertyDismissedValidationRulesGets a collection of DismissedValidationRule associated with the Database.
Public propertyEstimatedSizeGets or sets the read-only estimated size, in bytes, of the parent Database.
Protected propertyFriendlyNameReturns a user-friendly name. (Inherited from NamedComponent.)
Public propertyIDGets or sets the identifier of the component. (Inherited from NamedComponent.)
Public propertyImagePathGets or sets the image path.
Public propertyImageUniqueIDGets or sets the image unique identifier.
Public propertyImageUrlGets or sets the path to an image to display for the database.
Public propertyImageVersionGets or sets the version of the image in the database.
Public propertyIsLoadedInfrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.)
Protected propertyKeyForCollectionReturns the key used in collections. (Inherited from NamedComponent.)
Public propertyLanguageGets or sets the language value for a Database.
Public propertyLastProcessedGets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Public propertyLastSchemaUpdateGets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public propertyLastUpdateGets or sets the time of last update for a Database.
Public propertyMasterDataSourceIDGets or sets the master data source identifier for a Database.
Public propertyMiningStructuresGets the collection of mining structures associated with a Database.
Public propertyModelTypeGets or sets the type of model from which the database was deployed. Expected values include Default (same as multidimensional), Multidimensional, or Tabular.
Public propertyNameGets or sets the name of the component. (Inherited from NamedComponent.)
Public propertyOwningCollectionGets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public propertyParentGets the parent Server of a Database.
Public propertyProcessingPriorityGets or sets the processing priority of a Database.
Public propertyReadWriteModeGets or sets the ReadWriteMode of the database.
Public propertyRolesGets the collection of roles associated with a Database.
Public propertySiteInfrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public propertySiteIDInfrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
Public propertyStateGets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)
Public propertyStorageEngineUsedContains a read-only value that describes the storage engine used in the current database.
Public propertyTranslationsGets the collection of translations associated with a Database.
Public propertyVisibleGets or sets the Boolean visibility property associated with a Database.
Top

  NameDescription
Protected methodAddToContainerInfrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected methodAfterInsertInfrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected methodAfterMoveInfrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected methodAfterRemoveInfrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
Public methodBackup(String)Provides programmatic access to Backup operations for a Database with file parameter.
Public methodBackup(BackupInfo)Provides programmatic access to Backup operations for a Database with BackupInfo parameter.
Public methodBackup(String, Boolean)Provides programmatic access to Backup operations for a Database with file and AllowOverWrite parameters.
Public methodBackup(String, Boolean, Boolean)Provides programmatic access to Backup operations for a Database with file, AllowOverWrite, and BackupRemotePartitions parameters.
Public methodBackup(String, Boolean, Boolean, BackupLocation[])Provides programmatic access to backup operations for a Database with file, AllowOverWrite, BackupRemotePartitions, and locations parameters.
Public methodBackup(String, Boolean, Boolean, BackupLocation[], Boolean)Provides programmatic access to backup operations for a Database with five parameters.
Public methodBackup(String, Boolean, Boolean, BackupLocation[], Boolean, String)Provides programmatic access to Backup operations for a Database with six parameters.
Protected methodBeforeRemoveInfrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
Public methodCanProcessIndicates whether a process type can be processed for a specified Database object. (Overrides ProcessableMajorObject.CanProcess(ProcessType).)
Public methodClone()Creates a new, full copy of an object.
Protected methodClone(Boolean)Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.)
Public methodCopyTo(Database)Copies a Database object to the specified object.
Protected methodCopyTo(MajorObject, Boolean)Copies the object to the specified destination. (Inherited from ProcessableMajorObject.)
Public methodCreateObjRefSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodDetach()Detaches a database that is not in use.
Public methodDetach(String)Detaches a database with a specified password.
Public methodDispose (Inherited from Component.)
Public methodDrop()Removes current object and updates server. (Inherited from MajorObject.)
Public methodDrop(DropOptions)Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public methodDrop(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 methodDrop(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 methodDrop(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 methodEquals (Inherited from Object.)
Protected methodGetCreateReferencesInfrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.)
Public methodGetDependentsInfrastructure. Gets the dependents to the specified Hashtable. (Inherited from MajorObject.)
Protected methodGetDropDependentsInfrastructure. Gets the drop dependents. (Inherited from MajorObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodGetReferencesInfrastructure. Gets the objects that the database references. (Overrides MajorObject.GetReferences(Hashtable, Boolean).)
Public methodGetType (Inherited from Object.)
Public methodGetUpdateOverwritesInfrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.)
Public methodInitializeLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodLinkDimension(Dimension, String)Links the database to a specified dimension.
Public methodLinkDimension(Dimension, String, String)Links the database to a specified dimension.
Public methodProcess()Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, Binding)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, WriteBackTableCreation)Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodRefresh()Updates current object from server definitions. (Inherited from MajorObject.)
Public methodRefresh(Boolean)Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public methodRefresh(Boolean, RefreshType)Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected methodRemoveFromContainerInfrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public methodSubmit()Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodSubmit(Boolean)Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodToStringReturns a string containing the name of the component. (Inherited from NamedComponent.)
Public methodUpdate()Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(UpdateOptions)Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(UpdateOptions, UpdateMode)Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(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 methodUpdate(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 methodUpdate(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 methodValidate(ValidationErrorCollection)Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public methodValidate(ValidationResultCollection)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public methodValidate(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 methodValidate(ValidationResultCollection, ValidationOptions)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public methodValidate(ValidationErrorCollection, Boolean, ServerEdition)Determines whether the Database is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public methodValidate(ValidationResultCollection, ValidationOptions, ServerEdition)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Top

  NameDescription
Public eventDisposed (Inherited from Component.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICloneableCloneCreates a new copy of the object instance.
Explicit interface implemetationPrivate methodIDeserializationCallbackOnDeserializationRuns when the entire object graph has been deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate methodIFormattableToStringFormats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate propertyIConnectionStringHolder.ReturnPasswordInfrastructure. Gets or sets a value that indicates whether the database returns password.
Explicit interface implemetationPrivate methodIDeserializationStartCallback.OnDeserializationBeginRuns when the entire object graph starts to deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate propertyIHostableComponent.HostGets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIMajorObject.BaseTypeInfrastructure. Gets the base type implementation of the Database.
Explicit interface implemetationPrivate methodIMajorObject.CreateBodyCreates a new body for the Database.
Explicit interface implemetationPrivate methodIMajorObject.DependsOnDetermines whether the Database depends on an object.
Explicit interface implemetationPrivate propertyIMajorObject.ObjectReferenceInfrastructure. Gets the object reference implementation of the Database.
Explicit interface implemetationPrivate propertyIMajorObject.ParentDatabaseInfrastructure. Gets the parent database referred by the Database.
Explicit interface implemetationPrivate propertyIMajorObject.ParentServerInfrastructure. Gets the parent server referred by the Database.
Explicit interface implemetationPrivate propertyIMajorObject.PathInfrastructure. Gets the path implementation of the Database.
Explicit interface implemetationPrivate methodIMajorObject.WriteRefWrites a reference for the Database.
Explicit interface implemetationPrivate propertyIModelComponent.FriendlyPathGets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIModelComponent.OwningCollectionGets or sets the collection that owns the current object. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIProcessable.LastProcessedGets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Explicit interface implemetationPrivate propertyIProcessable.StateGets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft