Using Liquibase with MySQL

MySQL is a fast, multi-user SQL database service. MySQL Server is intended for mission-critical, heavy-load production systems as well as for embedding into mass-deployed software. For more information, see the MySQL documentation page.

Supported versions

  • 8.0
  • 5.7
  • 5.6
  • 5.5

Verification level

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.

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

Install drivers

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

Place your JAR file(s) in the liquibase/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>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.30</version>
</dependency>

Test your connection

  1. Ensure your MySQL 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:
  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.

MySQL Server

  • Ensure your MySQL is configured. You can check the status by running:
    • The sudo service mysql status command for Linux.
    • The net start MySQL or services.msc command for Windows. The services.msc command will open a new window and display the list of services available on your system. Find MySQL and check the status column. You can also run mysql -u root -p to see if MySQL works.
  • Specify the database URL in your liquibase.properties file:
  • url: jdbc:mysql://<servername>:<port>/<dbname>

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

MySQL on AWS RDS

  • Check the connection by using the mysql command-line client 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 MySQL database engine documentation.

  • Specify the database URL in the liquibase.properties file as follows:

  • url: jdbc:mysql://<endpoint>:<port>/<dbname>

    Example: url:jdbc:mysql://mydb.123456789012.us-east-1.rds.amazonaws.com:3306/myTestDB?autoReconnect=true&useSSL=false

Related links