Octopus Deploy step templates reference
Published 10 March 2016
You can use the following DLM Automation step templates to help you set up a database deployment project in Octopus Deploy:
- Redgate - Create Database Release: creates the resources needed to deploy database changes
- Redgate - Deploy from Database: deploys the schema of a source database to a target database without a review step
- Redgate - Deploy from Database Release: uses the deployment resources created by the "Redgate - Create Database Release" step to deploy changes to a target database
- Redgate - Deploy from Package: deploys a package containing a database schema to a target database without a review step
The templates are available from the Octopus Deploy Library. For help on installing and using them, see this worked example.
We recommend creating variables for the parameter values, to allow scoping and sharing of values between steps. See Variables (Octopus Deploy documentation).
On this page:
Create Database Release
Copy this template from the Octopus Deploy Library
This step creates the database deployment resources to update the target database from a NuGet package containing the source schema.
A step must already exist in the project that downloads a NuGet package containing the source database schema.
| Parameter | Required | Value |
|---|---|---|
| Export path | Yes | The path that the database deployment resources will be exported to. This path is used in the Deploy from Database Release step, and tentacles used in database deployment steps must be able to access it. |
| Delete files in export folder | No | If files exist in the export path folder, this option deletes those files before exporting the database deployment resources. If this option is not selected and there are files in the export path folder, the step will fail. |
| Database package step | Yes | The step in which the NuGet package containing the source database schema was downloaded. |
| Target SQL Server instance | Yes | The fully-qualified name of the SQL Server instance for the database that will be updated. |
| Target database name | Yes | The name of the database that will be updated. |
| Username | No | The SQL Server username used to connect to the database. If you leave this field and 'Password' blank, Windows authentication will be used to connect instead, using the account that runs the Tentacle service. |
| Password | No | The SQL Server password Only required if you are using SQL Server authentication. |
| Filter path | No | The location of a SQL Compare filter file (.scpf), which defines objects to include/exclude in the schema comparison. Filter files are generated by SQL Source Control. |
| SQL Compare options | No | SQL Compare options to apply when generating the update script. |
| Transaction isolation level | No | The transaction isolation level to be used in deployment scripts. |
| Ignore static data | No | Excludes changes to static data when generating the deployment resources. |
| Include identical objects in the change report | No | By default, the change report only includes added, modified and removed objects. Choose this option to also include identical objects. Added July 8th, 2015 |
Deploy from Database
Copy this template from the Octopus Deploy Library
This step updates the schema of the target database to match the schema of the source database.
| Parameter | Required | Value |
|---|---|---|
| Source SQL Server instance | Yes | The fully-qualified name of the SQL Server instance for the database whose schema you want to deploy to the target database. |
| Source database name | Yes | The name of the database whose schema you want to deploy to the target database. |
| Username | No | The SQL Server username used to connect to the source database. If you leave this field and 'Password' blank, Windows authentication will be used to connect instead, using the account that runs the Tentacle service. |
| Password | No | The SQL Server password for the source database. Only required if you are using SQL Server authentication. |
| Target SQL Server instance | Yes | The fully-qualified instance name of the SQL Server for the database that will be updated. |
| Target database name | Yes | The name of the database that will be updated. |
| Username | No | The SQL Server username used to connect to the target database. If you leave this field and 'Password' blank, Windows authentication will be used to connect instead, using the account that runs the Tentacle service. |
| Password | No | The SQL Server password for the target database. Only required if you are using SQL Server authentication. |
| Filter path | No | Specify the location of a SQL Compare filter file (.scpf), which defines objects to include/exclude in the schema comparison. Filter files are generated by SQL Source Control. |
| SQL Compare options | No | SQL Compare options to apply when generating the update script. |
| Transaction isolation level | No | Select the transaction isolation level to be used in deployment scripts. |
| Query batch timeout (in seconds) | No | The execution timeout, in seconds, for each batch of queries in the update script. The default value is 30 seconds. A value of zero indicates no execution timeout. Added July 8th, 2015 |
Deploy from Database Release
Copy this template from the Octopus Deploy Library
This step updates the schema of the target database to match that of a NuGet package containing the source database schema.
This step requires that the "Create Database Release" step has already been run, to generate the database deployment resources.
| Parameter | Required | Value |
|---|---|---|
| Export path | Yes | The path the database deployment resources were exported to. This should be the same path specified in the "Create Database Release" step, and must be accessible to all tentacles used in database deployment steps. |
| Database package step | Yes | The step in which the NuGet package containing the source database schema was downloaded. |
| Target SQL Server instance | Yes | The fully-qualified name of the SQL Server instance for the database that will be updated. |
| Target database name | Yes | The name of the database that will be updated. |
| Username | No | The SQL Server username used to connect to the database. If you leave this field and 'Password' blank, Windows authentication will be used to connect instead, using the account that runs the Tentacle service. |
| Password | No | The SQL Server password Only required if you are using SQL Server authentication. |
| Query batch timeout (in seconds) | No | The execution timeout, in seconds, for each batch of queries in the update script. The default value is 30 seconds. A value of zero indicates no execution timeout. |
Deploy from Package
Copy this template from the Octopus Deploy Library
This step updates the schema of the target database to match that of a NuGet package containing the source database schema. A step must already exist in the project that downloads a NuGet package containing the source database schema.
| Parameter | Required | Value |
|---|---|---|
| Database package step | Yes | The step in which the NuGet package containing the source database schema was downloaded. |
| Target SQL Server instance | Yes | The fully-qualified instance name of the SQL Server for the database that will be updated. |
| Target database name | Yes | The name of the database that will be updated. |
| Username | No | The SQL Server username used to connect to the target database. If you leave this field and 'Password' blank, Windows authentication will be used to connect instead, using the account that runs the Tentacle service. |
| Password | No | The SQL Server password for the target database. Only required if you are using SQL Server authentication. |
| Filter path | No | Specify the location of a SQL Compare filter file (.scpf), which defines objects to include/exclude in the schema comparison. Filter files are generated by SQL Source Control. |
| SQL Compare options | No | SQL Compare options to apply when generating the update script. |
| Transaction isolation level | No | Select the transaction isolation level to be used in deployment scripts. |
| Ignore static data | No | Excludes changes to static data when generating the deployment resources. |
| Query batch timeout (in seconds) | No | The execution timeout, in seconds, for each batch of queries in the update script. The default value is 30 seconds. A value of zero indicates no execution timeout. |
