Using 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 Xpand, ColumnStore, and MaxScale.
  • 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.

Supported versions

  • 10.X

Verification level

MariaDB: Guaranteed: All applicable Liquibase Open Source and Liquibase Pro functionality works with this database. Verified by automated and real-world testing from Liquibase. The Liquibase support team provides best-effort usage, bug-fix, and prioritized feature request support to Commercial users.

MariaDB AWS RDS: Unverified: Liquibase has not assessed how well this database works. Not supported by the Liquibase customer support team.

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

Prerequisites

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

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/internal/lib directory. Read more: Adding and Updating Liquibase Drivers.

If you use Maven, you must include the driver JAR as a dependency in your pom.xml file. Read more: Configuring Liquibase Attributes in your Maven POM File.

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

Test your connection

  1. Ensure your MariaDB is configured:
  2. 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:
  3. 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.

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