Formations — 1 037 leçons en français

Accueil › Spring Boot › Liquibase et bonnes pratiques de migration

Liquibase et bonnes pratiques de migration

Migrations de base de donnéesintermediaire

Liquibase est, comme Flyway, un outil de gestion de migrations : il applique des changements de schéma versionnés et garde une trace de ce qui a été exécuté. Sa différence principale est de proposer, en plus du SQL brut, une description abstraite des changements (les changeTypes), que Liquibase traduit dans le dialecte SQL du SGBD cible.

Avec Spring Boot, le point d'entrée est un changelog maître, par défaut src/main/resources/db/changelog/db.changelog-master.yaml, qui référence les autres fichiers :

databaseChangeLog:
  - include:
      file: db/changelog/changes/001-creer-table-produits.yaml
  - include:
      file: db/changelog/changes/002-ajouter-colonne-categorie.yaml

Chaque fichier référencé contient un ou plusieurs changeSet, identifiés par id + author :

databaseChangeLog:
  - changeSet:
      id: 001-creer-table-produits
      author: alice
      changes:
        - createTable:
            tableName: produits
            columns:
              - column:
                  name: id
                  type: BIGINT
                  autoIncrement: true
                  constraints:
                    primaryKey: true
              - column:
                  name: nom
                  type: VARCHAR(100)
                  constraints:
                    nullable: false

Liquibase accepte aussi le XML et le SQL (avec des commentaires spéciaux --changeset author:id) comme formats de changelog : le YAML est courant dans les projets Spring Boot récents, mais les trois formats sont interchangeables et peuvent même être mélangés via include.

Les termes à connaître

Changelog maître

Fichier racine qui référence tous les changelogs d'un projet, lu au démarrage par Liquibase. Emplacement par défaut avec Spring Boot : classpath:/db/changelog/db.changelog-master.yaml (propriété spring.liquibase.change-log).

changeSet

Unité de changement identifiée par un couple id + author (et le chemin du fichier qui le contient). C'est cette combinaison, pas seulement l'id, qui doit être unique : Liquibase l'utilise pour savoir si le changeSet a déjà été appliqué.

DATABASECHANGELOG

Table créée par Liquibase pour enregistrer chaque changeSet exécuté (id, author, chemin du fichier, checksum, date, ordre). Équivalent Liquibase de la flyway_schema_history de Flyway.

DATABASECHANGELOGLOCK

Table utilisée par Liquibase pour empêcher deux instances de l'application d'appliquer les migrations en même temps. Si une instance s'arrête brutalement pendant une migration, le verrou peut rester posé et bloquer les démarrages suivants tant qu'il n'est pas libéré manuellement.

rollback

Annulation d'un changeSet. Pour de nombreux changeTypes (createTable, addColumn…), Liquibase déduit automatiquement l'opération inverse. Pour les autres (ex. une modification de données), un bloc rollback explicite doit être écrit.

Contexts et labels

Deux mécanismes de filtrage des changeSet selon l'environnement. Un context (ex. test) s'associe à des données ou changements propres à un environnement ; un label permet un filtrage additionnel, avec des expressions plus riches (prod & !batch). Les deux se configurent via spring.liquibase.contexts / spring.liquibase.labels.

spring.liquibase.change-log

Propriété qui indique l'emplacement du changelog maître si celui-ci n'est pas à l'emplacement par défaut. D'autres propriétés utiles : spring.liquibase.enabled, spring.liquibase.default-schema, spring.liquibase.parameters.* (valeurs injectées dans le changelog).

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.