play.db.evolutions

Class Evolutions

java.lang.Object

play.db.evolutions.Evolutions

public class Evolutions
extends java.lang.Object

Utilities for working with evolutions.

Constructor Summary

Constructors

Constructor and Description
Evolutions()

Method Summary

Modifier and Type	Method and Description
static void	applyEvolutions(Database database) Apply evolutions for the given database.
static void	applyEvolutions(Database database, play.api.db.evolutions.EvolutionsReader reader) Apply evolutions for the given database.
static void	applyEvolutions(Database database, play.api.db.evolutions.EvolutionsReader reader, boolean autocommit) Apply evolutions for the given database.
static void	applyEvolutions(Database database, play.api.db.evolutions.EvolutionsReader reader, boolean autocommit, java.lang.String schema) Apply evolutions for the given database.
static void	applyEvolutions(Database database, play.api.db.evolutions.EvolutionsReader reader, java.lang.String schema) Apply evolutions for the given database.
static void	applyEvolutions(Database database, java.lang.String schema) Apply evolutions for the given database.
static void	cleanupEvolutions(Database database) Cleanup evolutions for the given database.
static void	cleanupEvolutions(Database database, boolean autocommit) Cleanup evolutions for the given database.
static void	cleanupEvolutions(Database database, boolean autocommit, java.lang.String schema) Cleanup evolutions for the given database.
static void	cleanupEvolutions(Database database, java.lang.String schema) Cleanup evolutions for the given database.
static play.api.db.evolutions.EvolutionsReader	forDefault(Evolution... evolutions) Create an evolutions reader for the default database from a list of evolutions.
static play.api.db.evolutions.EvolutionsReader	fromClassLoader() Create an evolutions reader that reads evolution files from this class's own classloader.
static play.api.db.evolutions.EvolutionsReader	fromClassLoader(java.lang.ClassLoader classLoader) Create an evolutions reader that reads evolution files from a classloader.
static play.api.db.evolutions.EvolutionsReader	fromClassLoader(java.lang.ClassLoader classLoader, java.lang.String prefix) Create an evolutions reader that reads evolution files from a classloader.
static play.api.db.evolutions.EvolutionsReader	fromMap(java.util.Map<java.lang.String,java.util.List<Evolution>> evolutions) Create an evolutions reader based on a simple map of database names to evolutions.

Methods inherited from class java.lang.Object

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

Constructor Detail

Evolutions

public Evolutions()

Method Detail

fromClassLoader

public static play.api.db.evolutions.EvolutionsReader fromClassLoader()

Create an evolutions reader that reads evolution files from this class's own classloader.

Only useful in simple classloading environments, such as when the classloader structure is flat.

Returns:

the evolutions reader.

fromClassLoader

public static play.api.db.evolutions.EvolutionsReader fromClassLoader(java.lang.ClassLoader classLoader)

Create an evolutions reader that reads evolution files from a classloader.

Parameters:

classLoader - The classloader to read from.

Returns:

the evolutions reader.

fromClassLoader

public static play.api.db.evolutions.EvolutionsReader fromClassLoader(java.lang.ClassLoader classLoader,
                                                                      java.lang.String prefix)

Create an evolutions reader that reads evolution files from a classloader.

Parameters:

classLoader - The classloader to read from.

prefix - A prefix that gets added to the resource file names, for example, this could be used to namespace evolutions in different environments to work with different databases.

Returns:

the evolutions reader.

fromMap

public static play.api.db.evolutions.EvolutionsReader fromMap(java.util.Map<java.lang.String,java.util.List<Evolution>> evolutions)

Create an evolutions reader based on a simple map of database names to evolutions.

Parameters:

evolutions - The map of database names to evolutions.

Returns:

the evolutions reader.

forDefault

public static play.api.db.evolutions.EvolutionsReader forDefault(Evolution... evolutions)

Create an evolutions reader for the default database from a list of evolutions.

Parameters:

evolutions - The list of evolutions.

Returns:

the evolutions reader.

applyEvolutions

public static void applyEvolutions(Database database,
                                   play.api.db.evolutions.EvolutionsReader reader,
                                   boolean autocommit,
                                   java.lang.String schema)

Apply evolutions for the given database.

Parameters:

database - The database to apply the evolutions to.

reader - The reader to read the evolutions.

autocommit - Whether autocommit should be used.

schema - The schema where all the play evolution tables are saved in

applyEvolutions

public static void applyEvolutions(Database database,
                                   play.api.db.evolutions.EvolutionsReader reader,
                                   java.lang.String schema)

Apply evolutions for the given database.

Parameters:

database - The database to apply the evolutions to.

reader - The reader to read the evolutions.

schema - The schema where all the play evolution tables are saved in

applyEvolutions

public static void applyEvolutions(Database database,
                                   play.api.db.evolutions.EvolutionsReader reader,
                                   boolean autocommit)

Apply evolutions for the given database.

Parameters:

database - The database to apply the evolutions to.

reader - The reader to read the evolutions.

autocommit - Whether autocommit should be used.

applyEvolutions

public static void applyEvolutions(Database database,
                                   play.api.db.evolutions.EvolutionsReader reader)

Apply evolutions for the given database.

Parameters:

database - The database to apply the evolutions to.

reader - The reader to read the evolutions.

applyEvolutions

public static void applyEvolutions(Database database,
                                   java.lang.String schema)

Apply evolutions for the given database.

Parameters:

database - The database to apply the evolutions to.

schema - The schema where all the play evolution tables are saved in

applyEvolutions

public static void applyEvolutions(Database database)

Apply evolutions for the given database.

Parameters:

database - The database to apply the evolutions to.

cleanupEvolutions

public static void cleanupEvolutions(Database database,
                                     boolean autocommit,
                                     java.lang.String schema)

Cleanup evolutions for the given database.

This will run the down scripts for all the applied evolutions.

Parameters:

database - The database to apply the evolutions to.

autocommit - Whether autocommit should be used.

schema - The schema where all the play evolution tables are saved in

cleanupEvolutions

public static void cleanupEvolutions(Database database,
                                     boolean autocommit)

Cleanup evolutions for the given database.

This will run the down scripts for all the applied evolutions.

Parameters:

database - The database to apply the evolutions to.

autocommit - Whether autocommit should be used.

cleanupEvolutions

public static void cleanupEvolutions(Database database,
                                     java.lang.String schema)

Cleanup evolutions for the given database.

This will run the down scripts for all the applied evolutions.

Parameters:

database - The database to apply the evolutions to.

schema - The schema where all the play evolution tables are saved in

cleanupEvolutions

public static void cleanupEvolutions(Database database)

Cleanup evolutions for the given database.

This will run the down scripts for all the applied evolutions.

Parameters:

database - The database to apply the evolutions to.