Skip to content

PowerShell to publish (deploy) SQL Database using a DACPAC and DAC Publish Profile

Notifications You must be signed in to change notification settings

DrJohnT/PublishDacPac

Repository files navigation

PowerShell Gallery Version Build status

PublishDacPac

Deploy a SQL Database DacPac using a DAC Publish Profile

Overview

Publish-DacPac allows you to deploy a SQL Server Database DacPac to a SQL Server instance using a DAC Publish Profile. The target can be a on-premise SQL Server instance, an Azure SQL Managed Instance or an Azure SQL Database.

SSDT (SQL Server Data Tools) is Microsoft's tool to design the entire database model including tables, views, stored procedures, functions, schemas, etc. etc. etc. SSDT covering all aspects of a database design.

SSDT is now fully integrated into Visual Studio. When you perform a build of a SSDT Visual Studio project, it creates a DacPac which defines all of the SQL Server objects - like tables, views, and instance objects, including logins - associated with a database.

Publish-DacPac simplifies the use of SqlPackage.exe to deploy a DacPac by using a DAC Publish Profile which provides for fine-grained control over the database creation and upgrades, including upgrades for schema, triggers, stored procedures, roles, users, extended properties etc. Using a DAC Publish Profile, multiple different properties can be set to ensure that the database is created or upgraded properly.

Publish-DacPac compares the content of a DacPac to the database already on the target server and generates a deployment script. You can tailor how publish works using a DAC Publish Profile.

Publish-DacPac can be used to automate the deployment of databases, either as part of a build in Azure DevOps, or part of a server deployment using Octopus Deploy or Azure DevOps Release Manager.

To automate build and deployment of databases in Azure DevOps, you can use MsBuild to create DacPac from your Visual Studio solution. You can then add a PowerShell task which uses Publish-DacPac to invoke SQLPackage.exe to deploy each DacPac using your own custom DAC Publish Profile.

DAC Publish Profiles are created in Visual Studio when you Publish a database.

Installation

Install from the PowerShell gallery using:

Install-Module -Name PublishDacPac

Pre-requisites

The following pre-requisites need to be installed for Publish-DacPac to work properly.

SqlPackage.exe

SqlPackage.exe can be installed by installing:

Note that the latest SQLPackage.exe provides support for all previous versions of SQL Server.

List of commands

The following is a list of commands provided by this module once you follow the steps in Installation.

Click the link below for full documentation of each function.

Function Description
Find-SqlPackageLocations Lists all locations of SQLPackage.exe files on the machine
Get-SqlDatabasePath Returns the path to a specific SQL database in the form: SQLSERVER:\SQL\YourServer\DEFAULT\Databases\YourSQLDatabase
Get-SqlPackagePath Returns the path of a specific version of SqlPackage.exe
Invoke-ExternalCommand Invokes (executes) an external executable via the command-line
Ping-SqlDatabase Checks if a database exists on a SQL Server
Ping-SqlServer Checks if a specific SQL Server instance is available
Publish-DacPac Publishes a DacPac using a DAC Publish Profile
Select-SqlPackageVersion Finds a specific version of SqlPackage.exe
Remove-Database Drops the database from the SQL Server instance

Usage

Publish-DacPac -DacPacPath "C:\Dev\YourDB\bin\Debug\YourDB.DacPac" -DacPublishProfile "YourDB.CI.publish.xml" -Server "YourDBServer"

Where -DacPacPath is the path to your database DacPac, -DacPublishProfile is the name of the DAC Publish Profile to be found in the same folder as your DacPac, and -Server is the name of the target server (including instance and port if required). The above is the minimum set of parameters that can be used with Publish-DacPac.

Normally, the database will be named the same as your DacPac (i.e. YourDB in the example above). However, by adding the -Database parameter, you can name the database anything you like.

Publish-DacPac -DacPacPath "C:\Dev\YourDB\bin\Debug\YourDB.DacPac" -DacPublishProfile "YourDB.CI.publish.xml" -Server "YourDBServer" -Database "YourNewNameDB"

You can also provide the full path to an alternative DAC Publish Profile.

Publish-DacPac -DacPacPath "C:\Dev\YourDB\bin\Debug\YourDB.DacPac" -DacPublishProfile "C:\Dev\YourDB\bin\Debug\YourDB.CI.publish.xml" -Server "YourDBServer"

Azure DevOps Extension

Publish-DacPac has been published as an Azure DevOps extension called Publish DacPac using a DAC Publish Profile to enable Continuous Deployment scenarios.

Example SSDT DacPac

An example SSDT Visual Studio solution and the associated DacPac is provided in the .\examples folder. You can use this to test that deployments work correctly. Note that the SSDT Visual Studio solution is configured to deploy to SQL Server 2016. Open the Visual Studio solution and change the target version and rebuild the solution if you have a different version of SQL Server installed.

Issue Reporting

If you are facing problems in making this PowerShell module work, please report any problems on PublishDacPac GitHub Project Page.