Flyway Token Setting
Published 15 January 2025
Description
A personal access token (PAT) to be used in conjunction with the email
configuration parameter. This is used to license Flyway to access Teams or Enterprise features.
You should treat the token like a password and it should not be stored directly in your code repository. Use of a secrets manager or environment variable are much safer solutions.
Type
String
Default
none
Usage
Flyway Desktop
Not needed in conjunction with Flyway Desktop as Flyway Desktop will handle auth.
Command-line
./flyway -email="foo.bar@red-gate.com" -token="1234ABCD"
TOML
[flyway]
email = "foo.bar@red-gate.com"
token = "1234ABCD"
Environment Variable
FLYWAY_EMAIL=foo.bar@red-gate.com
FLYWAY_TOKEN=1234ABCD
Maven
<configuration>
<pluginConfiguration>
<email>foo.bar@red-gate.com</email>
<token>1234ABCD</token>
</pluginConfiguration>
</configuration>
API
Flyway flyway = Flyway.configure().load();
flyway.getConfigurationExtension(PATTokenConfigurationExtension.class)
.setEmail("foo.bar@red-gate.com");
flyway.getConfigurationExtension(PATTokenConfigurationExtension.class)
.setToken("1234ABCD");