Skip to main content
Skip table of contents

Executing Liquibase Scripts

This feature can execute Liquibase scripts without using the Liquibase CLI. The feature is only available via a CLI command; no guided/interactive sequence is available.

The full CLI command is:

--x4_jdbc <JDBC_Connection_String> --x4_jdbc_user <Database-username> --x4_jdbc_password <Database_passwort> --silent --liquibaseChangelogPath=<Changelog_path> --liquibaseChangelogName=<Changelog_name>--dbSchemaName <Name_database_schema> --liquibaseSchemaName <Name_Liquibase_schema>

The following CLI parameters are relevant:

Parameter

Description

--x4_jdbc

JDBC connection string

--x4_jdbc_user

Database users for the X4 database connection

If the Update Tool is to create the user, that user must be able to create users. In addition, if a tablespace is to be created, the user must be able to create tablespaces. Otherwise, the user must have permission to create tablespaces in the X4SERVER user.

--x4_jdbc_password

Password for the X4 database connection database user

--silent

In silent mode, the user interaction for the JDBC update is skipped. All required parameters must be provided in the CLI command.

--disableAutomaticLiquibaseSchemaCorrection

Optional.

This parameter can be used as a workaround in some error situations, but we do not recommend using the parameter.

--liquibaseSchemaName

Optional.

Name of the schema in which the Liquibase management tables (DATABASECHANGELOG and DATABASECHANGELOGLOCK) are to be created. This schema must exist before the script runs.

If the schema is not specified, the default database schema is used to create the Liquibase tables.

--liquibaseCatalogName

Optional.

Name of the database catalog in which the Liquibase management tables (DATABASECHANGELOG and DATABASECHANGELOGLOCK) are to be created. This parameter is only supported in databases that support catalogs.

The catalog must exist before running the script.

If the catalog is not specified, the default catalog is used.

--dbSchemaName

Optional.

Schema in which the X4 tables are created.

The value of this option is available in Liquibase scripts as a Liquibase parameter ${tables.schema name}.

If the schema does not exist, it is created when createDbSchemaIfNotExists is active.

--dbCatalogName

The value of this option is available in Liquibase scripts as a Liquibase parameter ${tables.catalogName}.

The catalog must exist before running the script.

If the catalog is not specified, the default catalog is used.

--liquibaseOracleTablespaceName

Optional.

The tablespace in which to create the Liquibase management tables (DATABASECHANGELOG and DATABASECHANGELOGLOCK).

Note:

This parameter is supported for Oracle only.

The tablespace must exist before running the script.

If the tablespace is not specified, the default tablespace is used.

--liquibaseChangelogPath

Mandatory.

Defines the path in which the Liquibase changelogs are stored. The respective script is selected by the liquibaseChangelogName parameter.

--liquibaseChangelogName

Mandatory.

Name of the Liquibase changelog to be executed.

Note:

The changelog must exist in the path specified with the liquibaseChangelogPath parameter. Multiple Liquibase scripts may exist in this path, but only the script specified in liquibaseChangelogName is executed.

If you need to run multiple scripts, you can:

  1. Run the tool several times.

  2. Use the Liquibase <include> function and create a Liquibase root script with all scripts to run all includes.

--executeLiquibaseScripts

Specifies whether to use the path for Liquibase script execution.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.