play.api.db

evolutions

package evolutions

Visibility
  1. Public
  2. All

Type Members

  1. class ApplicationEvolutions extends AnyRef

    Run evolutions on application startup.

    Run evolutions on application startup. Automatically runs on construction.

    Annotations
    @Singleton()

  2. class ApplicationEvolutionsProvider extends Provider[ApplicationEvolutions]

    Annotations
    @Singleton()

  3. class ClassLoaderEvolutionsReader extends ResourceEvolutionsReader

    Evolutions reader that reads evolution files from a class loader.

  4. class DatabaseEvolutions extends AnyRef

    Evolutions for a particular database.

  5. class DefaultEvolutionsApi extends EvolutionsApi

    Default implementation of the evolutions API.

    Default implementation of the evolutions API.

    Annotations
    @Singleton()

  6. class DefaultEvolutionsConfig extends EvolutionsConfig

    Default evolutions configuration.

  7. 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()

  8. case class DefaultEvolutionsDatasourceConfig(enabled: Boolean, autocommit: Boolean, useLocks: Boolean, autoApply: Boolean, autoApplyDowns: Boolean) extends EvolutionsDatasourceConfig with Product with Serializable

    Default evolutions datasource configuration.

  9. 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

  10. class DynamicEvolutions extends AnyRef

    Default implementation for optional dynamic evolutions.

    Default implementation for optional dynamic evolutions.

    Annotations
    @Singleton()

  11. class EnvironmentEvolutionsReader extends ResourceEvolutionsReader

    Read evolution files from the application environment.

    Read evolution files from the application environment.

    Annotations
    @Singleton()

  12. 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

  13. trait EvolutionsApi extends AnyRef

    Evolutions API.

  14. trait EvolutionsComponents extends AnyRef

    Components for default implementation of the evolutions API.

  15. trait EvolutionsConfig extends AnyRef

    Evolutions configuration for all datasources.

  16. trait EvolutionsDatasourceConfig extends AnyRef

    Evolutions configuration for a given datasource.

  17. class EvolutionsModule extends Module

    Default module for evolutions API.

  18. trait EvolutionsReader extends AnyRef

    Reader for evolutions

  19. class EvolutionsWebCommands extends HandleWebCommandSupport

    Web command handler for applying evolutions on application start.

    Web command handler for applying evolutions on application start.

    Annotations
    @Singleton()

  20. case class InconsistentDatabase(db: String, script: String, error: String, rev: Int) 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

  21. 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.

  22. abstract class ResourceEvolutionsReader extends EvolutionsReader

    Evolutions reader that reads evolutions from resources, for example, the file system or the classpath

  23. trait Script extends AnyRef

    A Script to run on the database.

  24. class SimpleEvolutionsReader extends EvolutionsReader

    Simple map based implementation of the evolutions reader.

  25. 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

  1. object ClassLoaderEvolutionsReader

    Evolutions reader that reads evolution files from a class loader.

  2. object Evolutions

    Defines Evolutions utilities functions.

  3. 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.

  4. object SimpleEvolutionsReader

    Simple map based implementation of the evolutions reader.

  5. 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.

Ungrouped