com.avaje.ebean.dbmigration

Class DbMigration

java.lang.Object

com.avaje.ebean.dbmigration.DbMigration

public class DbMigration
extends Object

Generates DB Migration xml and sql scripts.

Reads the prior migrations and compares with the current model of the EbeanServer and generates a migration 'diff' in the form of xml document with the logical schema changes and a series of sql scripts to apply, rollback the applied changes if necessary and drop objects (drop tables, drop columns).

This does not run the migration or ddl scripts but just generates them.

      DbMigration migration = new DbMigration();
      migration.setPathToResources("src/main/resources");
      migration.setPlatform(DbPlatformName.ORACLE);

      migration.generateMigration();

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbMigration.Pair Holds a platform and prefix.

Field Summary

Fields

Modifier and Type	Field and Description
protected DbConstraintNaming	constraintNaming
protected DatabasePlatform	databasePlatform
protected static org.slf4j.Logger	logger
protected DbMigrationConfig	migrationConfig
protected boolean	online Set to true if DbMigration run with online EbeanServer instance.
protected String	pathToResources
protected List<DbMigration.Pair>	platforms
protected com.avaje.ebeaninternal.api.SpiEbeanServer	server
protected ServerConfig	serverConfig

Constructor Summary

Constructors

Constructor and Description
DbMigration() Create for offline migration generation.
DbMigration(EbeanServer server) Create using online EbeanServer.

Method Summary

Modifier and Type	Method and Description
void	addPlatform(DbPlatformName platform, String prefix) Add an additional platform to write the migration DDL.
void	generateMigration() Generate the next migration xml file and associated apply and rollback sql scripts.
protected File	getMigrationDirectory() Return the file path to write the xml and sql to.
protected File	getModelDirectory(File migrationDirectory) Return the model directory (relative to the migration directory).
protected DatabasePlatform	getPlatform(DbPlatformName platform) Return the DatabasePlatform given the platform key.
protected void	setDefaults() Set default server and platform if necessary.
void	setPathToResources(String pathToResources) Set the path from the current working directory to the application resources.
void	setPlatform(DatabasePlatform databasePlatform) Set the specific platform to generate DDL for.
void	setPlatform(DbPlatformName platform) Set the specific platform to generate DDL for.
void	setServer(EbeanServer ebeanServer) Set the server to use to determine the current model.
void	setServerConfig(ServerConfig config) Set the serverConfig to use.
protected void	writeExtraPlatformDdl(String fullVersion, com.avaje.ebean.dbmigration.model.CurrentModel currentModel, com.avaje.ebean.dbmigration.migration.Migration dbMigration, File writePath) Write any extra platform ddl.
protected boolean	writeMigrationXml(com.avaje.ebean.dbmigration.migration.Migration dbMigration, File resourcePath, String fullVersion) Write the migration xml.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

online

protected final boolean online

Set to true if DbMigration run with online EbeanServer instance.

server

protected com.avaje.ebeaninternal.api.SpiEbeanServer server

migrationConfig

protected DbMigrationConfig migrationConfig

pathToResources

protected String pathToResources

databasePlatform

protected DatabasePlatform databasePlatform

platforms

protected List<DbMigration.Pair> platforms

serverConfig

protected ServerConfig serverConfig

constraintNaming

protected DbConstraintNaming constraintNaming

Constructor Detail

DbMigration

public DbMigration()

Create for offline migration generation.

DbMigration

public DbMigration(EbeanServer server)

Create using online EbeanServer.

Method Detail

setPathToResources

public void setPathToResources(String pathToResources)

Set the path from the current working directory to the application resources.

This defaults to maven style 'src/main/resources'.

setServer

public void setServer(EbeanServer ebeanServer)

Set the server to use to determine the current model. Typically this is not called explicitly.

setServerConfig

public void setServerConfig(ServerConfig config)

Set the serverConfig to use. Typically this is not called explicitly.

setPlatform

public void setPlatform(DbPlatformName platform)

Set the specific platform to generate DDL for.

If not set this defaults to the platform of the default server.

setPlatform

public void setPlatform(DatabasePlatform databasePlatform)

Set the specific platform to generate DDL for.

If not set this defaults to the platform of the default server.

addPlatform

public void addPlatform(DbPlatformName platform,
                        String prefix)

Add an additional platform to write the migration DDL.

Use this when you want to generate sql scripts for multiple database platforms from the migration (e.g. generate migration sql for MySql, Postgres and Oracle).

generateMigration

public void generateMigration()
                       throws IOException

Generate the next migration xml file and associated apply and rollback sql scripts.

This does not run the migration or ddl scripts but just generates them.

Example: Run for a single specific platform

      DbMigration migration = new DbMigration();
      migration.setPathToResources("src/main/resources");
      migration.setPlatform(DbPlatformName.ORACLE);

      migration.generateMigration();

Example: Run migration generating DDL for multiple platforms

      DbMigration migration = new DbMigration();
      migration.setPathToResources("src/main/resources");

      migration.addPlatform(DbPlatformName.POSTGRES, "pg");
      migration.addPlatform(DbPlatformName.MYSQL, "mysql");
      migration.addPlatform(DbPlatformName.ORACLE, "mysql");

      migration.generateMigration();

Throws:

IOException

writeExtraPlatformDdl

protected void writeExtraPlatformDdl(String fullVersion,
                                     com.avaje.ebean.dbmigration.model.CurrentModel currentModel,
                                     com.avaje.ebean.dbmigration.migration.Migration dbMigration,
                                     File writePath)
                              throws IOException

Write any extra platform ddl.

Throws:

IOException

writeMigrationXml

protected boolean writeMigrationXml(com.avaje.ebean.dbmigration.migration.Migration dbMigration,
                                    File resourcePath,
                                    String fullVersion)

Write the migration xml.

setDefaults

protected void setDefaults()

Set default server and platform if necessary.

getMigrationDirectory

protected File getMigrationDirectory()

Return the file path to write the xml and sql to.

getModelDirectory

protected File getModelDirectory(File migrationDirectory)

Return the model directory (relative to the migration directory).

getPlatform

protected DatabasePlatform getPlatform(DbPlatformName platform)

Return the DatabasePlatform given the platform key.