Connect Liquibase with Cassandra

If you're running Liquibase using the Maven plugin using mvn liquibase: update, installing the extension with Maven ensures the right files are available and everything works together automatically. You can manage these extensions by adding them as dependencies in your project’s pom.xml file. Configuring Maven this way ensures that the necessary JAR files are retrieved from Maven Central during the build phase.

Add this property in the liquibase.properties file to activate the compatibility mode with Amazon Keyspaces: liquibase.cassandra.awsKeyspacesCompatibilityModeEnabled: true Tip: For more information about the available JDBC connection string options for Amazon Keyspaces, please consult the driver documentation.

Specify the database JDBC URL in the liquibase.properties file (defaults file), along with other properties you want to set a default value for. Liquibase does not parse the URL. Specify the URL using this JDBC format. Be sure to:

• Replace <host1> with your host. For example, cassandra.<aws-region>.amazonaws.com

• Replace <port1> with your port. For example, 9141

• Replace <hostN> with your host name. For example, localhost, database.example.com, or cassandra-prod-01

• Replace `<keyspace>` with your Cassandra keyspace name. This works the same whether you're using self-hosted Apache Cassandra, DataStax Astra, AWS Keyspaces, or other Cassandra deployments.

URL Syntax: url: jdbc:cassandra://<host1>[:<port1>][...--<hostN>[:<portN>]]/<keyspace>?compliancemode=Liquibase[&localdatacenter=<datacenter_name>]

Always specify the compliancemode parameter with the value Liquibase to avoid any unexpected behaviour when running the changelog.

URL Format example: url: jdbc:cassandra://cassandra.<aws-region>.amazonaws.com:9142/<keyspace>?compliancemode=Liquibase[&user=<username>&password=<password>]

1. Create a text file called changelog (.xml, .sql, .json, or .yaml) in your project directory and add a changeset.

If you already created a changelog using the init project command, you can use that instead of creating a new file. When adding onto an existing changelog, be sure only to add the changeset and not duplicate the changelog header.

2. Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful:

liquibase status --username=test --password=test --changelog-file=<changelog.xml>

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

If your connection is successful, you'll see a message like this:

4 changesets have not been applied to <your_connection_url> Liquibase command 'status' was executed successfully.

3. Inspect the deployment SQL with the update-sql command

liquibase update-sql --changelog-file=<changelog.xml>

If the SQL that Liquibase generates isn't what you expect, you should review your changelog file and make any necessary adjustments.

4. Then execute these changes to your database with the update command:

liquibase update --changelog-file=<changelog.xml>

If your update is successful, Liquibase runs each changeset and displays a summary message ending with:

Liquibase: Update has been successful. Liquibase command 'update' was executed successfully.

5. From a database UI tool, ensure that your database contains the test_table object you added along with the DATABASECHANGELOG table and DATABASECHANGELOGLOCK table.