Node.js and Liquibase

The Node Package Manager allows you to integrate Liquibase into apps designed with JavaScript and TypeScript. The packager acts as a library and it enables you to install pre-built packages that help you maintain your database easily and efficiently. Developers can integrate it in the current application instead of using the separate Java Liquibase CLI. This is a great tool for users who prefer a consistent tool set and don't necessarily want to work within Java in addition to working in JavaScript and TypeScript.

This method provides a smooth user experience between the NPM packager and the CLI tool. This is made possible by transpiling both an ES Module and a Common JS module in the dist code. The Node CLI of this package can be used with node-liquibase. All 'top level' Liquibase commands are implemented in this package. This is a complete listing of commands that have been implemented.

Note: Be sure to only import from the Liquibase module name when importing the modules to use them in a JavaScript or TypeScript file. This package name is required due to dependent projects.

The new package includes:

  • Liquibase command documentation
  • changeset command Parameter documentation
  • changeset CLI Command API Parity

Implementation

  1. Install Liquibase with Node Package Manager
  2. Optional: node-liquibase Peer Dependency
  3. Using Liquibase with Node.js
  4. Optional: Modify Liquibase Commands with Node.js

Related Links