Using Liquibase with Cassandra

Apache Cassandra is an open source, distributed, NoSQL database. It presents a partitioned wide column storage model with consistent semantics. For more information, see the Apache Cassandra page.

Supported versions

  • 4.X
  • 3.11.X

Verification level

Compatible: Reported to work by the community. May have partially passed Foundational-level testing.

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

Prerequisites

Install drivers

To use Liquibase and Apache Cassandra, you need two JAR files: a JDBC driver and the Liquibase Cassandra extension:

  1. Download the Simba JDBC driver JAR file and select Simba JDBC Driver for Apache Cassandra from the dropdown menu. Select the default package option unless you need a specific package. The driver downloads as a ZIP file named SimbaCassandraJDBC42-x.x.x.zip.
  2. Extract the CassandraJDBCxx.jar file and place it in the liquibase/lib directory.
  3. Open the Liquibase properties file and specify the driver, as follows:
  4. driver: com.simba.cassandra.jdbc42.Driver
  5. Go to the liquibase-cassandra repository and download the latest released Liquibase extension JAR file: liquibase-cassandra-version.jar.

Place your JAR file(s) in the liquibase/lib directory. Read more: Adding and Updating Liquibase Drivers.

If you use Maven, note that this database does not provide its driver JAR on a public Maven repository, so you must install a local copy and add it as a dependency to your pom.xml file. Read more: Configuring Liquibase Attributes in your Maven POM File.

<dependency>
    <groupId>com.datastax.jdbc</groupId>
    <artifactId>CassandraJDBC42</artifactId>
    <version>4.2</version>
    <scope>system</scope>
    <systemPath>${basedir}/lib/CassandraJDBC42.jar</systemPath>
</dependency>
<dependency>
    <groupId>org.liquibase.ext</groupId>
    <artifactId>liquibase-cassandra</artifactId>
    <version>4.16.1</version>
</dependency>

You need to specify that the scope is system and provide the systemPath in pom.xml. In the example, the ${basedir}/lib is the location of the driver JAR file.

Test your connection

  1. Ensure your Cassandra database is configured. If you have Cassandra tools locally and want to check the status of Cassandra, run $ bin/nodetool status. The status column in the output should report UN, which stands for "Up/Normal":
  2. # nodetool status
    Datacenter: datacenter1
    =======================
    Status=Up/Down
    |/ State=Normal/Leaving/Joining/Moving
    -- Address Load Tokens Owns (effective) Host ID Rack
    UN 172.18.0.6 198.61 KiB 276 100.0% 5rtc74d1-237f-87c0-88eb-72643bd0a8t7 rack1

    Note: For more information, see the Installing Cassandra documentation.

  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:cassandra://localhost:9042/myKeyspace;DefaultKeyspace=myKeyspace

    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