io.micronaut.configuration.dbmigration.flyway

Class FlywayConfigurationProperties

java.lang.Object

io.micronaut.configuration.dbmigration.flyway.FlywayConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable

@Context
 @EachProperty(value="flyway.datasources")
public class FlywayConfigurationProperties
extends java.lang.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

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ASYNC
static boolean	DEFAULT_CLEAN_SCHEMA
static boolean	DEFAULT_ENABLED

Constructor Summary

Constructors

Constructor and Description
FlywayConfigurationProperties(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
org.flywaydb.core.api.configuration.FluentConfiguration	getFluentConfiguration()
org.flywaydb.core.api.Location[]	getLocations()
java.lang.String	getNameQualifier()
java.lang.String	getPassword()
java.lang.String	getUrl()
java.lang.String	getUser()
boolean	hasAlternativeDatabaseConfiguration() Whether there is an alternative database configuration for the migration.
boolean	isAsync()
boolean	isCleanSchema() Whether Flyway will clean the schema before running the migrations.
boolean	isEnabled()
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	setLocations(java.lang.String... locations)
void	setPassword(java.lang.String password)
void	setUrl(java.lang.String url)
void	setUser(java.lang.String user)
void	setUsername(java.lang.String username)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

DEFAULT_ASYNC

public static final boolean DEFAULT_ASYNC

See Also:

Constant Field Values

DEFAULT_CLEAN_SCHEMA

public static final boolean DEFAULT_CLEAN_SCHEMA

See Also:

Constant Field Values

Constructor Detail

FlywayConfigurationProperties

public FlywayConfigurationProperties(@Parameter
                                     java.lang.String name)

Parameters:

name - The name qualifier.

Method Detail

getNameQualifier

public java.lang.String getNameQualifier()

Returns:

The qualifier associated with this flyway configuration

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.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

public java.lang.String getUrl()

Returns:

JDBC url of the database to migrate

setUrl

public void setUrl(java.lang.String url)

Parameters:

url - The JDBC url of the database to migrate

getUser

public java.lang.String getUser()

Returns:

The user of the database to migrate

setUser

public void setUser(java.lang.String user)

Parameters:

user - The user of the database to migrate

setUsername

public void setUsername(java.lang.String username)

Parameters:

username - The username of the database to migrate

getPassword

public java.lang.String getPassword()

Returns:

The password of the database to migrate

setPassword

public void setPassword(java.lang.String password)

Parameters:

password - The password of the database to migrate

getLocations

public org.flywaydb.core.api.Location[] getLocations()

Returns:

The locations for the database migrations

setLocations

public void setLocations(java.lang.String... locations)

Parameters:

locations - The locations for the migrations

hasAlternativeDatabaseConfiguration

public boolean hasAlternativeDatabaseConfiguration()

Whether there is an alternative database configuration for the migration. By default Micronaut will use the DataSource defined for the application but if both url and user 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