Modify Liquibase Commands with Node.js

Last updated: July 14, 2025

This guide outlines adding or modifying Liquibase commands in the Liquibase Node package. It is designed for developers who want to extend the package's functionality.

Files to be Changed:

  • src/commands-with-positional-arguments.ts

  • src/liquibase-commands.enum

  • node-liquibase/src/models/commands (corresponding command file)

  • node-liquibase/src/liquibase.spec.ts

  • node-liquibase/src/liquibase.ts

Procedure

Follow these steps carefully to extend the functionality of the Liquibase Node package according to your requirements.

Note: This guide assumes familiarity with TypeScript and the Liquibase Node package structure. If you encounter any issues, refer to the Node.js and Liquibase documentation or seek assistance from the community.

1

Update commands-with-positional-arguments.ts and liquibase-commands.enum

  1. Navigate to the src directory of the Liquibase Node package.

  2. Open commands-with-positional-arguments.ts and liquibase-commands.enum files.

  3. Add or modify the command with its positional (if needed) arguments in these files.

2

Modify command and its arguments in node-liquibase/src/models/commands

  1. Go to the node-liquibase/src/models/commands directory.

  2. Locate the corresponding command file based on the command you added or modified.

  3. Add or modify the command and its arguments in the respective file.

3

Define commands in node-liquibase/src/liquibase.spec.ts

  1. Navigate to the node-liquibase/src directory.

  2. Open liquibase.spec.ts file.

  3. Define each command and indicate which run method it should invoke.

4

Implement invoke method in node-liquibase/src/liquibase.ts

  1. Go to the node-liquibase/src directory.

  2. Open liquibase.ts file.

  3. Implement the invoke method for each command specified in liquibase.spec.ts.