Package io.micronaut.flyway
Class FlywayConfigurationProperties
java.lang.Object
io.micronaut.flyway.FlywayConfigurationProperties
- All Implemented Interfaces:
io.micronaut.core.util.Toggleable
@Context
@EachProperty("flyway.datasources")
public class FlywayConfigurationProperties
extends Object
implements io.micronaut.core.util.Toggleable
Create a Flyway Configuration for each sub-property of flyway.*.
- Since:
- 1.0.0
- Author:
- Iván López
- See Also:
-
FluentConfiguration
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final boolean
static final boolean
static final boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.flywaydb.core.api.configuration.FluentConfiguration
getUrl()
getUser()
boolean
Whether there is an alternative database configuration for the migration.boolean
isAsync()
boolean
Whether Flyway will clean the schema before running the migrations.boolean
void
setAsync
(boolean async) Whether flyway migrations should run asynchronously.void
setCleanSchema
(boolean cleanSchema) Set whether Flyway will clean the schema before running the migrations.void
setEnabled
(boolean enabled) Set whether this flyway configuration is enabled.void
setPassword
(String password) void
void
void
setUsername
(String username)
-
Field Details
-
DEFAULT_ENABLED
public static final boolean DEFAULT_ENABLED- See Also:
-
DEFAULT_ASYNC
public static final boolean DEFAULT_ASYNC- See Also:
-
DEFAULT_CLEAN_SCHEMA
public static final boolean DEFAULT_CLEAN_SCHEMA- See Also:
-
-
Constructor Details
-
FlywayConfigurationProperties
- Parameters:
name
- The name qualifier.
-
-
Method Details
-
getNameQualifier
- Returns:
- The qualifier associated with this flyway configuration
-
isEnabled
public boolean isEnabled()- Specified by:
isEnabled
in interfaceio.micronaut.core.util.Toggleable
-
setEnabled
public void setEnabled(boolean enabled) Set whether this flyway configuration is enabled. Default value (true).- Parameters:
enabled
- true if it is enabled
-
isAsync
public boolean isAsync()- Returns:
- Whether the flyway migrations should run asynchronously
-
setAsync
public void setAsync(boolean async) Whether flyway migrations should run asynchronously.- Parameters:
async
- true to run flyway migrations asynchronously
-
isCleanSchema
public boolean isCleanSchema()Whether Flyway will clean the schema before running the migrations. Default value (false).- Returns:
- Whether clean the schema before running the migrations
-
setCleanSchema
public void setCleanSchema(boolean cleanSchema) Set whether Flyway will clean the schema before running the migrations. Default value (false).- Parameters:
cleanSchema
- true to clean the schema before running the migrations.
-
getUrl
- Returns:
- JDBC url of the database to migrate
-
setUrl
- Parameters:
url
- The JDBC url of the database to migrate
-
getUser
- Returns:
- The user of the database to migrate
-
setUser
- Parameters:
user
- The user of the database to migrate
-
setUsername
- Parameters:
username
- The username of the database to migrate
-
getPassword
- Returns:
- The password of the database to migrate
-
setPassword
- Parameters:
password
- The password of the database to migrate
-
hasAlternativeDatabaseConfiguration
public boolean hasAlternativeDatabaseConfiguration()Whether there is an alternative database configuration for the migration. By default Micronaut will use theDataSource
defined for the application but if bothurl
anduser
are defined, then those will be use for Flyway.- Returns:
- true if there is an alternative database configuration
-
getFluentConfiguration
public org.flywaydb.core.api.configuration.FluentConfiguration getFluentConfiguration()- Returns:
- The flyway configuration builder
-