Pass Octopus Variables to DacPac Deployment via PowerShell
This is the process for sending a variable from Octopus Deploy, all the way down to a SQL script that is hidden inside a DacPac, which is being called from PowerShell, which is being executed by Octopus Deploy. I have covered the end-to-end process of how to package and deploy your Visual Studio database project using Octopus Deploy previously.
Octopus Variable. We will assume you have added a variable to your deployment project named “ImportantVariable”.
PowerShell. The variable is automatically available in PowerShell. It is called (rather conveniently)…
$ImportantVariable
Visual Studio Database Project. When you add the variable to your Visual Studio Database Project, call it something sensible like:
$(ImportantVariable)
You can use this anywhere in your script, even inside of strings…
SET @example = N'The value is $(ImportantVariable)'
You’ll get a build error until you go to the project properties, SQLCMD Variables tab and add the variable to the list. You can associate a default value to it here too.
DacPac Deploy. All that is left is to pass the variable from PowerShell into the DacPac deployment. You can do this via a variables dictionary in the DacPac options (Microsoft.SqlServer.Dac.DacDeployOptions).
$options.SqlCommandVariableValues.Add("ImportantVariable", $ImportantVariable)
So to recap, you’ll need to:
- Add the variable to the Octopus Deploy project
- Pass the variable to the SqlCommandVariableValues dictionary in your PowerShell script
- Add the SQLCMD Variable to your SQL script, and to the Visual Studio database project
