Using Liquibase with H2

H2 is a standard SQL database that you can use to simulate anything required to be done in your own database.

Note: For more information, see the H2 page.

The web-based console allows you to see all objects in your database in the left navigation and run SQL statements on the right side. The console includes the Refresh button, which you can use to reload the left-side object view if you make changes to your database with Liquibase.

Supported Versions

  • 1.4.200
  • 2.1.210 – officially certified and tested with Test Harness

Prerequisites

Before using Liquibase with your database, ensure you have:

Note: Instead of creating a new Liquibase project folder, you can also use the example directory included in the installation package for the H2 database.

Install Drivers

To use Liquibase and H2, you need to have the JDBC driver JAR file. Liquibase includes the H2 in-memory database and the h2-version.jar file in liquibase/lib in the installation package. For more information, see Adding and Updating Liquibase Drivers.

If you use Maven, put the H2 driver in a location that your Maven build can access. Configure the Maven pom.xml file to use the local copy of the driver jar file. For example:

<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <version>1.4.200</version>
</dependency>

Test Your Connection

For Liquibase and H2 to work, you need to:

  1. Start the H2 database by navigating to the examples folder in the CLI and running liquibase init start-h2.
  2. Tip: The examples folder stores the H2 database start-h2.bat, the sample SQL, XML. YAML, and JSON changelogs, and the Liquibase properties file.

    Note: To stop the example H2 database, you can use ctrl-c.

    The init start-h2 command starts a local H2 database on port 9090 and opens the database console on the same port in the browser.

    Note: The example H2 database does not store data and will reset to its starting state when the init start-h2 process ends.

    • A developer database corresponds to what you may use as a local database.
    • An integration database corresponds to another database in your pipeline.

    You can view the integration database with the link provided from the developer database browser. The URL, which is at the top of the object view, shows to which database you are connected.

  1. Check the status of the database by entering create table test_table (id int) in the text area and select Run. You will see TEST_TABLE appear in the object view.
  2. Create a text file called changelog (.xml, .sql, .json, or .yaml) in your project directory and add a changeset.
  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. Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful. You can pass arguments in the CLI or keep them in the Liquibase properties file.
  2. liquibase --username=test --password=test --changelog-file=<changelog.xml> status
  3. Run your first update with the update command, which makes changes to your database. You can also run the update-sql command to inspect the SQL before running the update command.
  4. liquibase --changelog-file=<changelog.xml> update-sql
    liquibase --changelog-file=<changelog.xml> update

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

Related Links