Flyway Snapshot Filename Setting
Published 15 January 2025
Description
Location used to store the snapshot as a result of the Snapshot command being invoked. The location type is determined by its prefix, and will be a file path if no prefix is specified.
Filesystem
Locations starting with filesystem: (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 snapshotHistory: point to
the snapshot history table.
They are in the format snapshotHistory:<name>. The name is an optional field stored in the table
which can be used to help look up snapshots if there are multiple entries (
see snapshot history limit).
If the name is set to current or previous, it will be left blank, as these are treated as
keywords when looking up snapshots.
Default
none - this is a required parameter for the snapshot command
Note that when a snapshot is created as part of a deployment, using
deploy.saveSnapshot,
migrate.saveSnapshot,
or undo.saveSnapshot, the
default will be to store it in the snapshot history table with an automatically generated name, but this behavior can be
overridden using this setting.
Usage
Flyway Desktop
This can't be added to a configuration file via Flyway Desktop.
Command-line
./flyway snapshot -filename=flyway_snapshot.snp
TOML Configuration File
[flyway.snapshot]
filename = "flyway_snapshot.snp"
Configuration File
flyway.snapshot.filename=flyway_snapshot.snp
Environment Variable
FLYWAY_SNAPSHOT_FILENAME=flyway_snapshot.snp
Notes
The file extension .snp is not required, it is a convenience to help identify the file
