Cómo integrar Spanner con Liquibase

En esta página, se describe cómo administrar los cambios de esquema de la base de datos de Spanner con Liquibase para las bases de datos con dialecto de GoogleSQL y las bases de datos con dialecto de PostgreSQL.

Liquibase es una biblioteca de código abierto independiente de la base de datos para hacer un seguimiento, administrar y aplicar cambios de esquema de la base de datos. Es compatible con SQL y con formatos declarativos, como XML, YAML y JSON.

Liquibase puede segmentar bases de datos de Spanner. Es compatible con todas las funciones de Spanner, con algunas limitaciones.

  • Para ver las limitaciones generales, consulta limitaciones.
  • Para ver información adicional sobre las bases de datos de dialecto PostgreSQL, como los requisitos de Liquibase, los tipos de cambios admitidos y las limitaciones, consulta PGAdapter y Liquibase.

Instala Liquibase

Para usar Liquibase con bases de datos con dialecto de GoogleSQL, debes instalar la extensión de Liquibase para Spanner. En el caso de las bases de datos con dialecto de PostgreSQL, Liquibase puede usar su compatibilidad integrada con PostgreSQL junto con PGAdapter.

GoogleSQL

  1. Sigue las instrucciones de la documentación de Liquibase para instalar y configurar Liquibase, y para tomar una instantánea de tu base de datos.

  2. Navega a la página de versiones de la extensión de Liquibase para Spanner en GitHub y selecciona la versión más reciente.

  3. Selecciona y descarga el archivo JAR con el nombre liquibase-spanner-x.y.z-all.jar, donde x.y.z representa el número de versión de la extensión. Por ejemplo, liquibase-spanner-4.17.0-all.jar

  4. Coloca el archivo JAR descargado en el directorio lib de Liquibase. El archivo JAR incluye la extensión, el SDK de Spanner y el controlador JDBC de Spanner.

En el archivo de configuración liquibase.properties, establece la propiedad url de la siguiente manera.

 jdbc:cloudspanner:/projects/PROJECT/instances/INSTANCE/databases/DATABASE

Tu archivo de configuración liquibase.properties solo puede contener esta propiedad. Otras propiedades son opcionales.

PostgreSQL

  1. Asegúrate de que PGAdapter se haya iniciado y se esté ejecutando en la máquina en la que instalas Liquibase. Para obtener más información, consulta Cómo iniciar PGAdapter.

  2. Sigue las instrucciones de la documentación de Liquibase para instalar y configurar Liquibase, y para tomar una instantánea de tu base de datos.

En el archivo de configuración liquibase.properties, establece la propiedad url de la siguiente manera.

  jdbc:postgresql://localhost:5432/DATABASE_NAME?options=-c%20spanner.ddl_transaction_mode=AutocommitExplicitTransaction

Tu archivo de configuración liquibase.properties solo puede contener esta propiedad. Otras propiedades son opcionales.

La cadena url debe incluir options=-c%20spanner.ddl_transaction_mode=AutocommitExplicitTransaction porque Spanner no admite transacciones de DDL, y esto garantiza que las transacciones de DDL se conviertan en lotes de DDL. Para obtener más información, consulta Opciones de DDL para PGAdapter.

Revisa las muestras de Liquibase

GoogleSQL

El archivo de registro de cambios de muestra changelog.yaml incluido en la extensión de Liquibase de GoogleSQL demuestra muchas de las funciones de Liquibase y cómo usarlas con Spanner.

PostgreSQL

El archivo de registro de cambios de muestra dbchangelog.xml disponible en el repositorio de GitHub de PGAdapter y Liquibase muestra muchas de las funciones de Liquibase y cómo usarlas con Spanner.

Guía de inicio rápido de Liquibase

En esta guía de inicio rápido, se muestra cómo usar Liquibase para agregar una tabla Singers a una base de datos.

Antes de comenzar

  • Asegúrate de haber completado los pasos anteriores para instalar Liquibase.

  • Crea una instancia de Spanner.

  • Crea una base de datos con el dialecto de GoogleSQL o PostgreSQL.

  • Solo para las bases de datos de dialecto PostgreSQL, asegúrate de que PGAdapter se haya iniciado y se esté ejecutando en la misma máquina que tu instalación de Liquibase. Para obtener más información, consulta Cómo iniciar PGAdapter.

  • Solo para las bases de datos con dialecto de PostgreSQL, usa la secuencia de comandos create_database_change_log.sql para crear las tablas de metadatos databasechangeloglock y databasechangelog. Debes crear estas tablas para anular las que Liquibase crea automáticamente en tu base de datos. Esto garantiza que se usen los tipos de datos de PostgreSQL correctos para Spanner en estas tablas.

    Puedes ejecutar el script con el siguiente comando:

    psql -h localhost -d DATABASE_NAME -f create_database_change_log.sql

  • Ejecuta el siguiente comando gcloud para otorgar a la extensión de Spanner Liquibase el uso temporal de tus credenciales de usuario de Spanner para el acceso a la API:

    gcloud auth application-default login

Crea un archivo changelog.yaml

  1. Ingresa el siguiente código YAML en tu editor favorito.

    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)

    Este archivo YAML define una tabla llamada Singers con una clave primaria SingerId y una columna llamada Name para almacenar el nombre del cantante.

    En el caso de las bases de datos con dialecto de PostgreSQL, recomendamos usar solo letras minúsculas para los nombres de tablas y columnas. Para obtener más información, consulta Distinción entre mayúsculas y minúsculas en PostgreSQL.

    Ten en cuenta que el conjunto de cambios createTable debe incluir una restricción de clave primaria, y el nombre de la restricción de clave primaria debe ser pk_table_name.

  2. Guarda los cambios como changelog.yaml.

Ejecuta Liquibase

Aplica el conjunto de cambios en changelog.yaml ejecutando el siguiente comando:

liquibase --changeLogFile changelog.yaml update

Liquibase usa la URL que definiste en el archivo liquibase.properties. Puedes anular el valor en el archivo agregando el siguiente argumento al comando anterior:

--url URL

Verifica tus cambios

Las actualizaciones del paso anterior hicieron que se agregara la tabla Singer a tu base de datos. Además, se agregaron (base de datos con dialecto de GoogleSQL) o actualizaron (base de datos con dialecto de PostgreSQL) las tablas DATABASECHANGELOG y DATABASECHANGELOGLOCK.

Puedes verificar la existencia de estas tablas a través de la consola Google Cloud o de gcloud CLI. Por ejemplo, ejecutar la consulta en SQL SELECT * FROM INFORMATION_SCHEMA.TABLES devuelve una lista de todas las tablas de tu base de datos.

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

Para ver un registro de los cambios que se aplicaron, consulta el contenido de DATABASECHANGELOG.

¿Qué sigue?