include-system-classpath
The include-system-classpath
parameter defines whether Liquibase includes the system classpath when resolving classes at runtime. The default value is true
.
Uses
The Liquibase classpath refers to locations searched for drivers, extension, and changelog files. Liquibase always includes:
- Locations in the
classpath
setting - The current directory
- Files in the
LIQUIBASE_HOME/lib
directory
Tip: For more information about the Liquibase classpath and files, see How Liquibase Finds Files: Liquibase Classpath.
When you use the include-system-classpath
parameter set to true
, Liquibase also includes locations configured within the underlying Java system.
Setting the include-system-classpath
parameter
You can set include-system-classpath
in four ways:
- In the Liquibase properties file
- As a global parameter in the CLI
- As a JVM system property
- As an environment variable (Liquibase Pro)
Liquibase properties file parameter
In Liquibase 4.1+, add the following to Liquibase properties file:
liquibase.includeSystemClasspath
: <true|false>
CLI global parameter
In your command line, use a global parameter with a single Liquibase command:
liquibase --include-system-classpath
=<true|false>
update
--changelog-file=dbchangelog.xml
Java system property
In your command line, use the JAVA_OPTS Environment Variable to set a JVM system property:
Mac/Linux syntax:
JAVA_OPTS=-Dliquibase.includeSystemClasspath
=<true|false>
Windows syntax:
set JAVA_OPTS=-Dliquibase.includeSystemClasspath
=<true|false>
Note: To use a Liquibase command alongside JAVA_OPTS
, add && liquibase <command>
to the end of your input.
Environment variable (Liquibase Pro)
In Liquibase Pro, set an environment variable:
Mac/Linux syntax:
LIQUIBASE_INCLUDE_SYSTEM_CLASSPATH
=<true|false>
Windows syntax:
set LIQUIBASE_INCLUDE_SYSTEM_CLASSPATH
=<true|false>
Note: These environment variable commands only apply to the current shell. If you need to pass an environment variable to a child process without affecting the parent process, you can use the export
command on Mac/Linux or the setx
command on Windows.