Skip to main content

Add the Liquibase command step

Last updated on

When you create a pipeline in Harness Database DevOps, the Liquibase command step can help play a role in managing database changes. This step allows users to apply schema modifications and execute SQL scripts seamlessly within the pipeline.

Here's how you can add the Liquibase command step to your pipeline:

  1. In Harness, go to the Database DevOps module and select your Project.
  2. Under the Pipeline tab, select the pipeline that you want to add the Liquibase command step to.
  3. Within the pipeline configuration, select Add Step.
  4. Select the Liquibase Command Step.
  5. Configure the Liquibase Command Step by either selecting:
    1. Command: Specify the command you want to execute (e.g.diff-log, generate-changelog)
    2. Schema Name: Enter the name of the database schema that the command will affect.
    3. Instance Name: Specify the database instance where the command will be executed.
    4. Tag: This is an optional step but you can create a tag that indicates the version or state you want to apply or rollback changes to.
  6. At the next step after these configurations, review the configuration to ensure it's set how you'd like.
  7. Select Save the pipeline.
  8. Run the pipeline and monitor the execution.
info

To create a pipeline in Database DevOps, you can refer to the Harness documentation detailing how to Create a pipeline

Supported Liquibase Commands in Harness Database DevOps​

Harness executes Liquibase commands natively within the pipeline execution framework, applying governance, secret management, and auditing automatically.

Run Liquibase command for diff-log​

Generates a structured log of differences between two database states. In Harness, this is commonly used for:

  • Validating alignment before deployment
  • Feeding results into policy checks or PR workflows

Run Liquibase command for generate-changelog​

Creates a new changelog based on the current structure of a target database. Learn how to use for Creating Changelogs Harness surfaces the generated changelog as an artifact, supporting workflows such as:

  • Bootstrapping new schemas into version control
  • Reconstructing a missing or outdated changelog
  • Preparing a starting point before onboarding to DB DevOps

Run Liquibase command for release-locks​

Releases any locks held by Liquibase on the database, useful in scenarios where a previous operation was interrupted or failed. Harness provides visibility into lock status and facilitates recovery workflows by:

  • Allowing automated recovery in CI/CD pipelines using failure strategies.
  • Enabling manual intervention with clear logging and audit trails.

Use cases:

  • Resolving locks after failed deployments.
  • Ensuring database availability for subsequent operations.