io.ebean.migration

Class MigrationConfig

java.lang.Object

io.ebean.migration.MigrationConfig

public class MigrationConfig
extends Object

Configuration used to run the migration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MigrationConfig.DefaultMigrationFactory Default factory.

Constructor Summary

Constructors

Constructor and Description
MigrationConfig()

Method Summary

Modifier and Type	Method and Description
Connection	createConnection() Create a Connection to the database using the configured driver, url, username etc.
String	getApplySuffix() Return the suffix for migration resources (defaults to .sql).
ClassLoader	getClassLoader() Return the ClassLoader to use to load resources.
String	getDbDriver() Return the DB Driver.
String	getDbPassword() Return the DB password.
String	getDbSchema() Return the DB connection Schema.
String	getDbUrl() Return the DB connection URL.
String	getDbUsername() Return the DB username.
JdbcMigrationFactory	getJdbcMigrationFactory() Returns the jdbcMigrationFactory.
String	getMetaTable() Return the name of the migration table.
String	getMigrationPath() Return the root path used to find migrations.
Set<String>	getPatchInsertOn() Return the migrations that should not be run but inserted into history as if they have run.
Set<String>	getPatchResetChecksumOn() Return the migrations that should have their checksum reset.
String	getPlatformName() Return the DB platform name (used for platform create table and select for update syntax).
Map<String,String>	getRunPlaceholderMap() Return a map of name/value pairs that can be expressions replaced in migration scripts.
String	getRunPlaceholders() Return a Comma and equals delimited key/value placeholders to replace in DDL scripts.
boolean	isCreateSchemaIfNotExists() Return true if migration should create the schema if it does not exist.
boolean	isSkipChecksum() Return true if checksum check should be skipped (during development).
void	load(Properties props) Load configuration from standard properties.
void	setApplySuffix(String applySuffix) Set the suffix for migration resources.
void	setClassLoader(ClassLoader classLoader) Set the ClassLoader to use when loading resources.
void	setCreateSchemaIfNotExists(boolean createSchemaIfNotExists) Set to create Schema if it does not exist.
void	setDbDriver(String dbDriver) Set the DB Driver.
void	setDbPassword(String dbPassword) Set the DB password.
void	setDbSchema(String dbSchema) Set the DB connection Schema.
void	setDbUrl(String dbUrl) Set the DB connection URL.
void	setDbUsername(String dbUsername) Set the DB username.
void	setJdbcMigrationFactory(JdbcMigrationFactory jdbcMigrationFactory) Sets the jdbcMigrationFactory.
void	setMetaTable(String metaTable) Set the name of the migration table.
void	setMigrationPath(String migrationPath) Set the root path used to find migrations.
void	setPatchInsertOn(Set<String> patchInsertOn) Set the migrations that should not be run but inserted into history as if they have run.
void	setPatchInsertOn(String versionsCommaDelimited) Set the migrations that should not be run but inserted into history as if they have run.
void	setPatchResetChecksumOn(Set<String> patchResetChecksumOn) Set the migrations that should have their checksum reset.
void	setPatchResetChecksumOn(String versionsCommaDelimited) Set the migrations that should have their checksum reset as a comma delimited list.
void	setPlatformName(String platformName) Set a DB platform name (to load specific create table and select for update syntax).
void	setRunPlaceholderMap(Map<String,String> runPlaceholderMap) Set a map of name/value pairs that can be expressions replaced in migration scripts.
void	setRunPlaceholders(String runPlaceholders) Set a Comma and equals delimited key/value placeholders to replace in DDL scripts.
void	setSkipChecksum(boolean skipChecksum) Set to true to skip the checksum check.

Methods inherited from class java.lang.Object

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

Constructor Detail

MigrationConfig

public MigrationConfig()

Method Detail

getMetaTable

public String getMetaTable()

Return the name of the migration table.

setMetaTable

public void setMetaTable(String metaTable)

Set the name of the migration table.

setPatchResetChecksumOn

public void setPatchResetChecksumOn(String versionsCommaDelimited)

Set the migrations that should have their checksum reset as a comma delimited list.

setPatchResetChecksumOn

public void setPatchResetChecksumOn(Set<String> patchResetChecksumOn)

Set the migrations that should have their checksum reset.

getPatchResetChecksumOn

public Set<String> getPatchResetChecksumOn()

Return the migrations that should have their checksum reset.

setPatchInsertOn

public void setPatchInsertOn(String versionsCommaDelimited)

Set the migrations that should not be run but inserted into history as if they have run.

setPatchInsertOn

public void setPatchInsertOn(Set<String> patchInsertOn)

Set the migrations that should not be run but inserted into history as if they have run.

This can be useful when we need to pull out DDL from a repeatable migration that should really only run once. We can pull out that DDL as a new migration and add it to history as if it had been run (we can only do this when we know it exists in all environments including production).

getPatchInsertOn

public Set<String> getPatchInsertOn()

Return the migrations that should not be run but inserted into history as if they have run.

isSkipChecksum

public boolean isSkipChecksum()

Return true if checksum check should be skipped (during development).

setSkipChecksum

public void setSkipChecksum(boolean skipChecksum)

Set to true to skip the checksum check.

This is intended for use during development only.

getRunPlaceholders

public String getRunPlaceholders()

Return a Comma and equals delimited key/value placeholders to replace in DDL scripts.

setRunPlaceholders

public void setRunPlaceholders(String runPlaceholders)

Set a Comma and equals delimited key/value placeholders to replace in DDL scripts.

getRunPlaceholderMap

public Map<String,String> getRunPlaceholderMap()

Return a map of name/value pairs that can be expressions replaced in migration scripts.

setRunPlaceholderMap

public void setRunPlaceholderMap(Map<String,String> runPlaceholderMap)

Set a map of name/value pairs that can be expressions replaced in migration scripts.

getMigrationPath

public String getMigrationPath()

Return the root path used to find migrations.

setMigrationPath

public void setMigrationPath(String migrationPath)

Set the root path used to find migrations.

getApplySuffix

public String getApplySuffix()

Return the suffix for migration resources (defaults to .sql).

setApplySuffix

public void setApplySuffix(String applySuffix)

Set the suffix for migration resources.

getDbUsername

public String getDbUsername()

Return the DB username.

Used when a Connection to run the migration is not supplied.

setDbUsername

public void setDbUsername(String dbUsername)

Set the DB username.

Used when a Connection to run the migration is not supplied.

getDbPassword

public String getDbPassword()

Return the DB password.

Used when creating a Connection to run the migration.

setDbPassword

public void setDbPassword(String dbPassword)

Set the DB password.

Used when creating a Connection to run the migration.

getDbDriver

public String getDbDriver()

Return the DB Driver.

Used when creating a Connection to run the migration.

setDbDriver

public void setDbDriver(String dbDriver)

Set the DB Driver.

Used when creating a Connection to run the migration.

getDbUrl

public String getDbUrl()

Return the DB connection URL.

Used when creating a Connection to run the migration.

setDbUrl

public void setDbUrl(String dbUrl)

Set the DB connection URL.

Used when creating a Connection to run the migration.

getDbSchema

public String getDbSchema()

Return the DB connection Schema.

Used when creating a Connection to run the migration.

setDbSchema

public void setDbSchema(String dbSchema)

Set the DB connection Schema.

Used when creating a Connection to run the migration.

isCreateSchemaIfNotExists

public boolean isCreateSchemaIfNotExists()

Return true if migration should create the schema if it does not exist.

setCreateSchemaIfNotExists

public void setCreateSchemaIfNotExists(boolean createSchemaIfNotExists)

Set to create Schema if it does not exist.

getPlatformName

public String getPlatformName()

Return the DB platform name (used for platform create table and select for update syntax).

setPlatformName

public void setPlatformName(String platformName)

Set a DB platform name (to load specific create table and select for update syntax).

getClassLoader

public ClassLoader getClassLoader()

Return the ClassLoader to use to load resources.

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Set the ClassLoader to use when loading resources.

getJdbcMigrationFactory

public JdbcMigrationFactory getJdbcMigrationFactory()

Returns the jdbcMigrationFactory.

setJdbcMigrationFactory

public void setJdbcMigrationFactory(JdbcMigrationFactory jdbcMigrationFactory)

Sets the jdbcMigrationFactory.

load

public void load(Properties props)

Load configuration from standard properties.

createConnection

public Connection createConnection()

Create a Connection to the database using the configured driver, url, username etc.

Used when an existing DataSource or Connection is not supplied.