package evolutions
- Alphabetic
- Public
- Protected
Type Members
- class ApplicationEvolutions extends AnyRef
Run evolutions on application startup.
Run evolutions on application startup. Automatically runs on construction.
- Annotations
- @Singleton()
- class ApplicationEvolutionsProvider extends Provider[ApplicationEvolutions]
- Annotations
- @Singleton()
- class ClassLoaderEvolutionsReader extends ResourceEvolutionsReader
Evolutions reader that reads evolution files from a class loader.
- class DatabaseEvolutions extends AnyRef
Evolutions for a particular database.
- class DefaultEvolutionsApi extends EvolutionsApi
Default implementation of the evolutions API.
Default implementation of the evolutions API.
- Annotations
- @Singleton()
- class DefaultEvolutionsConfig extends EvolutionsConfig
Default evolutions configuration.
- class DefaultEvolutionsConfigParser extends Provider[EvolutionsConfig]
A provider that creates an EvolutionsConfig from the play.api.Configuration.
A provider that creates an EvolutionsConfig from the play.api.Configuration.
- Annotations
- @Singleton()
- case class DefaultEvolutionsDatasourceConfig(enabled: Boolean, schema: String, metaTable: String, autocommit: Boolean, useLocks: Boolean, autoApply: Boolean, autoApplyDowns: Boolean, skipApplyDownsOnly: Boolean, substitutionsPrefix: String, substitutionsSuffix: String, substitutionsMappings: Map[String, String], substitutionsEscape: Boolean, path: String) extends EvolutionsDatasourceConfig with Product with Serializable
Default evolutions datasource configuration.
- case class DownScript(evolution: Evolution) extends Script with Product with Serializable
A DOWN Script to run on the database.
A DOWN Script to run on the database.
- evolution
the original evolution
- class DynamicEvolutions extends AnyRef
Default implementation for optional dynamic evolutions.
Default implementation for optional dynamic evolutions.
- Annotations
- @Singleton()
- class EnvironmentEvolutionsReader extends ResourceEvolutionsReader
Read evolution files from the application environment.
Read evolution files from the application environment.
- Annotations
- @Singleton()
- case class Evolution(revision: Int, sql_up: String = "", sql_down: String = "") extends Product with Serializable
An SQL evolution - database changes associated with a software version.
An SQL evolution - database changes associated with a software version.
An evolution includes ‘up’ changes, to upgrade to the next version, as well as ‘down’ changes, to downgrade the database to the previous version.
- revision
revision number
- sql_up
the SQL statements for UP application
- sql_down
the SQL statements for DOWN application
- trait EvolutionsApi extends AnyRef
Evolutions API.
- trait EvolutionsComponents extends AnyRef
Components for default implementation of the evolutions API.
- trait EvolutionsConfig extends AnyRef
Evolutions configuration for all datasources.
- trait EvolutionsDatasourceConfig extends AnyRef
Evolutions configuration for a given datasource.
- class EvolutionsModule extends SimpleModule
Default module for evolutions API.
- trait EvolutionsReader extends AnyRef
Reader for evolutions
- class EvolutionsWebCommands extends HandleWebCommandSupport
Web command handler for applying evolutions on application start.
Web command handler for applying evolutions on application start.
- Annotations
- @Singleton()
- case class InconsistentDatabase(db: String, script: String, error: String, rev: Int, autocommit: Boolean) extends RichDescription with Product with Serializable
Exception thrown when the database is in an inconsistent state.
Exception thrown when the database is in an inconsistent state.
- db
the database name
- script
the evolution script
- error
an inconsistent state error
- rev
the revision
- case class InvalidDatabaseRevision(db: String, script: String) extends RichDescription with Product with Serializable
Exception thrown when the database is not up to date.
Exception thrown when the database is not up to date.
- db
the database name
- script
the script to be run to resolve the conflict.
- abstract class ResourceEvolutionsReader extends EvolutionsReader
Evolutions reader that reads evolutions from resources, for example, the file system or the classpath
- trait Script extends AnyRef
A Script to run on the database.
- class SimpleEvolutionsReader extends EvolutionsReader
Simple map based implementation of the evolutions reader.
- case class UpScript(evolution: Evolution) extends Script with Product with Serializable
An UP Script to run on the database.
An UP Script to run on the database.
- evolution
the original evolution
Value Members
- object ClassLoaderEvolutionsReader
Evolutions reader that reads evolution files from a class loader.
- object Evolutions
Defines Evolutions utilities functions.
- object OfflineEvolutions
Can be used to run off-line evolutions, i.e.
Can be used to run off-line evolutions, i.e. outside a running application.
- object SimpleEvolutionsReader
Simple map based implementation of the evolutions reader.
- object ThisClassLoaderEvolutionsReader extends ClassLoaderEvolutionsReader
Evolutions reader that reads evolution files from its own classloader.
Evolutions reader that reads evolution files from its own classloader. Only suitable for simple (flat) classloading environments.