Embedded Files
Liquibase is a Java-based application that runs on minimal hardware.
To use Liquibase, Java must be installed on your host machine. For detailed system requirements, visit the Liquibase documentation requirements page.
To download and install Java, visit the Java.com downloads page.
This section will walk you through the following steps:
Install Liquibase.
Apply the Liquibase Pro license key.
Install drivers.
Validate the Liquibase Pro install and license key.
Procedure
Procedure
1. Install Liquibase
1. Install Liquibase
Liquibase works on Windows, Linux, and MacOS.
Liquibase is also available in a Docker image via Docker Hub. Since installation is unnecessary, you should be able to pull the Liquibase Docker image into your setup using the docker pull liquibase command and then run Liquibase using one of the docker run commands provided in the Docker Hub.
If using Liquibase Docker image, skip down to "2. Apply the Liquibase Pro License Key" section.
We can also provide links to the Dockerfile if you want to customize the official Liquibase Docker image and host it internally in your private Docker image repository.
Download the latest Liquibase release
Download the latest Liquibase release
The simplest way to install Liquibase is to download the liquibase-<version>.zip file from the Liquibase GitHub releases page using the latest tag:
Scroll to the Assets section for the liquibase-<version>.zip file and download to your local machine.
A list of Liquibase software assets where the desired ZIP file is being identified.
Extract the zip file to a local directory
Extract the zip file to a local directory
Extract the contents to a local directory.
For example:
In Linux, extract the zip file into /opt/liquibase/liquibase-<version> directory.
In Windows, extract the zip file into the C:\liquibase\liquibase-<version> directory.
In MacOS, extract the zip file into ~/liquibase/liquibase-<version> directory.
Create a symbolic link to Liquibase
Create a symbolic link to Liquibase
By creating a symbolic link to the latest version of Liquibase, DevOps engineers can control which version of Liquibase is executed at install time. This method allows the pipeline maintainer to link a specific version of Liquibase, reducing confusion.
Update the path environment variable
Update the path environment variable
Once the Liquibase file is unzipped, ensure the PATH environment variable is updated to point to the “liquibase” symbolic link.
Restart the shell session to load the new changes.
2. Apply the Liquibase Pro license key
2. Apply the Liquibase Pro license key
If you have your Liquibase Pro license key, follow the instructions on the documentation page to apply the Pro key.
Add the following line to liquibase.properties file:
liquibase.licenseKey: YouRKeyHere.
Add the following argument to the docker run command:
docker run --env LIQUIBASE_LICENSE_KEY=<enter license key here> -it liquibase:latest update
You can also obtain a Liquibase Pro 30-day trial license key here.
3. Install drivers
3. Install drivers
The Liquibase installation already comes with JDBC drivers for popular database platforms such as Oracle, SQL Server, PostgreSQL, MariaDB, Snowflake, and H2.
If you are working with a different Liquibase-supported database, visit the Liquibase Database Tutorials documentation page to download the JDBC driver specific to your database.
4. Validate the Liquibase Pro install and license key
4. Validate the Liquibase Pro install and license key
You can validate the Liquibase Pro install and check for the Pro license key locally.
Run the liquibase --version command to ensure Liquibase can access the Pro key. You should also see the drivers related to your database type(s).
If using the Docker image, run the following docker run command:
docker run --env LIQUIBASE_LICENSE_KEY=<your license key here> -it liquibase:latest --version
Below is an example output:
What to do next
What to do next
Page updated
Report abuse