Liquibase vs. Flyway
Understand the differences and similarities of these two database migration tools so you can decide which one will work best for your use case, team structure, and workflow.
Anyone who has ever developed software will tell you, you shouldn’t develop application code without version control. The same is true for database code. With the rise of Agile and DevOps methodologies that are needed to accomplish continuous integration and deployment, it’s more important than ever to apply CI/CD to databases. There are two leading open source tools for database version control: Liquibase and Flyway. Both have become popular options for versioning and organizing database changes, deploying changes when they need to be deployed, and tracking what’s been deployed.
Here’s what Flyway and Liquibase have in common:
- Use a migrations-based approach to database change
- At update time, both tools check if a change has already been deployed
- Run from command line or Maven
- Offer support and enhanced features as a paid add-on to their open source offering
- Use SQL-based migrations (both can use plain old SQL)
- Repeatable migrations (both can perform rerunnable vs. non-rerunnable changes)
Differences between Liquibase and Flyway
The way changes are defined
Flyway uses SQL exclusively. (This means you need to manually create and specify the SQL you want). Some people love that. Some people find it restricting.
Liquibase can use plain old SQL, but it also allows you to specify the change you want in several different abstract, database-agnostic formats including XML, YAML, and JSON. Liquibase makes it easy to define database changes in a format that’s familiar and comfortable to each user and then automatically generates database-specific SQL for you.
Script and file management
When it comes to scaling for multiple developers and the ability to branch/merge, Liquibase and Flyway handle this differently.
With Flyway, the filename is king.
This can have limitations. Let’s take a closer look.
Flyway is built around a concept of a linear database versioning system which starts at version 1. After a change is added, the version is incremented to 2, then 3, etc. Users often end up doing gymnastics with filenames to manage execution order. For example, changes 1, 2, 3, 4, 5 are all deployed. Now imagine you want to add a change between 2 and 3,so you add a "2.5". What happens to environments where 1-5 were already deployed? Version control systems, like Git, can’t handle this for you.
Another limitation comes to light when you’re working on a team with other developers and there’s a filename conflict or a change ordering issue. All of these scenarios — adding a new change, filename conflicts, and reordering changes — need to be dealt with manually when using Flyway.
With Liquibase, changes are managed with one ledger, referred to as the changelog.
Liquibase uses a unique identification scheme: an ID and author, along with the name and path of the file all in a changelog. This makes it easy to manage the order in which database changes are made. This way of managing the changes makes developer conflicts and collisions less likely since there are multiple factors that drive the uniqueness of a given change. The only possible problems you can encounter are with XML merge conflicts, which can typically be resolved with version control systems like Git.
With Liquibase, it’s also easy to reorder changes in the changelog when you need to roll out changes to lower environments.
Rework and selective deployments
Let’s face it, rework happens. It happens to all of us, every day. Nobody gets everything right the first time.
Flyway can be pretty unforgiving when it comes to reworking database changes and performing selective deployments.
Reworking changesWith Flyway, users have two options for reworking changes: roll everything back or purchase their Pro or Enterprise offerings for undo functionality. With the open source version of Flyway, there’s no real way to automate or clean up an environment where a bad change has been deployed.
The free version of Liquibase allows you to undo changes you have made to your database, either automatically or via custom rollback SQL with the rollback command.
If your use case requires you to selectively deploy changes, it’s harder to do that with Flyway than it is with Liquibase. Let’s say you want to only deploy to a test environment and you’re managing scripts that populate certain configuration or test data to that environment. With Flyway, you would have to set up a different configuration (properties file) for each of the affected environments in order to only apply certain changes to those specific databases. Since Liquibase uses one ledger (changelog), it’s more straightforward to add labels and contexts to ensure that this is set up in one place.
Liquibase has a powerful feature called preconditions. Preconditions allow users to apply changes based on certain conditions such as to check whether or not a table exists or for another example to check whether a column contains data before dropping it. This allows you to control whether or not a change should be applied or not based on the state of the database. A changeset will only execute if the precondition passes. If the precondition fails, you can tell Liquibase what you’d like to happen next, such as
HALT, WARN, MARK_RAN, etc. Flyway does not do this.
Liquibase Pro enables users to snapshot and work with Stored Logic. Snapshots allow you to get a static view of your database at a particular point in time and is useful for reporting and safeguarding your data by comparing databases (performing diffs) to find differences.
Since Flyway only uses SQL, the expectation is for users to generate the SQL themselves using a database’s native tool to export the SQL. Or alternatively, the developer would just write the stored procedure as a SQL file for Flyway to deploy as needed. SQL files that contain stored logic would have to be named differently than other files (for example, use an “R_” prefix rather than a “V1.2_” prefix.
Flyway also doesn't have the ability to perform a diff to compare two databases, like Liquibase — Flyway expects that you will also use some external tool to do this. This also means Flyway users can't do the equivalent of diffChangeLog.
Wrapping it up
Both Liquibase and Flyway are tools that help with managing, tracking, and deploying database schema changes. They are both migration-based tools that are looking to fill a need that many teams have for treating database code like app code with source control and automation.
Flyway can solve your Day One problems: managing, tracking, and deploying database schema changes. Flyway’s file structure and raw SQL focus work fine at the beginning. It’s easy and quick. However, everyone eventually hits the rollback/rework/merge/conditional logic use cases.
Liquibase has the power and flexibility to handle your Day One problems AND your Day 50 problems more gracefully from the get-go. Sure, there are workarounds for Flyway to handle some of these more complex needs, but they’re not pretty. Liquibase handles these very typical database schema problems in stride.
There are always tradeoffs to make when choosing between tools. If you are looking for a tool that checks the following boxes, Liquibase may be right for you:
- Define database changes in a format that’s familiar and comfortable to each user and then automatically generates database-specific SQL
- Support updating and managing the same schema across multiple database vendors using the same changelog file
- Easily add new changes and reorder them without running into filename conflicts
- Rollback changes without having to purchase a paid offering
- Snapshot and work with Stored Logic (including reverse engineering)
- Selectively deploy changes as needed to different environments
Give Liquibase a try to take a closer look and check out all the great features we covered in this comparison.