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

  • 2019
  • 2017
  • 2016
  • 2014

Verification level

Guaranteed: All applicable Liquibase Open Source and Liquibase Pro functionality works with this database. Verified by automated and real-world testing from Liquibase. The Liquibase support team provides best-effort usage, bug-fix, and prioritized feature request support to Commercial users.

Note: A database's verification level indicates how well it works with different features in Liquibase and across different products, such as Liquibase Open Source and Liquibase Pro. For more information, see Liquibase Database Tutorials.

Prerequisites

Install drivers

To use Liquibase and Microsoft SQL Server, you need the JDBC driver JAR file (Maven download).

The latest version of Liquibase has a pre-installed driver for this database in the liquibase/internal/lib directory. Read more: Adding and Updating Liquibase Drivers.

If you use Maven, you must include the driver JAR as a dependency in your pom.xml file. Read more: Configuring Liquibase Attributes in your Maven POM File.

<dependency>
    <groupId>com.microsoft.sqlserver</groupId>
    <artifactId>mssql-jdbc</artifactId>
    <version>11.1.2.jre8</version>
</dependency>

Test your connection

  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 the Liquibase properties file. Liquibase does not parse the URL. You can either specify the full database connection string or specify the URL using your database's standard JDBC format:
  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: To apply a Liquibase Pro key to your project, add the following property to the Liquibase properties file: liquibaseProLicenseKey: <paste code here>

  1. Create a text file called changelog (.xml, .sql, .json, or .yaml) in your project directory and add a changeset.
  2. Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful:
  3. liquibase --username=test --password=test --changelog-file=<changelog.xml> status

    Note: You can pass arguments in the CLI or keep them in the Liquibase properties file.

  4. Inspect the SQL with the update-sql command. Then make changes to your database with the update command.
  5. liquibase --changelog-file=<changelog.xml> update-sql
    liquibase --changelog-file=<changelog.xml> update
  6. From a database UI tool, ensure that your database contains the test_table you added along with the DATABASECHANGELOG table and DATABASECHANGELOGLOCK table.

Related links