liquibase-catalog-name

The liquibase-catalog-name parameter is a string that specifies the catalog to use for Liquibase objects. It allows Liquibase to access a specific database catalog where Liquibase can store the DATABASECHANGELOG and DATABASECHANGELOGLOCK tables. The concept of a catalog varies between databases because not all databases have catalogs. For more information, refer to your database documentation.

Uses

A database catalog is typically an organized inventory of data assets in your database. It helps you collect and manage your metadata with the definitions of database objects, such as tables, views, synonyms, value ranges, indexes, users, and user groups.

You can use the liquibase-catalog-name parameter to specify the catalog in which to locate and store Liquibase objects created when running Liquibase operations.

Syntax

You can set this parameter in the following ways:

Option Syntax
Liquibase properties file
liquibase.liquibaseCatalogName: <string>
Global flow file argument (example)
stages:
  Default:
    actions:
      - type: liquibase
        command: update
        globalArgs: { liquibase-catalog-name: "<string>" }
Global CLI parameter
liquibase
 --liquibase-catalog-name=<string> update
 --changelog-file=example-changelog.xml

JVM system property (JAVA_OPTS Environment Variable)

JAVA_OPTS=-Dliquibase.liquibaseCatalogName=<string>
Liquibase Environment Variables
LIQUIBASE_LIQUIBASE_CATALOG_NAME=<string>

For more information, see Working with Command Parameters.

Related links