What Liquibase commands are used for remote files?

File(s)

Commands

Example

Generating a changelog (see below for calling a changelog in a command)

generate-changelog diff-changelog diff

Relative changelog path required to preserve DBCL integrity.

Flowfile (such as liquibase.flowfile.yaml)

flow

liquibase flow --flow-file=s3://myBucket/liquibase.flowfile.yaml

liquibase flow --flow-file=az://myContainer/liquibase.flowfile.yaml If the flow file references changelogs, the search-path must be configured. Within the flow file, the path to the changelog should be relative to the search-path. If the flow file references a checks settings file, provide an absolute path in the flow file. If a flow file calls the flow command internally, provide an absolute path to the referenced flow file.

Checks settings file (such as liquibase.checks-settings.conf)

checks (all subcommands)

liquibase checks run --checks-settings-file=s3://myBucket/liquibase.checks-settings.conf

liquibase checks run --checks-settings-file=az://myContainer/liquibase.checks-settings.conf

Defaults file (such as liquibase.properties)

All

liquibase --defaults-file=s3://myBucket/defaults/liquibase.properties history

liquibase --defaults-file=az://myContainer/defaults/liquibase.properties history

Init project files changelog flow file liquibase.properties

init project

liquibase init project --project-dir=s3://myBucket/init --project-guide=off --changelog-file=example-changelog.postgres.sql

liquibase init project --project-dir=az://myContainer/init --project-guide=off --changelog-file=example-changelog.postgres.sql The changelog-file attribute cannot be relative when passed to init project in the --changelog-file parameter. This is the only use case where changelog-file is not relative.

output-file

All commands which support the --output-file property.

liquibase --output-file=s3://myBucket/snapshots/mysnap.json snapshot

liquibase --output-file=az://myContainer/snapshots/mysnap.json snapshot

driver.properties

All that support the --driver-properties-file property.

liquibase --search-path=s3://myBucket/properties/drivers update --driver-properties-file=mydriver.properties

liquibase --search-path=az://myContainer/properties/drivers update --driver-properties-file=mydriver.properties

snapshot.json

snapshot snapshot-reference

liquibase --output-file=s3://myBucket/snapshots/mysnap.json snapshot

liquibase --output-file=az://myContainer/snapshots/mysnap.json snapshot

HTML operation report files

All that support Operation Reports

liquibase checks run --report-path=s3://myBucket/reports/myreport.html

liquibase checks run --report-path=az://myContainer/reports/myreport.html Note: For S3 files, you cannot specify a region directly in the path. You must specify the region in your AWS configuration files or as an environment variable.

File(s)

Commands

Example

Using a changelog (changelog file/resources)

SQL files

include or includeAll files

update (all variants) rollback (all variants) changelog-sync status validate

liquibase --search-path=s3://myBucket update --changelog-file=changelogs/changelog.xml

liquibase --search-path=az://myContainer update --changelog-file=changelogs/changelog.xml

A relative changelog path is required to preserve the Liquibase tracking table integrity.

File(s)

Commands

Example

Snapshots (such as mysnapshot.json)

diff diff-changelog

liquibase --search-path=s3://myBucket/mysnapshots diff --reference-url=offline:postgres?snapshot=mysnapshot.json

liquibase --search-path=az://myContainer/mysnapshots diff --reference-url=offline:postgres?snapshot=mysnapshot.json

Native executor config files (such as liquibase.sqlplus.conf, liquibase.sqlcmd.conf,liquibase.psql.conf)

update (all variants) rollback (all variants)

liquibase --search-path=s3://myBucket/configs update

liquibase --search-path=az://myContainer/configs update

There is no property to directly specify a native executor configuration file path. It is located using the searchpath property.