DacStore Class

  • Article

The root class of the DAC Domain. The Main role of this class is to store the connection and interact with the SFC framework for most of the services.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.Dac.DacDomain
      Microsoft.SqlServer.Management.Dac.DacStore

Namespace:  Microsoft.SqlServer.Management.Dac
Assembly:  Microsoft.SqlServer.Management.Dac (in Microsoft.SqlServer.Management.Dac.dll)

Syntax

'Declaration
Public Class DacStore _
    Inherits DacDomain
'Usage
Dim instance As DacStore

public class DacStore : DacDomain

public ref class DacStore : public DacDomain

type DacStore =  
    class
        inherit DacDomain
    end

public class DacStore extends DacDomain

The DacStore type exposes the following members.

Constructors

  Name Description
Public method DacStore Initializes a new instance of the DacStore class connected to the specified instance of the Database Engine.

Top

Properties

  Name Description
Protected property AbstractIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property DacInstances Gets a DacInstanceCollection object that enumerates the DAC instances deployed or registered on an instance of the Database Engine. (Inherited from DacDomain.)
Public property DacStore Gets the DacStore object associated with this DacDomain object. (Inherited from DacDomain.)
Public property Metadata Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public property Name Gets a String value with the name of the instance of the Database Engine to which the DAC domain is connected. (Inherited from DacDomain.)
Public property Parent Gets or sets the instance parent via the keychain. (Inherited from SfcInstance.)
Public property Properties Returns a collection instance properties. (Inherited from SfcInstance.)
Protected property PropertyStorageProvider Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property ServerConnection Gets server connection information.
Public property SqlStoreConnection Gets or sets the connection to the instance of SQL Server. (Overrides DacDomain.SqlStoreConnection.)
Protected property State Returns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public property Urn Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)

Top

Methods

  Name Description
Protected method AlterImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CheckObjectCreated Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CheckObjectState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method CreateIdentityKey Creates a SfcKey object for the DAC domain. (Inherited from DacDomain.)
Protected method CreateImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Discover Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method DropImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Equals (Inherited from Object.)
Public method Export(String, Stream) Exports a DAC object with specified database name and stream.
Public method Export(String, String) Exports a DAC object with specified database name and path.
Public method Export(String, Stream, IEnumerable<TableName>) Exports a DAC object with specified database name, stream, and tables.
Protected method Finalize (Inherited from Object.)
Protected method GetChildCollection Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. Returns a ISfcCollection object. (Inherited from DacDomain.)
Public method GetDatabaseChanges Gets the changes made to the specified database.
Public method GetDomain Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public method GetIncrementalUpgradeScript Gets the script used in the DAC incremental upgrade.
Public method GetPropertySet Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method GetTypeMetadataImpl Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Import(Stream) Imports a DAC object with specified stream.
Public method Import(Stream, DatabaseDeploymentProperties, Boolean) Imports a DAC object with specified stream, deployment properties, and validation.
Public method Import(String, DatabaseDeploymentProperties, Boolean) Imports a DAC object with specified deployment properties, path, and validation.
Public method IncrementalUpgrade Displays the DAC incremental upgrade.
Protected method InitializeUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Install(DacType) Uses the specified DacType object to create a DAC instance in the instance of the Database Engine represented by the DacStore object.
Public method Install(DacType, DatabaseDeploymentProperties, Boolean) Uses the specified DacType object to create a DAC instance in the instance of the Database Engine represented by the DacStore object.
Protected method MarkForDropImpl Returns a value that indicates the existing objects to be dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method MarkRootAsConnected Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method MoveImpl Indicates the new parent object to move in an instance. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Protected method PostAlter Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostCreate Indicates the default implementor that creates the execution result. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostDrop Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostMove Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method PostRename Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Refresh Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Protected method RenameImpl Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method ResetKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Serialize Serializes the instance to XML. (Inherited from SfcInstance.)
Public method ToString Returns a string representation of the instance Urn. (Inherited from SfcInstance.)
Public method Uninstall Deletes the specified DAC instance from the instance of the Database Engine associated with the DacStore.
Public method Unmanage Deletes the a DAC instance without affecting the database associated with the instance.
Protected method UpdateUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method Validate Indicates the basic child object's validation. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)

Top

Events

  Name Description
Public event DacActionFinished Returns events as they are completed from the DacStore Install(), Uninstall(), and Upgrade() methods.
Public event DacActionInitialized Returns events as they are initialized to pending status from the DacStore Install(), Uninstall(), and Upgrade() methods.
Public event DacActionStarted Returns events as they start running for the DacStore Install(), Uninstall(), and Upgrade() methods.
Protected event propertyChanged Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public event PropertyChanged CLS-compliant event for property changes. (Inherited from SfcInstance.)
Protected event propertyMetadataChanged Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public event PropertyMetadataChanged CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISfcDomain.GetExecutionEngine Returns an ISfcExecutionEngine object that specifies an instance of the Database Engine for running scripts. (Inherited from DacDomain.)
Explicit interface implemetationPrivate method ISfcDomain.GetKey Gets a SfcKey object that represents the DAC domain. (Inherited from DacDomain.)
Explicit interface implemetationPrivate method ISfcDomain.GetType Gets a Type object describing the Sfc type with the specified name within the Sfc domain. (Inherited from DacDomain.)
Explicit interface implemetationPrivate method ISfcDomain.GetTypeMetadata Obsolete. Gets the metadata for the specified SFC type. (Inherited from DacDomain.)
Explicit interface implemetationPrivate method ISfcDomain.UseSfcStateManagement Specifies whether to use the state management provided by the Microsoft.SqlServer.Management.Sdk.Sfc namespace. (Inherited from DacDomain.)
Explicit interface implemetationPrivate property ISfcDomainLite.DomainInstanceName Gets the specified instance name of the domain. (Inherited from DacDomain.)
Explicit interface implemetationPrivate property ISfcDomainLite.DomainName Gets the specified name of the domain. (Inherited from DacDomain.)
Explicit interface implemetationPrivate method ISfcDomainLite.GetLogicalVersion Gets a logical version number that represents the level of changes to the object model in the SFC domain. (Inherited from DacDomain.)
Explicit interface implemetationPrivate property ISfcHasConnection.ConnectionContext Gets the specified context for the connection. (Inherited from DacDomain.)
Explicit interface implemetationPrivate method ISfcHasConnection.GetConnection() Gets a connection to the instance of the Database Engine serving as a backing store. (Inherited from DacDomain.)
Explicit interface implemetationPrivate method ISfcHasConnection.GetConnection(SfcObjectQueryMode) Gets a connection to the instance of the Database Engine serving as a backing store that supports the specified query processing mode. (Inherited from DacDomain.)
Explicit interface implemetationPrivate method ISfcHasConnection.SetConnection Sets the active connection for the domain root. (Inherited from DacDomain.)

Top

Remarks

Using the DacStore object, you can:

  • Connect to an instance of the Database Engine.

  • Access the collection of DacInstance objects that are immediate children of the DacStore object. The collection represents the set of DAC instances available on the instance of the Database Engine.

  • Request create, read, update, and delete (CRUD) operations for every type in the object model.

Note

The DacStore class implements ISfcDomain, which specifies the connection point to any object domain defined using the Microsoft.SqlServer.Management.Sdk.Sfc namespace.

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.SqlServer.Management.Dac Namespace