Инструментарий для рефакторинга баз данных: Flyway vs. Liquibase

Автор оригинала: Tom Hombergs
  • Перевод

В этой статье мы поговорим о Flyway и Liquibase — двух наиболее популярных инструментах на основе Java для рефакторинга баз данных. Цель статьи — сравнить эти инструменты и выяснить, какой из них в каких случаях лучше применять.


DB omnibus


Flyway


Концепция Flyway сосредоточена вокруг шести различных команд для поддержки автоматизированного рефакторинга и версионирования БД. Эти команды могут исполняться из командной строки, в процессе сборки (производимого с помощью Maven или Gradle) или непосредственно из Java-кода с помощью вызовов API. При исполнении этих команд вам необходимо предоставить параметры подключения к той БД (url, имя пользователя, пароль), которую вы хотите рефакторить.


Основная команда называется migrate и выполняет функцию, в которой заключается вся суть рефакторинга БД: она сканирует специальную папку с sql-скриптами (у каждого из которых в имени файла указан номер версии) и проверяет, какие из них уже применялись к целевой базе данных. Затем она исполняет те из них, которые еще не применялись к этой БД. В случае возникновения противоречий, например, если уже примененный скрипт изменился со времени его применения, Flyway прерывает процесс своей работы сообщением об ошибке.


Уникальной чертой Flyway является то, что скрипты миграции могут быть не только в формате SQL, но и в виде Java-кода. Второй вариант позволяет реализовывать динамические миграции со сложной логикой. Однако использовать Java-подход следует с осторожностью, так как подобные скрипты миграции обычно тяжело дебажить, если в них что-то пошло не так.


Помимо основной команды migrate у Flyway есть дополнительные команды, облегчающие процесс рефакторинга БД.


Команда info показывает все доступные скрипты миграции из заданной папки и отмечает, какие из них уже были использованы, а какие только будут применены к целевой БД.


Чтобы проверить, изменялись ли скрипты, примененные к БД, используется команда validate. Нам полезно знать, был ли уже примененный скрипт из папки изменен с момента его применения к БД, потому что это может означать, что скрипт применялся к разным БД в разных версиях, а это может вызывать проблемы.


Если вы считаете, что скрипты нужно применять несмотря на сбой, показанный командой validate, то можно запустить команду repair. Она сбросит таблицу БД, используемую Flyway для фиксации того, какие скрипты были уже применены (по умолчанию эта таблица называется SCHEMA_VERSION).


И последняя, но не менее важная, команда clean полностью очищает выбранную схему (как вы понимаете, эта команда должна использоваться только для тестовых БД).


Liquibase


Liquibase использует другой подход к реализации рефакторинга БД. В отличие от Flyway, которая поддерживает скрипты миграции только в форматах SQL и Java, Liquibase позволяет абстрагироваться от SQL и таким образом устранить привязку рефакторинга базы данных к ее конкретной реализации.


Вместо SQL-скриптов, Liquibase поддерживает скрипты миграции в форматах XML, YAML и JSON. В этих скриптах вы определяете изменения в БД на уровне абстракций. Для каждого изменения Liquibase имеет соответствующий элемент в XML, YAML и JSON. Например, изменение, создающее новую таблицу БД в формате YAML выглядит так:


createTable:
  tableName: Customer
  columns:
  - column:
      name: name
      type: varchar(255)
  - column:
      name: address
      type: varchar(255)

Изменения типа add column, create index или alter table и другие выглядят схожим образом.
Во время работы Liquibase автоматически применяет все скрипты, которые еще не применялись, и, как и Flyway, сохраняет их метаданные в специальную таблицу БД. Аналогично Flyway, Liquibase можно вызвать из командной строки инструментов сборки или непосредственно через его Java API.


В каких случаях их использовать?


И Flyway, и Liquibase поддерживают все функции, необходимые для профессионального рефакторинга и версионирования БД, так что вы всегда будете знать, с какой версией схемы БД вы имеете дело и соответствует ли она версии вашего ПО. Оба тула интегрированы с Maven и Gradle и в экосистему Spring Boot, так что рефакторинг БД можно полностью автоматизировать.


Flyway использует SQL для определения изменений БД, так что можно настроить SQL-скрипты так, чтобы они эффективно работали с конкретными типом базы данных на вашем проекте, например с Oracle или с PostgreSQL. С другой стороны, Liquibase вводит дополнительный уровень абстракции с помощью XML, YAML или JSON для определения изменений БД. Таким образом, Liquibase лучше подходит для ПО, которое нужно устанавливать в разных окружениях с разными типами серверов БД. Однако если вам нужен полный контроль над вашим SQL, ваш выбор — Flyway, так как он позволяет изменять БД с помощью полностью кастомного SQL или даже с использованием Java-кода.


Подвох с обоими инструментами в том, что они поддерживаются одним человеком (от переводчика: по информации автора), а не большой командой. Это может оказать негативное влияние на будущее развитие обоих тулов, однако это не обязательно. На момент написания этой статьи активность в GitHub-репозитории Flyway выше, чем в репозитории Liquibase.

Haulmont
171,00
Создаем современные корпоративные системы
Поделиться публикацией

Комментарии 12

    +4
    только я со взглядом горячим, потирая потные ручонки в предвкушении, клацнул по ссылке с таким вкусным заголовком, как статья раз, и закончилась… печаль…
      0

      Ну тут я ничего не могу поделать, оригинальная статья тоже небольшая. Главная идя тут все же дать людям, не знакомым с этими решениями направление куда дальше копать ))

        +4
        Мало того, что статья крайне маленькая, так она ещё и неверная. В Liquibase совершенно спокойно можно писать changeset-ы как на чистом SQL, так и на Java. Откуда взялась информация про «поддерживаются одним человеком» — вообще не понятно. Оба продукта очень зрелые и каждый поддерживается и развивается коммерческими компаниями (в случае Liquibase это Datical, в случае Flyway — Boxfuse). Ну и т.д.
          –1
          Формально Liquibase поддерживается Datical, но если брать opensource-версию, то там некоторое время назад все было настолько печально, что доходило до форков github.com/dbmanul/dbmanul, которые вроде бы залили назад. С другой стороны, действительно, продукту уже лет 10, так что основные проблемы закрыты, а патчи начали принимать активнее.
          А статья, действительно, бестолковая.
        0
        Нужно заметить, что Liquibase вполне себе поддерживает использование произвольного SQL-кода, для этого есть тег
        <sql>
          0

          Есть, не спорю. Однако, это скорее вспомогательный подход для Liquibase.
          При переводе оригинала, я несколько неудачно сформулировал фразу на русском, так сто она понималась как то, что Liquibase не позволяет использовать SQL вообще. ((


          Текст перевода поправил.
          Еще раз спасибо за замечания.

          0
          И даже больше, в Liquibase можно чанжсеты в sql файлах писать, управляя миграциями с помощью комментариев https://www.liquibase.org/documentation/sql_format.html, хотя такой подход все равно ограничен по сравнению со стандартными.
            +1
            В пользу liquibase еще хочу заметить наличие ролбеков из коробки (правда не для всех операций, но для большинства).
            Очень удобно: обновил БД, не работает ПО, вернул обратно.
              0
              Автор статьи, по какой-то причине, забыл упомянуть, что миграции liquibase могут включать роллбек шаги. Таким образом, там где Flyway просто упадет, liquibase может остановиться на проблемном месте и откатить операцию с ошибкой.
                0
                Если нужен только SQL + Java, то я за Flyway. Он легче, заточен на это. Легко позволяет иметь в одной базе несколько независимых модулей.
                • НЛО прилетело и опубликовало эту надпись здесь
                    0
                    Использую Flyway но недавно столкнулся с неприятностью. В проекте Oracle 11g поддержка которого платная. Тут и стал искать альтернативы и нашел Liquibase. Поигрался на тестовом проекте… как-то не так очевидно все там. Подумал… подумал… и подрубил 4.2 версию Flyway в которой есть бесплатная поддержка Oracle 11g.

                    Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

                    Самое читаемое