org.springframework.boot.autoconfigure.flyway

Class FlywayProperties

java.lang.Object

org.springframework.boot.autoconfigure.flyway.FlywayProperties

@ConfigurationProperties(prefix="spring.flyway")
public class FlywayProperties
extends java.lang.Object

Configuration properties for Flyway database migrations.

Since:

1.1.0

Constructor Summary

Constructors

Constructor and Description
FlywayProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaselineDescription()
java.lang.String	getBaselineVersion()
java.lang.Boolean	getBatch()
java.lang.String[]	getCherryPick()
int	getConnectRetries()
java.lang.String	getDefaultSchema()
java.lang.String	getDriverClassName()
java.io.File	getDryRunOutput()
java.nio.charset.Charset	getEncoding()
java.lang.String[]	getErrorOverrides()
java.util.List<java.lang.String>	getInitSqls()
java.lang.String	getInstalledBy()
java.util.Map<java.lang.String,java.lang.String>	getJdbcProperties()
java.lang.String	getLicenseKey()
java.util.List<java.lang.String>	getLocations()
java.lang.Integer	getLockRetryCount()
java.lang.String	getOracleKerberosCacheFile()
java.lang.String	getOracleKerberosConfigFile()
java.lang.Boolean	getOracleSqlplus()
java.lang.Boolean	getOracleSqlplusWarn()
java.lang.Boolean	getOutputQueryResults()
java.lang.String	getPassword()
java.lang.String	getPlaceholderPrefix()
java.util.Map<java.lang.String,java.lang.String>	getPlaceholders()
java.lang.String	getPlaceholderSuffix()
java.lang.String	getRepeatableSqlMigrationPrefix()
java.util.List<java.lang.String>	getSchemas()
java.lang.Boolean	getSkipExecutingMigrations()
java.lang.String	getSqlMigrationPrefix()
java.lang.String	getSqlMigrationSeparator()
java.util.List<java.lang.String>	getSqlMigrationSuffixes()
java.lang.Boolean	getStream()
java.lang.String	getTable()
java.lang.String	getTablespace()
java.lang.String	getTarget()
java.lang.String	getUndoSqlMigrationPrefix()
java.lang.String	getUrl()
java.lang.String	getUser()
java.util.List<java.lang.String>	getVaultSecrets()
java.lang.String	getVaultToken()
java.lang.String	getVaultUrl()
boolean	isBaselineOnMigrate()
boolean	isCheckLocation() Deprecated.
boolean	isCleanDisabled()
boolean	isCleanOnValidationError()
boolean	isCreateDataSource() Deprecated. since 2.5.0 for removal in 2.7.0 in favor of directly checking user and url.
boolean	isCreateSchemas()
boolean	isEnabled()
boolean	isGroup()
boolean	isIgnoreFutureMigrations()
boolean	isIgnoreIgnoredMigrations()
boolean	isIgnoreMissingMigrations()
boolean	isIgnorePendingMigrations()
boolean	isMixed()
boolean	isOutOfOrder()
boolean	isPlaceholderReplacement()
boolean	isSkipDefaultCallbacks()
boolean	isSkipDefaultResolvers()
boolean	isValidateMigrationNaming()
boolean	isValidateOnMigrate()
void	setBaselineDescription(java.lang.String baselineDescription)
void	setBaselineOnMigrate(boolean baselineOnMigrate)
void	setBaselineVersion(java.lang.String baselineVersion)
void	setBatch(java.lang.Boolean batch)
void	setCheckLocation(boolean checkLocation) Deprecated.
void	setCherryPick(java.lang.String[] cherryPick)
void	setCleanDisabled(boolean cleanDisabled)
void	setCleanOnValidationError(boolean cleanOnValidationError)
void	setConnectRetries(int connectRetries)
void	setCreateSchemas(boolean createSchemas)
void	setDefaultSchema(java.lang.String defaultSchema)
void	setDriverClassName(java.lang.String driverClassName)
void	setDryRunOutput(java.io.File dryRunOutput)
void	setEnabled(boolean enabled)
void	setEncoding(java.nio.charset.Charset encoding)
void	setErrorOverrides(java.lang.String[] errorOverrides)
void	setGroup(boolean group)
void	setIgnoreFutureMigrations(boolean ignoreFutureMigrations)
void	setIgnoreIgnoredMigrations(boolean ignoreIgnoredMigrations)
void	setIgnoreMissingMigrations(boolean ignoreMissingMigrations)
void	setIgnorePendingMigrations(boolean ignorePendingMigrations)
void	setInitSqls(java.util.List<java.lang.String> initSqls)
void	setInstalledBy(java.lang.String installedBy)
void	setJdbcProperties(java.util.Map<java.lang.String,java.lang.String> jdbcProperties)
void	setLicenseKey(java.lang.String licenseKey)
void	setLocations(java.util.List<java.lang.String> locations)
void	setLockRetryCount(java.lang.Integer lockRetryCount)
void	setMixed(boolean mixed)
void	setOracleKerberosCacheFile(java.lang.String oracleKerberosCacheFile)
void	setOracleKerberosConfigFile(java.lang.String oracleKerberosConfigFile)
void	setOracleSqlplus(java.lang.Boolean oracleSqlplus)
void	setOracleSqlplusWarn(java.lang.Boolean oracleSqlplusWarn)
void	setOutOfOrder(boolean outOfOrder)
void	setOutputQueryResults(java.lang.Boolean outputQueryResults)
void	setPassword(java.lang.String password)
void	setPlaceholderPrefix(java.lang.String placeholderPrefix)
void	setPlaceholderReplacement(boolean placeholderReplacement)
void	setPlaceholders(java.util.Map<java.lang.String,java.lang.String> placeholders)
void	setPlaceholderSuffix(java.lang.String placeholderSuffix)
void	setRepeatableSqlMigrationPrefix(java.lang.String repeatableSqlMigrationPrefix)
void	setSchemas(java.util.List<java.lang.String> schemas)
void	setSkipDefaultCallbacks(boolean skipDefaultCallbacks)
void	setSkipDefaultResolvers(boolean skipDefaultResolvers)
void	setSkipExecutingMigrations(java.lang.Boolean skipExecutingMigrations)
void	setSqlMigrationPrefix(java.lang.String sqlMigrationPrefix)
void	setSqlMigrationSeparator(java.lang.String sqlMigrationSeparator)
void	setSqlMigrationSuffixes(java.util.List<java.lang.String> sqlMigrationSuffixes)
void	setStream(java.lang.Boolean stream)
void	setTable(java.lang.String table)
void	setTablespace(java.lang.String tablespace)
void	setTarget(java.lang.String target)
void	setUndoSqlMigrationPrefix(java.lang.String undoSqlMigrationPrefix)
void	setUrl(java.lang.String url)
void	setUser(java.lang.String user)
void	setValidateMigrationNaming(boolean validateMigrationNaming)
void	setValidateOnMigrate(boolean validateOnMigrate)
void	setVaultSecrets(java.util.List<java.lang.String> vaultSecrets)
void	setVaultToken(java.lang.String vaultToken)
void	setVaultUrl(java.lang.String vaultUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlywayProperties

public FlywayProperties()

Method Detail

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isCheckLocation

@Deprecated
 @DeprecatedConfigurationProperty(reason="Locations can no longer be checked accurately due to changes in Flyway\'s location support.")
public boolean isCheckLocation()

Deprecated.

setCheckLocation

@Deprecated
public void setCheckLocation(boolean checkLocation)

Deprecated.

getLocations

public java.util.List<java.lang.String> getLocations()

setLocations

public void setLocations(java.util.List<java.lang.String> locations)

getEncoding

public java.nio.charset.Charset getEncoding()

setEncoding

public void setEncoding(java.nio.charset.Charset encoding)

getConnectRetries

public int getConnectRetries()

setConnectRetries

public void setConnectRetries(int connectRetries)

getLockRetryCount

public java.lang.Integer getLockRetryCount()

setLockRetryCount

public void setLockRetryCount(java.lang.Integer lockRetryCount)

getDefaultSchema

public java.lang.String getDefaultSchema()

setDefaultSchema

public void setDefaultSchema(java.lang.String defaultSchema)

getSchemas

public java.util.List<java.lang.String> getSchemas()

setSchemas

public void setSchemas(java.util.List<java.lang.String> schemas)

isCreateSchemas

public boolean isCreateSchemas()

setCreateSchemas

public void setCreateSchemas(boolean createSchemas)

getTable

public java.lang.String getTable()

setTable

public void setTable(java.lang.String table)

getTablespace

public java.lang.String getTablespace()

setTablespace

public void setTablespace(java.lang.String tablespace)

getBaselineDescription

public java.lang.String getBaselineDescription()

setBaselineDescription

public void setBaselineDescription(java.lang.String baselineDescription)

getBaselineVersion

public java.lang.String getBaselineVersion()

setBaselineVersion

public void setBaselineVersion(java.lang.String baselineVersion)

getInstalledBy

public java.lang.String getInstalledBy()

setInstalledBy

public void setInstalledBy(java.lang.String installedBy)

getPlaceholders

public java.util.Map<java.lang.String,java.lang.String> getPlaceholders()

setPlaceholders

public void setPlaceholders(java.util.Map<java.lang.String,java.lang.String> placeholders)

getPlaceholderPrefix

public java.lang.String getPlaceholderPrefix()

setPlaceholderPrefix

public void setPlaceholderPrefix(java.lang.String placeholderPrefix)

getPlaceholderSuffix

public java.lang.String getPlaceholderSuffix()

setPlaceholderSuffix

public void setPlaceholderSuffix(java.lang.String placeholderSuffix)

isPlaceholderReplacement

public boolean isPlaceholderReplacement()

setPlaceholderReplacement

public void setPlaceholderReplacement(boolean placeholderReplacement)

getSqlMigrationPrefix

public java.lang.String getSqlMigrationPrefix()

setSqlMigrationPrefix

public void setSqlMigrationPrefix(java.lang.String sqlMigrationPrefix)

getSqlMigrationSuffixes

public java.util.List<java.lang.String> getSqlMigrationSuffixes()

setSqlMigrationSuffixes

public void setSqlMigrationSuffixes(java.util.List<java.lang.String> sqlMigrationSuffixes)

getSqlMigrationSeparator

public java.lang.String getSqlMigrationSeparator()

setSqlMigrationSeparator

public void setSqlMigrationSeparator(java.lang.String sqlMigrationSeparator)

getRepeatableSqlMigrationPrefix

public java.lang.String getRepeatableSqlMigrationPrefix()

setRepeatableSqlMigrationPrefix

public void setRepeatableSqlMigrationPrefix(java.lang.String repeatableSqlMigrationPrefix)

getTarget

public java.lang.String getTarget()

setTarget

public void setTarget(java.lang.String target)

isCreateDataSource

@Deprecated
public boolean isCreateDataSource()

Deprecated. since 2.5.0 for removal in 2.7.0 in favor of directly checking user and url.

Return if a new datasource is being created.

Returns:

true if a new datasource is created

getUser

public java.lang.String getUser()

setUser

public void setUser(java.lang.String user)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getDriverClassName

public java.lang.String getDriverClassName()

setDriverClassName

public void setDriverClassName(java.lang.String driverClassName)

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

getInitSqls

public java.util.List<java.lang.String> getInitSqls()

setInitSqls

public void setInitSqls(java.util.List<java.lang.String> initSqls)

isBaselineOnMigrate

public boolean isBaselineOnMigrate()

setBaselineOnMigrate

public void setBaselineOnMigrate(boolean baselineOnMigrate)

isCleanDisabled

public boolean isCleanDisabled()

setCleanDisabled

public void setCleanDisabled(boolean cleanDisabled)

isCleanOnValidationError

public boolean isCleanOnValidationError()

setCleanOnValidationError

public void setCleanOnValidationError(boolean cleanOnValidationError)

isGroup

public boolean isGroup()

setGroup

public void setGroup(boolean group)

isIgnoreMissingMigrations

public boolean isIgnoreMissingMigrations()

setIgnoreMissingMigrations

public void setIgnoreMissingMigrations(boolean ignoreMissingMigrations)

isIgnoreIgnoredMigrations

public boolean isIgnoreIgnoredMigrations()

setIgnoreIgnoredMigrations

public void setIgnoreIgnoredMigrations(boolean ignoreIgnoredMigrations)

isIgnorePendingMigrations

public boolean isIgnorePendingMigrations()

setIgnorePendingMigrations

public void setIgnorePendingMigrations(boolean ignorePendingMigrations)

isIgnoreFutureMigrations

public boolean isIgnoreFutureMigrations()

setIgnoreFutureMigrations

public void setIgnoreFutureMigrations(boolean ignoreFutureMigrations)

isMixed

public boolean isMixed()

setMixed

public void setMixed(boolean mixed)

isOutOfOrder

public boolean isOutOfOrder()

setOutOfOrder

public void setOutOfOrder(boolean outOfOrder)

isSkipDefaultCallbacks

public boolean isSkipDefaultCallbacks()

setSkipDefaultCallbacks

public void setSkipDefaultCallbacks(boolean skipDefaultCallbacks)

isSkipDefaultResolvers

public boolean isSkipDefaultResolvers()

setSkipDefaultResolvers

public void setSkipDefaultResolvers(boolean skipDefaultResolvers)

isValidateMigrationNaming

public boolean isValidateMigrationNaming()

setValidateMigrationNaming

public void setValidateMigrationNaming(boolean validateMigrationNaming)

isValidateOnMigrate

public boolean isValidateOnMigrate()

setValidateOnMigrate

public void setValidateOnMigrate(boolean validateOnMigrate)

getBatch

public java.lang.Boolean getBatch()

setBatch

public void setBatch(java.lang.Boolean batch)

getDryRunOutput

public java.io.File getDryRunOutput()

setDryRunOutput

public void setDryRunOutput(java.io.File dryRunOutput)

getErrorOverrides

public java.lang.String[] getErrorOverrides()

setErrorOverrides

public void setErrorOverrides(java.lang.String[] errorOverrides)

getLicenseKey

public java.lang.String getLicenseKey()

setLicenseKey

public void setLicenseKey(java.lang.String licenseKey)

getOracleSqlplus

public java.lang.Boolean getOracleSqlplus()

setOracleSqlplus

public void setOracleSqlplus(java.lang.Boolean oracleSqlplus)

getOracleSqlplusWarn

public java.lang.Boolean getOracleSqlplusWarn()

setOracleSqlplusWarn

public void setOracleSqlplusWarn(java.lang.Boolean oracleSqlplusWarn)

getStream

public java.lang.Boolean getStream()

setStream

public void setStream(java.lang.Boolean stream)

getUndoSqlMigrationPrefix

public java.lang.String getUndoSqlMigrationPrefix()

setUndoSqlMigrationPrefix

public void setUndoSqlMigrationPrefix(java.lang.String undoSqlMigrationPrefix)

getCherryPick

public java.lang.String[] getCherryPick()

setCherryPick

public void setCherryPick(java.lang.String[] cherryPick)

getJdbcProperties

public java.util.Map<java.lang.String,java.lang.String> getJdbcProperties()

setJdbcProperties

public void setJdbcProperties(java.util.Map<java.lang.String,java.lang.String> jdbcProperties)

getOracleKerberosCacheFile

public java.lang.String getOracleKerberosCacheFile()

setOracleKerberosCacheFile

public void setOracleKerberosCacheFile(java.lang.String oracleKerberosCacheFile)

getOracleKerberosConfigFile

public java.lang.String getOracleKerberosConfigFile()

setOracleKerberosConfigFile

public void setOracleKerberosConfigFile(java.lang.String oracleKerberosConfigFile)

getOutputQueryResults

public java.lang.Boolean getOutputQueryResults()

setOutputQueryResults

public void setOutputQueryResults(java.lang.Boolean outputQueryResults)

getSkipExecutingMigrations

public java.lang.Boolean getSkipExecutingMigrations()

setSkipExecutingMigrations

public void setSkipExecutingMigrations(java.lang.Boolean skipExecutingMigrations)

getVaultUrl

public java.lang.String getVaultUrl()

setVaultUrl

public void setVaultUrl(java.lang.String vaultUrl)

getVaultToken

public java.lang.String getVaultToken()

setVaultToken

public void setVaultToken(java.lang.String vaultToken)

getVaultSecrets

public java.util.List<java.lang.String> getVaultSecrets()

setVaultSecrets

public void setVaultSecrets(java.util.List<java.lang.String> vaultSecrets)