Using Liquibase with CockroachDB
CockroachDB is a distributed database with standard SQL for cloud applications. You can run CockroachDB on your local machine or use a cloud cluster.
Supported Versions
- 20.1
- 20.2
- 21.1
Note: The supported versions are the versions that were tested with Liquibase 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 CockroachDB, you need to have the JDBC jar file:
- Ensure you have downloaded the PostgreSQL JDBC jar driver file to connect to CockroachDB.
- Place your
postgresql-version.jarfile in theliquibase/libdirectory.
Note: If you place the postgresql-version.jar file in a different directory, specify the path in the Liquibase properties file, as follows: classpath:../path_to_drivers/postgresql-version.jar. For more information, see Specifying Properties in a Connection Profile.
If you use Maven, download the PostgreSQL JDBC driver and place 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>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>42.2.8</version>
</dependency>Testing Your Connection
For Liquibase and CockroachDB to work, you need to:
- Ensure your CockroachDB is configured. You can check its status depending on your cluster setup. For example, you can check basic network connectivity (ping), port connectivity (telnet), and certificate validity. See the Troubleshoot Cluster Setup for more details.
- Generate or check TLS certificates for the user that you created during a secure CockroachDB cluster setup. Use the
cockroach certcommand to generate the certificates:
cockroach cert create-client user --certs-dir=certs --ca-key=my-safe-directory/ca.key --also-generate-pkcs8-key- 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.
CockroachDB on-premises
url:jdbc:postgresql://localhost:26257/database?ssl=true&sslmode=require&sslrootcert=/full-path/certs/ca.crt&sslkey=/full-ath/certs/client.user.key.pk8&sslcert=/full-path/certs/client.user.crtWhen using the CockroachDB on-premises and specifying the URL, enter your IP address or host name, and then the port followed by the database name. The example of the format is: jdbc:postgresql://<IP OR HOSTNAME>:<PORT>/<DATABASE>.
The SSL connection parameters to the full paths of the certificates that you generated are optional. A key in PKCS#8 format is the standard key encoding format in Java. As an alternative, you can use the URL without SSL connection parameters by specifying the username and password attributes:
url: jdbc:postgresql://localhost:26257/dev
username: root
password: passwordCockroachDB cloud
url: jdbc:postgresql://liquibase-3r8.aws-us-east-2.cockroachlabs.cloud:26257/defaultdb?sslmode=verify-full&sslrootcert=liquibase-ca.crtWhen using the CockroachCloud instance and specifying URL, enter a global host name and the port 26257 by referring to the CockroachCloud website. Also, add the database name with the SSL mode and the path to the CA certificate to your 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"
}
}]
}
}]
}Note: CockroachDB has limited support for online schema changes in transactions. To avoid issues with incomplete transactions, you can set the runInTransaction attribute to false. However, take into account that if this attribute is set to false and an error occurs part way through running a changeset that contains multiple statements, the Liquibase DATABASECHANGELOG table will be left in an invalid state.
- 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