How to Apply Your Liquibase Pro License Key
Liquibase Pro offers all the functionality of Liquibase Open Source as well as the following features:
- Targeted rollbacks for one change or set of changes
- Enhanced stored logic capabilities
- Database drift detection
- Quality Checks
- Native executors for PSQL, SQL Plus, and SQLCMD
- Remote file access with S3
- Secrets Management
- Portable and centralized workflows
- Structured Logging
- Operation Reports
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:
- Pass the Liquibase Pro license key as an argument in the command line during runtime:
- Set the Liquibase Pro license key as an environment variable in the command line.
- Set the Liquibase Pro license key with the JAVA_OPTS Environment Variable in the command line:
- Pass the Liquibase Pro license key while using a docker container. Dockers allow the use of
--envin the command.
- If you use Maven, include the Liquibase Pro license key in the
<properties>section of your
- If you use Azure DevOps and pass your license key as an environment variable, you can set the value of
LIQUIBASE_LICENSE_KEYin your Azure DevOps pipeline setting file:
liquibase --license-key=[paste the Liquibase Pro license key] [command]
liquibase --license-key=aei76ou32thp785463214 update
JAVA_OPTS="Dliquibase.liquibaseLicenseKey=<enter license key here>"
For more information, see Liquibase Environment Variables.
docker run --env LIQUIBASE_LICENSE_KEY=<enter license key here>... \ -it liquibase/liquibase:latest sh
<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>
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.