👁 Image
Microsoft.SqlPackage 170.4.83

Microsoft SQL Server Data-Tier Application Framework (DacFx) SqlPackage CLI

Overview

SqlPackage is a cross-platform command-line utility for creating and deploying .dacpac and .bacpac packages. SqlPackage can be installed as a dotnet tool or downloaded as a standalone executable for Windows, macOS, or Linux. Use this tool to automate database development and deployment tasks for Microsoft SQL Server, Microsoft Azure SQL Database, and SQL in Fabric. SqlPackage is built on top of the Microsoft SQL Server Data-Tier Application Framework (DacFx).

📗 SqlPackage command-line reference documentation

📗 SQL projects database DevOps documentation

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 is also available as a NuGet package for use in your own .NET applications.

Installation

To install SqlPackage as a global .NET tool, run the following command:

dotnet tool install -g microsoft.sqlpackage

More information on the options available with the dotnet tool install command can be found in the dotnet tool install documentation.

To update SqlPackage to the latest version, run the following command:

dotnet tool update -g microsoft.sqlpackage

Preview releases of SqlPackage are available with the dotnet tool feed. To access preview releases, use the --prerelease option with the dotnet tool command. For example, to install the latest preview release, run the following command:

dotnet tool install -g --prerelease microsoft.sqlpackage

Usage

The following examples demonstrate some basic functionality of the SqlPackage CLI. For more commands and parameters, refer to the SqlPackage command-line reference documentation.

Example: Deploy a .dacpac to a new or existing database

sqlpackage /Action:Publish /SourceFile:"path\to\your.dacpac" /TargetConnectionString:"your-database-connection-string"

Example: Extract a database to a .dacpac

sqlpackage /Action:Extract /SourceConnectionString:"your-database-connection-string" /TargetFile:"path\to\output.dacpac"

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

sqlpackage /Action:Extract /SourceConnectionString:"your-database-connection-string" /TargetFile:"path\to\output\directory" /ExtractTarget:SchemaObjectType

Related components

Support

Open issues at DacFx GitHub