flow
flow
lets you run a series of commands contained in one or more stages, as configured in a Liquibase flow file. This command is available in Liquibase 4.15.0 and later.
Uses
Liquibase flow files let you create portable, platform-independent Liquibase workflows that can run anywhere without modification. This includes Jenkins, GitHub actions, a developers desktop, or any other CI/CD support tool.
You can use the flow
command to run your flow file and execute many other commands all in one place. For more information, see Liquibase Flow Files.
Syntax
Before running the flow
command, ensure that your flow file is in the directory you want it. Then navigate to that directory in your command line.
To run the flow
command, specify the driver, classpath, and URL in Liquibase properties file. For more information, see Create and Configure a liquibase.properties File. You can also specify these properties in your command line.
Then run the flow
command:
liquibase flow
Parameters
Global parameters
Attribute | Definition | Requirement |
---|---|---|
|
Your Liquibase Pro license key |
Required |
Command parameters
Attribute | Definition | Requirement |
---|---|---|
|
The path to the configuration YAML file which
contains one or more "stages" of commands to be
executed in a |
Optional |
|
If true, parse flow file YAML to allow only Liquibase flow file-specific properties, indentations, and
structures.
Default: |
Optional |
|
The default interpreter used to execute shell
commands. Examples include |
Optional |
|
If true, do not delete temporary files created by the shell
command execution.
Default: |
Optional |
Output
In this example, we are running the default flow file that comes pre-installed with Liquibase.