Using Liquibase with YugabyteDB
YugabyteDB is an open-source, high-performance, distributed SQL database for global, internet-scale apps. It can be run on your local machine as well as a cloud cluster. For more information, see the YugabyteDB documentation page.
Supported versions
-
2.6
Note: Supported versions tested with Liquibase Test Harness.
Prerequisites
- Install Liquibase.
- Create a Liquibase project folder to store all Liquibase files.
- Create a new Liquibase properties file or use the
liquibase.propertiesfile included in the installation package. For more information, see Specifying Properties in a Connection Profile.
Install drivers
To use Liquibase and YugabyteDB, you need to have the JDBC driver JAR file.
liquibase/internal/lib directory.
If you use Maven, you also need to download the driver JAR file and configure your Maven pom.xml file to use the local copy of the driver. For more information, see Configuring Liquibase Attributes in your Maven POM File. For example:
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>42.3.4</version>
</dependency>Test your connection
-
Ensure your YugabyteDB is configured. You can check its status depending on your cluster setup. Run the
yugabytedcommand:./bin/yugabyted status -
Specify the database URL in the Liquibase properties file:
url:jdbc:postgresql://localhost:5433/<database_name>When using the YugabyteDB on-premises and specifying the URL, enter your IP address or host name, the port, and the database name. An example of the format is:
jdbc:postgresql://<IP OR HOSTNAME>:<PORT>/<DATABASE>The default username and password is
yugabytefor both. Add them to the Liquibase properties file, as follows:url: jdbc:postgresql://localhost:5433/yugabyte username: yugabyte password: yugabyte - Create a text file called changelog (
.xml,.sql,.json, or.yaml) in your project directory and add a changeset.
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-latest.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-latest.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))Tip: Formatted SQL changelogs generated from Liquibase versions before 4.2 might cause issues because of the lack of space after a double dash ( -- ). To fix this, 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.
- Inspect the SQL with the update-sql command. Then make changes to your database with the update command.
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