Connect Liquibase with Azure Database for PostgreSQL

If you're running Liquibase using the Maven plugin using mvn liquibase:update installing the extension with Maven ensures the right files are available and everything works together automatically. You can manage these extensions by adding them as dependencies in your project’s pom.xml file. When configured this way, Maven automatically downloads the specified JAR files from Maven Central during the build process.

1. Ensure your PostgreSQL database is configured.

Check the status by running the pg_isready command. For more information about the options you can specify when running the command, see the pg_isready webpage.

2. Specify the database URL in the liquibase.properties file (defaults file), along with other properties you want to set a default value for.

Liquibase does not parse the URL. You can either specify the full database connection string or specify the URL using your database's standard connection format:

url: jdbc:postgresql://${AZ_DATABASE_SERVER_NAME}.postgres.database.azure.com

To apply a Liquibase Secure key to your project, add the following property to the Liquibase properties file: licenseKey: <paste code here>

Note: If you use the connection pooling manager PG Bouncer, you must specify the connection port 5432.

Flexible Server via Service Principal Name

If you use Azure Flexible Server for PostgreSQL and want to authenticate using Service Principal Name (SPN) in your automation pipeline, follow these steps to connect to Liquibase:

1. Create an automation script that requests these parameters from the user:

• CLIENT_ID (username, example: 7ca151a7-cb01-4580-be03-0408df979c8f)

• CLIENT_SECRET (password)

• AZURE_TENANT_ID (the Active Directory tenant GUID to authenticate; a constant in your environment)

2. Run the following commands in automation:

az login -u "$CLIENT_ID" -p "$CLIENT_SECRET" -t "$AZURE_TENANT_ID" --service-principal az account show SPN=$(az ad sp show --id "$CLIENT_ID" | jq -r '.appDisplayName') AAD_ACCESS_TOKEN=$(az account get-access-token --resource https://ossrdbms-aad.database.windows.net | jq -r '.accessToken')

Specify the following Liquibase parameters as environment variables:

• export LIQUIBASE_COMMAND_URL="jdbc:postgresql://<database_server_name>.postgres.database.azure.com/postgres?sslmode=require"

• export LIQUIBASE_COMMAND_USERNAME=$SPN

• export LIQUIBASE_COMMAND_PASSWORD=$AAD_ACCESS_TOKEN

For more information, see the following guides:

• Integrate Azure Database for PostgreSQL with Service Connector

• Connect Azure Database for PostgreSQL - Flexible Server with the private access connectivity method

• Quickstart: Use Java and JDBC with Azure Database for PostgreSQL

1. Create a text file called changelog (.sql, .yaml, .json, or .xml) in your project directory and add a changeset.

If you already created a changelog using the init project command, you can use that instead of creating a new file. When adding onto an existing changelog, be sure to only add the changeset and to not duplicate the changelog header.

2. Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful:

liquibase status

Note: You can specify arguments in the CLI or keep them in the Liquibase properties file.

If your connection is successful, you'll see a message like this:

4 changesets have not been applied to <your_connection_url> Liquibase command 'status' was executed successfully.

3. Inspect the deployment SQL with the update-sql command

liquibase update-sql

If the SQL that Liquibase generates isn't what you expect, you should review your changelog file and make any necessary adjustments.

4. Then execute these changes to your database with the update command:

liquibase update

If your update is successful, Liquibase runs each changeset and displays a summary message ending with:

Liquibase: Update has been successful. Liquibase command 'update' was executed successfully.

5. Verify that the database contains your test_table and the DATABASECHANGELOG, and DATABASECHANGELOGLOCK tables.