include-system-classpath

The include-system-classpath parameter is a Boolean that 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. Liquibase always includes:

  • Locations in the classpath setting
  • The current directory
  • Files in the liquibase/lib and liquibase/internal/lib directories

When you use the include-system-classpath parameter set to true, Liquibase also includes locations configured within the underlying Java system.

Syntax

You can set this parameter in the following ways:

Option Syntax
Liquibase properties file (defaults file)
liquibase.includeSystemClasspath: <true|false>
Global flow file argument (example)
stages:
  Default:
    actions:
      - type: liquibase
        command: update
        globalArgs: { include-system-classpath: "<true|false>" }
Global CLI parameter
liquibase
 --include-system-classpath=<true|false> update
 --changelog-file=example-changelog.xml

JVM system property (JAVA_OPTS Environment Variable)

JAVA_OPTS=-Dliquibase.includeSystemClasspath=<true|false>
Liquibase Environment Variables
LIQUIBASE_INCLUDE_SYSTEM_CLASSPATH=<true|false>

For more information, see Working with Command Parameters.