How to Apply Your Liquibase Pro License Key

Liquibase Pro license key allows using all the functionality of Liquibase Community as well as the following features:

  • Access to reporting, monitoring, and insights with Liquibase Hub
  • Targeted rollbacks for one change or set of changes
  • Enhanced stored logic capabilities
  • Database drift detection
  • SQL Plus integration

Note: To take advantage of all Liquibase Pro features, it is recommended to use the latest version of Liquibase.

Apply your Liquibase Pro license key

There are several ways to apply the Liquibase Pro license key:

  1. Include the Liquibase Pro license key in the Liquibase properties file and save it. For example:
    liquibaseProLicenseKey: aei76ou32thp785463214
  2. Pass the Liquibase Pro license key as an argument in the command line during runtime:
  3. liquibase --liquibaseProLicenseKey=[paste the Liquibase Pro license key] [command]

    For example:

    liquibase --liquibaseProLicenseKey=aei76ou32thp785463214 update
  4. Set the Liquibase Pro license key as an environment variable in the command line.
  5. On Windows:

    set LIQUIBASE_PRO_LICENSE_KEY=aei76ou32thp785463214

    On Linux/macOS:

    export LIQUIBASE_PRO_LICENSE_KEY=aei76ou32thp785463214
  6. Set the Liquibase Pro license key as a JAVA_OPTS Environment Variable in the command line:
  7. JAVA_OPTS="Dliquibase.liquibaseProLicenseKey=<enter license key here>"

    For more information, see Liquibase Environment Variables.

  8. Pass the Liquibase Pro license key while using a docker container. Dockers allow the use of --env in the command.
  9. docker run --env LIQUIBASE_PRO_LICENSE_KEY=<enter license key here>...  \
    -it liquibase/liquibase:latest sh
  10. If you use Maven, include the Liquibase Pro license key in the <properties> section of your pom.xml file:
  11. <liquibase.liquibaseProLicenseKey>key-goes-here</liquibase.liquibaseProLicenseKey/>

    For example:

    <plugin>
        <groupId>org.liquibase</groupId>
        <artifactId>liquibase-maven-plugin</artifactId>
        <version>0-SNAPSHOT</version>
        <configuration>
            <changelog-file>com/example/changelog_v4.6.xml</changelog-file>
            <liquibaseProLicenseKey>key-goes-here</liquibaseProLicenseKey>
        </configuration>
    </plugin>
  12. If you use Azure DevOps and pass your license key as an environment variable, you can set the value of LIQUIBASE_PRO_LICENSE_KEY in your Azure DevOps pipeline setting file:
  13. script: |
        echo "Running Quality Checks"
        liquibase --changeLogFile=mysqlChangelog.xml checks run
    displayName: 'Run Quality Checks'
    env:
        LIQUIBASE_PRO_LICENSE_KEY: $(LiquibaseProKey)

    In this example, LiquibaseProKey is the name of the Azure DevOps project variable whose value is the license key.

To verify that your Liquibase Pro license key works as expected and to check its expiration date, you can run the status command.

Note: It is best to use a tool like Hashicorp Vault, CyberArk, or another credential management tool to keep Liquibase license keys secure.

Related Links