DBDeploy Example

Download source files:DBDeployExample.zip (4.81 mb)

Here is a quick example of how to use DB Deploy

This example uses NANT to run DBDeploy which in turn generates the output.sql file.  This is then run against the database causing our changes to be run in and putting an entry in the ChangeLog table to tell you which sql files have been run.

To run this sample

  1. Download to a location on your computer e.g. C:\Examples\DBDeployExample
  2. Create a database onyour localhost called DBDeployExample
  3. In a command prompt (Or PowerShell) use NANT to build the solution –(I have this setup as an environment variable setup and simply type ‘NANT’)
  4. NANT will build the default.build file and run the database changes

The NANT output should look like this


Opening the solution file looks like this

The database should now look like this

The ChangeLog table in the database is used by DBDeploy for change management and will look like this:

The default.build file contains a target that actions DBDeploy

 <target name="script.generate" description="generate a sql upgrade script"> 
 <call target="setup.changelogtable"/> <call target="setup.builddir"/>
 <echo message="Calling dbdeploy with dbConnection=${connstring}..." />
 <dbdeploy dbType="mssql" dbConnection="${connstring}" dir="${script.dir}" outputFile="${output.file}" undoOutputFile="${undo.output.file}" />
<echo message="...finished calling dbdeploy." /> </target>

The output file contains all change files found on the file system that are not contained in the ChangeLog table

The following command runs the output script against the database

 <target name="script.execute"> <echo message="Executing script ${script.execute.filename} against database ${database.name}..." />
<exec program="${sqlcmd}"> <arg value="${script.execute.extraparams}" /> <arg value="-i" />
<arg value="${script.execute.filename}" /> <arg value="-d" /> <arg value="${database.name}" />
<arg value="-S"/> <arg value="${server}" />
</exec>
<echo message="...finished executing script." />
</target>