Using Liquibase with EnterpriseDB

EnterpriseDB (EDB) Postgres Advanced Server extends the administrative, security, analytic, and development functionality of the Postgres database. For more information, see EnterpriseDB documentation.

Verified versions

Note: As of November 9, 2023, EnterpriseDB 11 is deprecated and Liquibase support for this version ends on February 18, 2024. Other versions will remain supported.

  • 14
  • 13
  • 12

Verification level

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 Database Verification Levels.

Advanced: Database has been tested and validated to deliver a minimum set of advanced capabilities around database inspection, support for long-running operations, as well as the Foundational level's basic functionality of change management and change tracking aligned with the database. The advanced database inspection capabilities include the ability to generate changelogs in at least one format and the support of at least two additional state-based commands (snapshots, diffs, etc). The Liquibase customer support team provides how-to/usage support around verified capabilities for commercial customers.

Prerequisites

  1. Introduction to Liquibase – Dive into Liquibase concepts.
  2. Install Liquibase – Download Liquibase on your machine.
  3. Get Started with Liquibase – Learn how to use Liquibase with an example database.
  4. Design Your Liquibase Project – Create a new Liquibase project folder and organize your changelogs
  5. How to Apply Your Liquibase Pro License Key – If you use Liquibase Pro, activate your license.

Install drivers

To use Liquibase and EDB, you need the JDBC driver JAR file.

Place your JAR file(s) in the liquibase/lib directory. If you use Maven, note that this database does not provide its driver JAR on a public Maven repository, so you must install a local copy and add it as a dependency to your pom.xml file.

Test your connection

  1. Ensure your EnterpriseDB database is configured. Install EDB Plus and verify the connection with your EDB database.
  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 JDBC format:
  3. url: jdbc:edb://<hostname>:5444/<dbname>

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

  1. Create a text file called changelog (.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.

  2. Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful:
  3. 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_jdbc_url>
    Liquibase command 'status' was executed successfully.
  4. Inspect the deployment SQL with the update-sql command:
  5. liquibase update-sql --changelog-file=<changelog.xml>
  6. Then make changes to your database with the update command:
  7. 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.
  8. 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 making deployments with Liquibase!

Related links