Intégrer Spanner à Liquibase

Cette page explique comment gérer les modifications de schéma de base de données Spanner avec Liquibase.

Liquibase est une bibliothèque Open Source indépendante de la base de données pour le suivi, la gestion et l'application des modifications de schéma de base de données. Elle est compatible avec le langage SQL ainsi qu'avec les formats déclaratifs tels que XML, YAML et JSON.

Liquibase peut cibler les bases de données Spanner. Il est compatible avec toutes les fonctionnalités de Spanner, avec certaines limites.

Pour connaître les limites générales, consultez la section Limites.
Pour en savoir plus sur les bases de données basées sur le dialecte PostgreSQL, telles que la configuration requise pour Liquibase, les types de modifications compatibles et les limites, consultez PGAdapter et Liquibase.

Installer Liquibase

Pour utiliser Liquibase avec des bases de données GoogleSQL, vous devez installer l'extension Spanner Liquibase. Pour les bases de données basées sur le dialecte PostgreSQL, Liquibase peut utiliser sa compatibilité intégrée avec PostgreSQL conjointement avec PGAdapter.

GoogleSQL

Suivez les instructions de la documentation sur Liquibase pour installer et configurer Liquibase, et pour prendre un instantané de votre base de données. Dans le fichier de configuration liquibase.properties, définissez la propriété url comme suit.
```
jdbc:cloudspanner:/projects/PROJECT/instances/INSTANCE/databases/DATABASE
```
Votre fichier de configuration liquibase.properties ne peut contenir que cette propriété. Les autres propriétés sont facultatives.
Accédez à la page des versions de l'extension Spanner Liquibase sur GitHub et sélectionnez la dernière version.
Sélectionnez et téléchargez le fichier JAR nommé liquibase-spanner-x.y.z-all.jar, où xyz représente le numéro de version de l'extension. Par exemple, liquibase-spanner-4.17.0-all.jar.
Placez le fichier JAR téléchargé dans le répertoire lib de Liquibase. Le fichier JAR inclut l'extension, le SDK Spanner et le pilote JDBC Spanner.

PostgreSQL

Assurez-vous que PGAdapter est démarré et en cours d'exécution sur la machine sur laquelle vous allez installer Liquibase. Pour en savoir plus, consultez Démarrer PGAdapter.
Suivez les instructions de la documentation sur Liquibase pour installer et configurer Liquibase, et pour prendre un instantané de votre base de données. Dans le fichier de configuration liquibase.properties, définissez la propriété url comme suit.
```
jdbc:postgresql://localhost:5432/DATABASE_NAME?options=-c%20spanner.ddl_transaction_mode=AutocommitExplicitTransaction
```
Votre fichier de configuration liquibase.properties ne peut contenir que cette propriété. Les autres propriétés sont facultatives.

La chaîne url doit inclure options=-c%20spanner.ddl_transaction_mode=AutocommitExplicitTransaction, car Spanner n'accepte pas les transactions LDD, ce qui garantit que les transactions LDD sont automatiquement converties en lots LDD. Pour en savoir plus, consultez la section Options LDD pour PGAdapter.

Examiner les exemples Liquibase

GoogleSQL

L'exemple de fichier journal des modifications changelog.yaml fourni avec l'extension GoogleSQL Liquibase illustre de nombreuses fonctionnalités de Liquibase et comment les utiliser avec Spanner.

PostgreSQL

L'exemple de fichier journal des modifications dbchangelog.xml disponible dans le dépôt GitHub PGAdapter et Liquibase présente de nombreuses fonctionnalités de Liquibase et explique comment les utiliser avec Spanner.

Guide de démarrage rapide de Liquibase

Ce guide de démarrage rapide vous explique comment utiliser Liquibase pour ajouter une table Singers à une base de données.

Avant de commencer

Assurez-vous d'avoir suivi les étapes précédentes pour installer Liquibase.
Créer une instance Spanner
Créez une base de données utilisant le dialecte GoogleSQL ou PostgreSQL.
Pour les bases de données basées sur le dialecte PostgreSQL uniquement, assurez-vous que PGAdapter est démarré et s'exécute sur la même machine que votre installation Liquibase. Pour en savoir plus, consultez Démarrer PGAdapter.
Pour les bases de données basées sur le dialecte PostgreSQL uniquement, créez les tables de métadonnées databasechangeloglock et databasechangelog à l'aide du script create_database_change_log.sql. Vous devez créer ces tables pour remplacer celles que Liquibase crée automatiquement dans votre base de données. Cela permet de garantir que les types de données PostgreSQL appropriés pour Spanner sont utilisés dans ces tables.

Vous pouvez exécuter le script à l'aide de la commande suivante:
```
psql -h localhost -d DATABASE_NAME -f create_database_change_log.sql
```
Attribuez à l'extension Liquibase Spanner un usage temporaire de vos propres identifiants utilisateur Spanner pour accéder à l'API en exécutant la commande gcloud suivante:
```
gcloud auth application-default login
```

Créer un fichier changelog.yaml

Saisissez le code YAML suivant dans votre éditeur favori.
```
databaseChangeLog:
  - preConditions:
     onFail: HALT
     onError: HALT

  - changeSet:
     id: create-singers-table
     author: spanner-examples
     changes:
       - createTable:
          tableName: Singers
          columns:
            -  column:
                name:    SingerId
                type:    BIGINT
                constraints:
                  primaryKey: true
                  primaryKeyName: pk_Singers
            -  column:
                name:    Name
                type:    VARCHAR(255)
```
Ce code YAML définit une table Singers avec une clé primaire SingerId et une colonne appelée Name pour stocker le nom du chanteur.

Pour les bases de données basées sur le dialecte PostgreSQL, nous vous recommandons d'utiliser des minuscules pour les noms de tables et de colonnes. Pour en savoir plus, consultez la section Sensibilité à la casse PostgreSQL.

Notez que l'ensemble de modifications createTable doit inclure une contrainte de clé primaire, et que le nom de cette contrainte doit être pk_table_name.
Enregistrez vos modifications sous le nom changelog.yaml.

Exécuter la liquibase

Appliquez l'ensemble de modifications dans changelog.yaml en exécutant la commande suivante:

liquibase --changeLogFile changelog.yaml update

Liquibase utilise l'URL que vous avez définie dans le fichier liquibase.properties. Vous pouvez remplacer la valeur dans le fichier en ajoutant l'argument suivant à la commande précédente:

--url URL

Vérifier vos modifications

Les mises à jour de l'étape précédente ont entraîné l'ajout de la table Singer à votre base de données. En outre, les tables DATABASECHANGELOG et DATABASECHANGELOGLOCK ont été ajoutées (base de données GoogleSQL-dialect) ou mises à jour (base de données PostgreSQL-dialect).

Vous pouvez vérifier l'existence de ces tables via la console Google Cloud ou la gcloud CLI. Par exemple, l'exécution de la requête SQL SELECT * FROM INFORMATION_SCHEMA.TABLES renvoie la liste de toutes les tables de votre base de données.

gcloud spanner databases execute-sql DATABASE_NAME --instance=INSTANCE \
    --sql='SELECT * FROM INFORMATION_SCHEMA.TABLES'

Vous pouvez consulter un enregistrement des modifications appliquées en interrogeant le contenu de DATABASECHANGELOG.

Étapes suivantes

Pour en savoir plus, accédez au dépôt GitHub Spanner Liquibase Extension.
Pour en savoir plus sur Liquibase, consultez la page Premiers pas avec Liquibase.