Using Liquibase with MSSQL

Microsoft SQL Server is a relational database management system. SQL Server supports different editions and components that accommodate unique performance and depend on your specific requirements.

Note: For more information, see the SQL Server documentation page.

Supported Versions

  • 2008 – officially certified
  • 2012 – officially certified
  • 2014 – officially certified
  • 2016 – officially certified
  • 2017 – officially supported and tested with Test Harness
  • 2019 – officially supported

Prerequisites

Before using Liquibase and MSSQL, ensure you have completed the following:

Driver Information

To use Liquibase and Microsoft SQL Server, you need to have the JDBC jar file:

  1. Ensure you downloaded the Microsoft JDBC Driver for SQL Server. The driver downloads as a .zip or .tar.gz file named sqljdbc_<version>.zip or sqljdbc_<version>.tar.gz.
  2. Extract the mssql-jdbc-<version>.jre<version>.jar file and place it in the liquibase/lib directory. The name of the driver jar file indicates the version of Java it supports.

Note: If you put the mssql-jdbc-<version>.jre<version>.jar file in any other directory, specify the path to it in the liquibase.properties file: classpath:../path_to_drivers/mssql-jdbc-<version>.jre<version>.jar. For more information, see Creating and configuring a liquibase.properties file.

If you use Maven, you also need to download the SQL Server driver jar file and put the driver in a location that your Maven build can access. Configure the Maven pom.xml file to use the local copy of the driver jar file. For example:

<dependency>
<groupId>com.microsoft.sqlserver</groupId>
<artifactId>mssql-jdbc</artifactId>
<version>9.2.1.jre11</version>
</dependency>

Testing Your Connection

For Liquibase and Microsoft SQL Server to work, you need to:

  1. Ensure your Microsoft SQL Server is configured. You can check the status by using one of a management tool or by running the ping command. Also, you can use the sqlcmd utility and run sqlcmd -SmyServer\instanceName.
  2. Note: Replace myServer\instanceName with the name of the computer and the instance of SQL Server that you want to connect to.

  1. Specify the database URL in your liquibase.properties file:
  2. url: jdbc:sqlserver://<host>:<port>/<dbname>

    Note: Depending on the configuration you use, your URL format may be different. For more information, see Building the Connection URL.

    Tip: If you already have a Liquibase Pro key and want to apply it to your project, add the following property to your liquibase.properties file: liquibaseProLicenseKey: <paste license key>.

  3. Create a text file called changelog (.xml, .sql, .json, or .yaml) in your project directory and add a changeset.
  1. Run the status command to see whether the connection is successful. Specify the name of the changelog you created in place of changelog.xml. Also, to run Liquibase commands, you need to specify your username and password in the liquibase.properties file or on the command line. However, the username and password attributes are not required for connections and systems which use alternate means of authentication.
  2. liquibase --username=test --password=test --changeLogFile=changelog.xml status

    Note: Alternatively, you can add the changeLogFile attribute to your liquibase.properties file.

  1. Run your first update with the Liquibase update command, which will make changes to your database:
  2. liquibase --changeLogFile=changelog.xml update

After your first update, you will see a new table along with the DATABASECHANGELOG and DATABASECHANGELOGLOCK tables added to the database:

  • DATABASECHANGELOG table. This table keeps a record of all the changesets that were deployed. When you deploy, the changesets in the changelog are compared with the DATABASECHANGELOG tracking table, and only the new changesets that were not found in the DATABASECHANGELOG will be deployed.
  • DATABASECHANGELOGLOCK table. This table is used internally by Liquibase to manage access to the DATABASECHANGELOG table during deployment and ensure only one instance of Liquibase is updating the database at a time, whether that is creating, updating or deleting changes.

Supported Commands and Change Types

Change Type Supported Command Supported
addAutoIncrement Not Supported calculateCheckSum <id> Supported
addCheckConstraint Supported changelogSync Supported
addColumn Supported changelogSyncSQL Supported
addDefaultValue Supported changelogSyncToTag Supported
addForeignKeyConstraint Supported changelogSyncToTagSQL Supported
addLookupTable Supported clearCheckSums Supported
addNotNullConstraint Supported dbDoc Supported
addPrimaryKey Supported deactivateChangeLog Supported
addUniqueConstraint Supported diff Supported
alterSequence Supported diff JSON Supported
createFunction Supported diffChangeLog Supported
createIndex Supported dropAll Supported
createPackage Supported futureRollbackSQL Supported
createPackageBody Supported futureRollbackCountSQL <value> Supported
createProcedure Supported generateChangeLog Supported
createSequence Supported help Supported
createSynonym Supported history Supported
createTable Supported listLocks Supported
createTrigger Supported markNextChangeSetRan Supported
createView Supported markNextChangeSetRanSQL Supported
customChange Supported registerChangeLog Supported
delete Supported releaseLocks Supported
disableCheckConstraint Supported rollback <tag> Supported
disableTrigger Supported rollbackCount <value> Supported
dropAllForeignKeyConstraints Supported rollbackCountSQL <value> Supported
dropCheckConstraint Supported rollbackOneChangeSet Supported
dropColumn Supported rollbackOneChangeSetSQL Supported
dropDefaultValue Supported rollbackOneUpdate Supported
dropForeignKeyConstraint Supported rollbackOneUpdateSQL Supported
dropFunction Supported rollbackSQL <tag> Supported
dropIndex Supported rollbackToDate Supported
dropNotNullConstraint Supported rollbackToDateSQL Supported
dropPackage Supported snapshot Supported
dropPackageBody Supported snapshotReference Supported
dropPrimaryKey Supported status --verbose Supported
dropProcedure Supported syncHub Supported
dropSequence Supported tag <tag string> Supported
dropSynonym Supported tagExists <tag string> Supported
dropTable Supported unexpectedChangeSets Supported
dropTrigger Supported update Supported
dropUniqueConstraint Supported updateSQL Supported
dropView Supported updateCount <value> Supported
empty Supported updateCountSQL <value> Supported
enableCheckConstraint Supported updateTestingRollback Supported
enableTrigger Supported updateToTag <tag> Supported
executeCommand Supported updateToTagSQL <tag> Supported
insert Supported validate Supported
loadData Supported    
loadUpdateData Supported    
markUnused Not Supported    
mergeColumns Supported    
modifyDataType Supported    
output Supported    
renameColumn Supported    
renameSequence Supported    
renameTable Supported    
renameTrigger Supported    
renameView Supported    
setColumnRemarks Supported    
setTableRemarks Supported    
sql Supported    
sqlFile Supported    
stop Supported    
tagDatabase Supported    
update Supported    

Related Links