Microsoft.SqlServer.DacFx 170.4.80-preview

Microsoft SQL Server Data-Tier Application Framework (DacFx) Nuget Package

Overview

The Microsoft SQL Server Data-Tier Application Framework (DacFx) is a .NET library which provides application lifecycle services for database development and management for Microsoft SQL databases. DacFx supports various database deployment and management scenarios, including extracting / exporting a live database to a DAC package, deploying a DAC package to a new or existing database, and migrating from on-premises to Microsoft Azure. DacFx can target all supported versions of SQL Server, as well as Microsoft Azure SQL and SQL in Fabric.

📘 DacFx .NET API documentation

📗 SQL projects database DevOps documentation

If you would like to use DacFx functionality from the command-line for creating and deploying .dacpac and .bacpac packages, please use the SqlPackage CLI as a dotnet tool or downloadable exe. Learn more about SqlPackage from http://aka.ms/sqlpackage.

Usage

The following examples demonstrate some basic functionality of the DacFx API. For more detailed examples, please refer to the DacFx API documentation.

Example: Deploy a .dacpac to a database

using Microsoft.SqlServer.Dac;

string dacpacPath = "path\\to\\your.dacpac";
string connectionString = "your-database-connection-string";
DacServices dacServices = new DacServices(connectionString);
DacPackage dacPackage = DacPackage.Load(dacpacPath);
dacServices.Deploy(dacPackage, "TargetDatabaseName", upgradeExisting: true);

Example: Extract a database to a .dacpac

using Microsoft.SqlServer.Dac;
string connectionString = "your-database-connection-string";
string dacpacOutputPath = "path\\to\\output.dacpac";
DacServices dacServices = new DacServices(connectionString);
DacExtractOptions extractOptions = new DacExtractOptions();
dacServices.Extract(dacpacOutputPath, "SourceDatabaseName", "SourceDatabaseName", extractOptions);

Example: Extract a database to .sql files organized by object type and schema

using Microsoft.SqlServer.Dac;
string connectionString = "your-database-connection-string";
string sqlOutputDirectory = "path\\to\\output\\directory";
DacServices dacServices = new DacServices(connectionString);
DacExtractOptions extractOptions = new DacExtractOptions
{
    ExtractTarget = DacExtractTarget.SchemaObjectType
};
dacServices.Extract(sqlOutputDirectory, "SourceDatabaseName", "SourceDatabaseName", extractOptions);

Related components

Support

Open issues at DacFx GitHub

Important Notice: Breaking Changes Due to Public Key Update

We would like to inform you about an important change in DacFx NuGet that may impact your applications. We have updated the public key in the DLLs included in this package. This change is crucial for enhancing the security and integrity of our assembly but may cause breaking changes in your C# applications.

Impact of Public Key Change

• Build Failures: Applications referencing the old DLL with the previous public key will fail to build.
• Runtime Errors: Applications may experience runtime errors if the old DLL is loaded dynamically or through reflection.
• Configuration Updates: Any configuration files or settings that reference the old public key will need to be updated to the new key.

Steps to Address the Change

To mitigate the impact of this change, we recommend the following steps:

• Update Package References: Ensure that you update your NuGet package reference to the latest version that includes the DLL with the new public key.
• Rebuild Your Application: Rebuild your application to ensure it correctly references the new DLL.
• Thorough Testing: Conduct comprehensive testing to identify and resolve any issues resulting from the public key change.
• Update Documentation: Ensure that all relevant documentation and configuration files are updated to reflect the new public key.