FilterFile

This is available in Flyway CLI only

Description

A filter configuration can be passed through to the underlying comparison engine that will be used in change and drift reports.

See Filters & Ignore Rules for how to generate these in Flyway Desktop.

Default

Flyway will identify and use filter files with specific names - no additional configuration is required through the filterFile parameter if you adhere to these names.

note: If you want Flyway to pick up a default file then it needs to be named exactly as specified, case is important. Otherwise the filter file will be ignored.

SQL Server & Oracle

Filter.scpf

Other databases

filter.rgf

Usage

Commandline

./flyway check -changes -url="jdbc://url1" -check.filterFile="filter.rgf"

Configuration File

flyway.check.filterFile="Filters.scpf"

TOML Configuration File

[flyway.check]
filterFile="Filters.scpf"

note: [redgateCompare] will be the main way to use filter files in the future. flyway.check.filterFile is supported for backwards compatibility, and will be deprecated in a future release.

[redgateCompare]
filterFile="Filters.scpf"

Redgate Flyway

Filter File