Detect Encoding

Description

Whether Flyway should attempt to auto-detect the file encoding of each migration.
Note: We recommend using a consistent file encoding to minimize the issues you encounter and specifying it to the encoding parameter. See Troubleshooting for known problems and solutions.

Flyway can detect each of the following formats:

• UTF-8
• ISO-8859-1
• UTF-16 BOMless
• UTF-16 LE
• UTF-16 BE

When Flyway fails to auto-detect, it will default to the configured encoding if set, UTF-8 if not.

If a script configuration file defines an encoding, auto detection will be skipped on that file.

Default

false

Usage

Commandline

./flyway -detectEncoding="true" migrate

TOML Configuration File

[flyway]
detectEncoding = true

Configuration File

flyway.detectEncoding=true

Environment Variable

FLYWAY_DETECT_ENCODING=true

API

Flyway.configure()
    .detectEncoding(true)
    .load()

Gradle

flyway {
    detectEncoding = true
}

Maven

<configuration>
    <detectEncoding>true</detectEncoding>
</configuration>