Flyway Check Deployed Snapshot Setting

{% include enterprise.html %}

Description

The location of a snapshot matching the state of the target database when the last deployment happened (generated via snapshot) The location type is determined by its prefix, and will be a file path if no prefix is specified.

Filesystem

Locations starting with <code>filesystem:</code> (or with no prefix) point to a file path on the filesystem. Relative paths will be resolved against your working directory.

Snapshot History table

Locations starting with <code>snapshotHistory:</code> point to the snapshot history table. They are in the format <code>snapshotHistory:<name></code>. If the name is set to <code>current</code>, the most recent snapshot will be used. For more information on the concept of the snapshot history table, see Snapshots.

Type

String

Default

"snapshotHistory:current""

Usage

Flyway Desktop

This can't be set in a config file via Flyway Desktop, although it will be honoured, and it can be configured as an advanced parameter in operations on the Migrations page.

Command-line

./flyway check -changes -url="jdbc://url" -deployedSnapshot="snapshotHistory:current"

TOML Configuration File

[flyway.check]
deployedSnapshot = "snapshotHistory:current"

Configuration File

flyway.check.deployedSnapshot=snapshotHistory:current