org.springframework.boot.autoconfigure.flyway

Class FlywayProperties

java.lang.Object

org.springframework.boot.autoconfigure.flyway.FlywayProperties

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

Configuration properties for Flyway database migrations.

Since:

1.1.0

Author:

Dave Syer, Eddú Meléndez, Stephane Nicoll, Chris Bono

Constructor Summary

Constructors

Constructor and Description
FlywayProperties()

Method Summary

Modifier and Type	Method and Description
String	getBaselineDescription()
String	getBaselineMigrationPrefix()
String	getBaselineVersion()
Boolean	getBatch()
String[]	getCherryPick()
int	getConnectRetries()
Duration	getConnectRetriesInterval()
String	getDefaultSchema()
Boolean	getDetectEncoding()
String	getDriverClassName()
File	getDryRunOutput()
Charset	getEncoding()
String[]	getErrorOverrides()
List<String>	getIgnoreMigrationPatterns()
List<String>	getInitSqls()
String	getInstalledBy()
Map<String,String>	getJdbcProperties()
String	getKerberosConfigFile()
String	getLicenseKey()
List<String>	getLocations()
Integer	getLockRetryCount()
String	getOracleKerberosCacheFile()
String	getOracleKerberosConfigFile() Deprecated.
Boolean	getOracleSqlplus()
Boolean	getOracleSqlplusWarn()
String	getOracleWalletLocation()
Boolean	getOutputQueryResults()
String	getPassword()
String	getPlaceholderPrefix()
Map<String,String>	getPlaceholders()
String	getPlaceholderSuffix()
String	getRepeatableSqlMigrationPrefix()
List<String>	getSchemas()
String	getScriptPlaceholderPrefix()
String	getScriptPlaceholderSuffix()
Boolean	getSkipExecutingMigrations()
String	getSqlMigrationPrefix()
String	getSqlMigrationSeparator()
List<String>	getSqlMigrationSuffixes()
String	getSqlServerKerberosLoginFile()
Boolean	getStream()
String	getTable()
String	getTablespace()
String	getTarget()
String	getUndoSqlMigrationPrefix()
String	getUrl()
String	getUser()
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	isFailOnMissingLocations()
boolean	isGroup()
boolean	isIgnoreFutureMigrations() Deprecated.
boolean	isIgnoreIgnoredMigrations() Deprecated.
boolean	isIgnoreMissingMigrations() Deprecated.
boolean	isIgnorePendingMigrations() Deprecated.
boolean	isMixed()
boolean	isOutOfOrder()
boolean	isPlaceholderReplacement()
boolean	isSkipDefaultCallbacks()
boolean	isSkipDefaultResolvers()
boolean	isValidateMigrationNaming()
boolean	isValidateOnMigrate()
void	setBaselineDescription(String baselineDescription)
void	setBaselineMigrationPrefix(String baselineMigrationPrefix)
void	setBaselineOnMigrate(boolean baselineOnMigrate)
void	setBaselineVersion(String baselineVersion)
void	setBatch(Boolean batch)
void	setCheckLocation(boolean checkLocation) Deprecated.
void	setCherryPick(String[] cherryPick)
void	setCleanDisabled(boolean cleanDisabled)
void	setCleanOnValidationError(boolean cleanOnValidationError)
void	setConnectRetries(int connectRetries)
void	setConnectRetriesInterval(Duration connectRetriesInterval)
void	setCreateSchemas(boolean createSchemas)
void	setDefaultSchema(String defaultSchema)
void	setDetectEncoding(Boolean detectEncoding)
void	setDriverClassName(String driverClassName)
void	setDryRunOutput(File dryRunOutput)
void	setEnabled(boolean enabled)
void	setEncoding(Charset encoding)
void	setErrorOverrides(String[] errorOverrides)
void	setFailOnMissingLocations(boolean failOnMissingLocations)
void	setGroup(boolean group)
void	setIgnoreFutureMigrations(boolean ignoreFutureMigrations) Deprecated.
void	setIgnoreIgnoredMigrations(boolean ignoreIgnoredMigrations) Deprecated.
void	setIgnoreMigrationPatterns(List<String> ignoreMigrationPatterns)
void	setIgnoreMissingMigrations(boolean ignoreMissingMigrations) Deprecated.
void	setIgnorePendingMigrations(boolean ignorePendingMigrations) Deprecated.
void	setInitSqls(List<String> initSqls)
void	setInstalledBy(String installedBy)
void	setJdbcProperties(Map<String,String> jdbcProperties)
void	setKerberosConfigFile(String kerberosConfigFile)
void	setLicenseKey(String licenseKey)
void	setLocations(List<String> locations)
void	setLockRetryCount(Integer lockRetryCount)
void	setMixed(boolean mixed)
void	setOracleKerberosCacheFile(String oracleKerberosCacheFile)
void	setOracleKerberosConfigFile(String oracleKerberosConfigFile) Deprecated.
void	setOracleSqlplus(Boolean oracleSqlplus)
void	setOracleSqlplusWarn(Boolean oracleSqlplusWarn)
void	setOracleWalletLocation(String oracleWalletLocation)
void	setOutOfOrder(boolean outOfOrder)
void	setOutputQueryResults(Boolean outputQueryResults)
void	setPassword(String password)
void	setPlaceholderPrefix(String placeholderPrefix)
void	setPlaceholderReplacement(boolean placeholderReplacement)
void	setPlaceholders(Map<String,String> placeholders)
void	setPlaceholderSuffix(String placeholderSuffix)
void	setRepeatableSqlMigrationPrefix(String repeatableSqlMigrationPrefix)
void	setSchemas(List<String> schemas)
void	setScriptPlaceholderPrefix(String scriptPlaceholderPrefix)
void	setScriptPlaceholderSuffix(String scriptPlaceholderSuffix)
void	setSkipDefaultCallbacks(boolean skipDefaultCallbacks)
void	setSkipDefaultResolvers(boolean skipDefaultResolvers)
void	setSkipExecutingMigrations(Boolean skipExecutingMigrations)
void	setSqlMigrationPrefix(String sqlMigrationPrefix)
void	setSqlMigrationSeparator(String sqlMigrationSeparator)
void	setSqlMigrationSuffixes(List<String> sqlMigrationSuffixes)
void	setSqlServerKerberosLoginFile(String sqlServerKerberosLoginFile)
void	setStream(Boolean stream)
void	setTable(String table)
void	setTablespace(String tablespace)
void	setTarget(String target)
void	setUndoSqlMigrationPrefix(String undoSqlMigrationPrefix)
void	setUrl(String url)
void	setUser(String user)
void	setValidateMigrationNaming(boolean validateMigrationNaming)
void	setValidateOnMigrate(boolean validateOnMigrate)

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.

isFailOnMissingLocations

public boolean isFailOnMissingLocations()

setFailOnMissingLocations

public void setFailOnMissingLocations(boolean failOnMissingLocations)

getLocations

public List<String> getLocations()

setLocations

public void setLocations(List<String> locations)

getEncoding

public Charset getEncoding()

setEncoding

public void setEncoding(Charset encoding)

getConnectRetries

public int getConnectRetries()

setConnectRetries

public void setConnectRetries(int connectRetries)

getConnectRetriesInterval

public Duration getConnectRetriesInterval()

setConnectRetriesInterval

public void setConnectRetriesInterval(Duration connectRetriesInterval)

getLockRetryCount

public Integer getLockRetryCount()

setLockRetryCount

public void setLockRetryCount(Integer lockRetryCount)

getDefaultSchema

public String getDefaultSchema()

setDefaultSchema

public void setDefaultSchema(String defaultSchema)

getSchemas

public List<String> getSchemas()

setSchemas

public void setSchemas(List<String> schemas)

isCreateSchemas

public boolean isCreateSchemas()

setCreateSchemas

public void setCreateSchemas(boolean createSchemas)

getTable

public String getTable()

setTable

public void setTable(String table)

getTablespace

public String getTablespace()

setTablespace

public void setTablespace(String tablespace)

getBaselineDescription

public String getBaselineDescription()

setBaselineDescription

public void setBaselineDescription(String baselineDescription)

getBaselineVersion

public String getBaselineVersion()

setBaselineVersion

public void setBaselineVersion(String baselineVersion)

getInstalledBy

public String getInstalledBy()

setInstalledBy

public void setInstalledBy(String installedBy)

getPlaceholders

public Map<String,String> getPlaceholders()

setPlaceholders

public void setPlaceholders(Map<String,String> placeholders)

getPlaceholderPrefix

public String getPlaceholderPrefix()

setPlaceholderPrefix

public void setPlaceholderPrefix(String placeholderPrefix)

getPlaceholderSuffix

public String getPlaceholderSuffix()

setPlaceholderSuffix

public void setPlaceholderSuffix(String placeholderSuffix)

isPlaceholderReplacement

public boolean isPlaceholderReplacement()

setPlaceholderReplacement

public void setPlaceholderReplacement(boolean placeholderReplacement)

getSqlMigrationPrefix

public String getSqlMigrationPrefix()

setSqlMigrationPrefix

public void setSqlMigrationPrefix(String sqlMigrationPrefix)

getSqlMigrationSuffixes

public List<String> getSqlMigrationSuffixes()

setSqlMigrationSuffixes

public void setSqlMigrationSuffixes(List<String> sqlMigrationSuffixes)

getSqlMigrationSeparator

public String getSqlMigrationSeparator()

setSqlMigrationSeparator

public void setSqlMigrationSeparator(String sqlMigrationSeparator)

getRepeatableSqlMigrationPrefix

public String getRepeatableSqlMigrationPrefix()

setRepeatableSqlMigrationPrefix

public void setRepeatableSqlMigrationPrefix(String repeatableSqlMigrationPrefix)

getTarget

public String getTarget()

setTarget

public void setTarget(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 String getUser()

setUser

public void setUser(String user)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getDriverClassName

public String getDriverClassName()

setDriverClassName

public void setDriverClassName(String driverClassName)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getInitSqls

public List<String> getInitSqls()

setInitSqls

public void setInitSqls(List<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

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.flyway.ignore-migration-patterns")
public boolean isIgnoreMissingMigrations()

Deprecated.

setIgnoreMissingMigrations

@Deprecated
public void setIgnoreMissingMigrations(boolean ignoreMissingMigrations)

Deprecated.

isIgnoreIgnoredMigrations

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.flyway.ignore-migration-patterns")
public boolean isIgnoreIgnoredMigrations()

Deprecated.

setIgnoreIgnoredMigrations

@Deprecated
public void setIgnoreIgnoredMigrations(boolean ignoreIgnoredMigrations)

Deprecated.

isIgnorePendingMigrations

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.flyway.ignore-migration-patterns")
public boolean isIgnorePendingMigrations()

Deprecated.

setIgnorePendingMigrations

@Deprecated
public void setIgnorePendingMigrations(boolean ignorePendingMigrations)

Deprecated.

isIgnoreFutureMigrations

@Deprecated
 @DeprecatedConfigurationProperty(replacement="spring.flyway.ignore-migration-patterns")
public boolean isIgnoreFutureMigrations()

Deprecated.

setIgnoreFutureMigrations

@Deprecated
public void setIgnoreFutureMigrations(boolean ignoreFutureMigrations)

Deprecated.

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 Boolean getBatch()

setBatch

public void setBatch(Boolean batch)

getDryRunOutput

public File getDryRunOutput()

setDryRunOutput

public void setDryRunOutput(File dryRunOutput)

getErrorOverrides

public String[] getErrorOverrides()

setErrorOverrides

public void setErrorOverrides(String[] errorOverrides)

getLicenseKey

public String getLicenseKey()

setLicenseKey

public void setLicenseKey(String licenseKey)

getOracleSqlplus

public Boolean getOracleSqlplus()

setOracleSqlplus

public void setOracleSqlplus(Boolean oracleSqlplus)

getOracleSqlplusWarn

public Boolean getOracleSqlplusWarn()

setOracleSqlplusWarn

public void setOracleSqlplusWarn(Boolean oracleSqlplusWarn)

getOracleWalletLocation

public String getOracleWalletLocation()

setOracleWalletLocation

public void setOracleWalletLocation(String oracleWalletLocation)

getStream

public Boolean getStream()

setStream

public void setStream(Boolean stream)

getUndoSqlMigrationPrefix

public String getUndoSqlMigrationPrefix()

setUndoSqlMigrationPrefix

public void setUndoSqlMigrationPrefix(String undoSqlMigrationPrefix)

getCherryPick

public String[] getCherryPick()

setCherryPick

public void setCherryPick(String[] cherryPick)

getJdbcProperties

public Map<String,String> getJdbcProperties()

setJdbcProperties

public void setJdbcProperties(Map<String,String> jdbcProperties)

getKerberosConfigFile

public String getKerberosConfigFile()

setKerberosConfigFile

public void setKerberosConfigFile(String kerberosConfigFile)

getOracleKerberosCacheFile

public String getOracleKerberosCacheFile()

setOracleKerberosCacheFile

public void setOracleKerberosCacheFile(String oracleKerberosCacheFile)

getOracleKerberosConfigFile

@DeprecatedConfigurationProperty(replacement="spring.flyway.kerberos-config-file")
 @Deprecated
public String getOracleKerberosConfigFile()

Deprecated.

setOracleKerberosConfigFile

@Deprecated
public void setOracleKerberosConfigFile(String oracleKerberosConfigFile)

Deprecated.

getOutputQueryResults

public Boolean getOutputQueryResults()

setOutputQueryResults

public void setOutputQueryResults(Boolean outputQueryResults)

getSqlServerKerberosLoginFile

public String getSqlServerKerberosLoginFile()

setSqlServerKerberosLoginFile

public void setSqlServerKerberosLoginFile(String sqlServerKerberosLoginFile)

getSkipExecutingMigrations

public Boolean getSkipExecutingMigrations()

setSkipExecutingMigrations

public void setSkipExecutingMigrations(Boolean skipExecutingMigrations)

getIgnoreMigrationPatterns

public List<String> getIgnoreMigrationPatterns()

setIgnoreMigrationPatterns

public void setIgnoreMigrationPatterns(List<String> ignoreMigrationPatterns)

getDetectEncoding

public Boolean getDetectEncoding()

setDetectEncoding

public void setDetectEncoding(Boolean detectEncoding)

getBaselineMigrationPrefix

public String getBaselineMigrationPrefix()

setBaselineMigrationPrefix

public void setBaselineMigrationPrefix(String baselineMigrationPrefix)

getScriptPlaceholderPrefix

public String getScriptPlaceholderPrefix()

setScriptPlaceholderPrefix

public void setScriptPlaceholderPrefix(String scriptPlaceholderPrefix)

getScriptPlaceholderSuffix

public String getScriptPlaceholderSuffix()

setScriptPlaceholderSuffix

public void setScriptPlaceholderSuffix(String scriptPlaceholderSuffix)