How to Apply Your Liquibase Pro License Key

Liquibase Pro offers all the functionality of Liquibase Open Source as well as the following features:

For more information, see Liquibase Pro Workflows.

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

Tip: It is best to use a Secrets Management tool like Hashicorp Vault or AWS Secrets Manager to keep Liquibase license keys secure.

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

  • Include the Liquibase Pro license key in the Liquibase properties file and save it. For example:
    liquibase.licenseKey: aei76ou32thp785463214

  • Pass the Liquibase Pro license key as an argument in the command line during runtime:
    • liquibase --license-key=[paste the Liquibase Pro license key] [command]

    For example:

    liquibase --license-key=aei76ou32thp785463214 update

  • Set the Liquibase Pro license key as an environment variable in the command line.

    • On Windows:

    set LIQUIBASE_LICENSE_KEY=aei76ou32thp785463214

    On Linux/macOS:

    export LIQUIBASE_LICENSE_KEY=aei76ou32thp785463214

  • Set the Liquibase Pro license key with the JAVA_OPTS Environment Variable in the command line:
    • JAVA_OPTS="Dliquibase.liquibaseLicenseKey=<enter license key here>"

    For more information, see Liquibase Environment Variables.

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

    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>
        <liquibaseLicenseKey>key-goes-here</liquibaseLicenseKey>
    </configuration>
</plugin>
  • If you use Azure DevOps and pass your license key as an environment variable, you can set the value of LIQUIBASE_LICENSE_KEY in your Azure DevOps pipeline setting file:
    • script: |
    echo "Running Quality Checks"
    liquibase checks run --changeLogFile=mysqlChangelog.xml
displayName: 'Run Quality Checks'
env:
    LIQUIBASE_LICENSE_KEY: $(LiquibaseKey)

    In this example, LiquibaseKey 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: The syntax liquibase.pro.licenseKey (rather than liquibase.licenseKey) is deprecated by Liquibase, but still works.

    Related links