Liquibase with MariaDB, SkySQL, or MariaDB AWS RDS

MariaDB delivers operational agility with key enterprise features, including real ACID compliance and full SQL. It provides two solutions:

• MariaDB Platform, which includes an open-source database solution—MariaDB Server along with ColumnStore and MaxScale.
  

  Note: MariaDB Xpand is not currently supported.

• MariaDB Cloud (or MariaDB SkySQL), which is a cloud database service (DBaaS) that delivers MariaDB Platform on the expert-maintained cloud infrastructure from MariaDB Corporation.

You can also use MariaDB on Amazon RDS. For more information about MariaDB, see the MariaDB Knowledge Base.

Verified database versions

MariaDB Server, AWS RDS – MariaDB, MariaDB SkySQL

• 11.4 (LTS)
• 10.6 (LTS)

Prerequisites

1. Download and Install Liquibase on your machine.
2. Ensure Java is installed: Liquibase requires Java to run. If you used the Liquibase Installer, Java is included automatically. Otherwise, you must install Java manually.
3. If you use Liquibase Pro, or a Liquibase Pro extension, confirm that you have a valid license key. For more information, see How to Apply Your Liquibase Pro License Key

Warning: If you create the Liquibase properties file, do not name it mariadb.properties. This file name conflicts with a properties file that is released with the MariaDB driver.

Install drivers

CLI users

To use Liquibase and MariaDB, you need the JDBC driver JAR file (Maven download).

The latest version of Liquibase has a pre-installed driver for this database in the $LIQUIBASE_HOME/internal/lib directory, so you don't need to install it yourself.

Tip: $LIQUIBASE_HOME is an environment variable that points to the location of the directory where Liquibase is installed on your machine. You can set environment variables using your operating system's shell. The location of $LIQUIBASE_HOME will depend on where Liquibase was installed on your machine.

Maven users

To use Liquibase with Maven, include the driver JAR(s) as a dependency in your pom.xml file. Using this information, Maven automatically downloads the driver JAR from Maven Central when you build your project.

<dependency>
    <groupId>org.mariadb.jdbc</groupId>
    <artifactId>mariadb-java-client</artifactId>
    <version>3.0.6</version>
</dependency>

Configure connection

1. Ensure your MariaDB is configured:
• MariaDB Server
• MariaDB SkySQL
• MariaDB on AWS RDS
2. Specify the database 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. You can either specify the full database connection string or specify the URL using your database's standard connection format:
• MariaDB Server
• MariaDB SkySQL
• MariaDB on AWS RDS

Tip: To apply a Liquibase Pro key to your project, add the following property to the Liquibase properties file: licenseKey: <paste code here>

Test connection

1. Create a text file called changelog (.sql, .yaml, .json, or .xml) 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 to only add the changeset and to not duplicate the changelog header.

• SQL example
• YAML example
• JSON example
• XML example

--liquibase formatted sql

--changeset your.name:1
CREATE TABLE test_table (test_id INT NOT NULL, test_column INT, PRIMARY KEY (test_id) NOT ENFORCED)

Tip: Formatted SQL changelogs generated from Liquibase versions before 4.2.0 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.

databaseChangeLog:
   - changeSet:
       id: 1
       author: your.name
       changes:
       - createTable:
           tableName: test_table
           columns:
           - column:
               name: test_id
               type: INT
               constraints:
                   primaryKey:  true
                   nullable:  false
           - column:
               name: test_column
               type: INT

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "1",
        "author": "your.name",
        "changes": [
          {
            "createTable": {
              "tableName": "test_table",
              "columns": [
                {
                  "column": {
                    "name": "test_id",
                    "type": "INT",
                    "constraints": {
                      "primaryKey": true,
                      "nullable": false
                    }
                  }
                },
                {
                  "column": {
                    "name": "test_column",
                    "type": "INT"
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

<?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="your.name">
        <createTable tableName="test_table">
            <column name="test_id" type="int">
                <constraints primaryKey="true" nullable="false" />
            </column>
            <column name="test_column" type="int"/>
        </createTable>
    </changeSet>

</databaseChangeLog>

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.

Now you're ready to start deploying database changes with Liquibase!

MariaDB Server

• Check the status of the database by running the SHOW [GLOBAL | SESSION] STATUS command.
• Specify the database URL in the Liquibase properties file, as follows:

url: jdbc:mariadb://<host>:<port>/<dbname>

MariaDB SkySQL

• Check the connection by referring to the Client Instructions. To connect to MariaDB SkySQL, you need to whitelist your IP, choose a client and a database, and use service details as the connection information.
• Download the skysql_chain.pem certificate. Go to your MariaDB SkySQL account and select Your Services > Show Credentials > Certificate authority chain > Download. Place the certificate in your Liquibase project folder.
• Specify the database URL in the liquibase.properties file as follows:

url: jdbc:mariadb://<host>:<port>/<dbname>?useSSL=true&serverSslCert=skysql_chain.pem

You can find the needed host name under Connect using MariaDB CLI by selecting Your Services > Show Credentials:

Example: url:jdbc:mariadb://sky0001680.mdb0001652.db.skysql.net:5001/myDatabase?useSSL=true&serverSslCert=skysql_chain.pem

MariaDB on AWS RDS

• Check the connection by using the mysql utility and running the following:

mysql -h <endpoint> -P 3306 -u <mymainuser> -p

Note: The alternative way is to connect with the SSL certificate.

You can find the connection information in the AWS Management Console:

1. Open the Amazon RDS console
2. Select Databases and choose the needed database
3. Select Connectivity & security. You will see all information under Endpoint & Port.

To find the connection information using the AWS CLI and RDS API, refer to the Connecting to a DB instance running the MariaDB database engine documentation.

• Specify the database URL in the Liquibase properties file, as follows:

url: jdbc:mariadb://<endpoint>:<port>/<dbname>

Example: url:jdbc:mariadb://myrds.cz1j1vh9uvuo.us-east-1.rds.amazonaws.com:3306/mydatabase

Related links

• MariaDB Documentation
• MariaDB on Amazon RDS Documentation
• Change Types
• Concepts
• Liquibase Commands
• Workflows