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 and tested with Test Harness
Prerequisites
Before using Liquibase with your database, ensure you have:
- Installed Liquibase.
- Created a Liquibase project folder to store all Liquibase files.
- Created a new Liquibase properties file or are using the existing
liquibase.propertiesfile included in the installation package. For more information, see Specifying Properties in a Connection Profile.
Driver Information
To use Liquibase and Microsoft SQL Server, you need to have the JDBC driver .jar file. Liquibase comes with a pre-installed driver for MSSQL in the liquibase/lib directory. For more information, see Adding and Updating Liquibase Drivers.
Note: If you place the mssql-jdbc-<version>.jre<version>.jar file in a different directory, specify the path in the Liquibase properties file, as follows: classpath:../path_to_drivers/mssql-jdbc-<version>.jre<version>.jar. For more information, see Specifying Properties in a Connection Profile.
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:
- Ensure your Microsoft SQL Server is configured. You can check the status by using one of a management tool or by running the
pingcommand. Also, you can use the sqlcmd utility and runsqlcmd -SmyServer\instanceName.
Note: Replace myServer\instanceName with the name of the computer and the instance of SQL Server that you want to connect to.
- Specify the database URL in the Liquibase properties file, as follows:
- Create a text file called changelog (
.xml,.sql,.json, or.yaml) in your project directory and add a changeset.
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>
XML example
<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
xmlns:pro="http://www.liquibase.org/xml/ns/pro"
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.9.xsd
http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd
http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-4.9.xsd">
<changeSet id="1" author="Liquibase">
<createTable tableName="test_table">
<column name="test_id" type="int">
<constraints primaryKey="true"/>
</column>
<column name="test_column" type="varchar"/>
</createTable>
</changeSet>
</databaseChangeLog>-- liquibase formatted sql
-- changeset liquibase:1
CREATE TABLE test_table (test_id INT, test_column VARCHAR, PRIMARY KEY (test_id))Note: Formatted SQL changelogs generated by using Liquibase versions previous to 4.2 might cause issues because of the lack of space after a double dash ( -- ).
Tip: To fix those issues, add a space after the double dash. For example: -- liquibase formatted sql instead of --liquibase formatted sql and -- changeset myname:create-table instead of --changeset myname:create-table
YAML example
databaseChangeLog:
- changeSet:
id: 1
author: Liquibase
changes:
- createTable:
columns:
- column:
name: test_column
type: INT
constraints:
primaryKey: true
nullable: false
tableName: test_table{
"databaseChangeLog": [
{
"changeSet": {
"id": "1",
"author": "Liquibase",
"changes": [
{
"createTable": {
"columns": [
{
"column":
{
"name": "test_column",
"type": "INT",
"constraints":
{
"primaryKey": true,
"nullable": false
}
}
}]
,
"tableName": "test_table"
}
}]
}
}]
}- Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful. You can pass arguments in the CLI or keep them in the Liquibase properties file.
- Run your first update with the update command, which makes changes to your database. You can also run the update-sql command to inspect the SQL before running the
updatecommand.
liquibase --username=test --password=test --changelog-file=<changelog.xml> statusliquibase --changelog-file=<changelog.xml> update-sql
liquibase --changelog-file=<changelog.xml> updateFrom a database UI tool, ensure that your database contains the table you added along with the DATABASECHANGELOG table and DATABASECHANGELOGLOCK table.
Supported Change Types
Supported Commands