ui-service

--ui-service is a global parameter that specifies the default UI service logger used by Liquibase. Valid values are CONSOLE and LOGGER. The default value is CONSOLE. This parameter is available in Liquibase 4.25.0 and later.

Uses

If you set --ui-service to CONSOLE, Liquibase sends output messages to the console (STDOUT) by default.

However, you may want Liquibase to send output messages to the log by default, such as a third-party logging tool like Log4j or Spring Boot's service logger. To allow this, set --ui-service to LOGGER.

Syntax

You can set this parameter in the following ways:

Option

Syntax

Liquibase properties file (defaults file)

liquibase.uiService: <string>

Global flow file argument

globalArgs: { ui-service: "<string>" }

Global CLI parameter

liquibase --ui-service=<string> update --changelog-file=example-changelog.xml

JVM system property (JAVA_OPTS environment variable)

Unix:

JAVA_OPTS=-Dliquibase.uiService=<string>

Windows:

JAVA_OPTS=-D"liquibase.uiService"=<string>

Liquibase environment variable

LIQUIBASE_COMMAND_CHANGELOG_FILE=<string>

For more information, see Working with command parameters.