Environment Driver Setting
Published 15 January 2025
Description
The fully qualified class name of the jdbc driver to use to connect to the database.
This must match the driver for the database type in the url you are using.
If you use a driver class that is not shipped with Flyway, you must ensure that it is available on the classpath (see Adding to the classpath).
Type
String
Default
Auto-detected based on the url
Usage
Flyway Desktop
This can be set from the connection dialog for certain database types using Flyway Desktop.
Command-line
./flyway -driver=com.microsoft.sqlserver.jdbc.SQLServerDriver info
To configure a named environment via command line when using a TOML configuration, prefix driver
with
environments.{environment name}.
for example:
./flyway -environments.sample.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver info
TOML Configuration File
[environments.default]
driver = "com.microsoft.sqlserver.jdbc.SQLServerDriver"
Configuration File
flyway.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver
Environment Variable
FLYWAY_DRIVER=com.microsoft.sqlserver.jdbc.SQLServerDriver
API
Flyway.configure()
.driver("com.microsoft.sqlserver.jdbc.SQLServerDriver")
.load()
Gradle
flyway {
driver = 'com.microsoft.sqlserver.jdbc.SQLServerDriver'
}
Maven
<configuration>
<driver>com.microsoft.sqlserver.jdbc.SQLServerDriver</driver>
</configuration>