Packages

c

play.api.db.evolutions

DefaultEvolutionsApi

class DefaultEvolutionsApi extends EvolutionsApi

Default implementation of the evolutions API.

Annotations
@Singleton()
Source
EvolutionsApi.scala
Linear Supertypes
EvolutionsApi, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultEvolutionsApi
  2. EvolutionsApi
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DefaultEvolutionsApi(dbApi: DBApi)
    Annotations
    @Inject()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def applyFor(dbName: String, path: File = new File("."), autocommit: Boolean = true, schema: String = "", metaTable: String = "play_evolutions", substitutionsMappings: Map[String, String] = Map.empty, substitutionsPrefix: String = "$evolutions{{{", substitutionsSuffix: String = "}}}", substitutionsEscape: Boolean = true, evolutionsPath: String = "evolutions"): Unit

    Apply pending evolutions for the given database.

    Apply pending evolutions for the given database.

    Definition Classes
    EvolutionsApi
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def evolve(db: String, scripts: Seq[Script], autocommit: Boolean, schema: String, metaTable: String, substitutionsMappings: Map[String, String], substitutionsPrefix: String, substitutionsSuffix: String, substitutionsEscape: Boolean): Unit

    Apply evolution scripts to the database.

    Apply evolution scripts to the database.

    db

    the database name

    scripts

    the evolution scripts to run

    autocommit

    determines whether the connection uses autocommit

    schema

    The schema where all the play evolution tables are saved in

    metaTable

    Table to keep evolutions' data

    substitutionsMappings

    Mappings of variables (without the prefix and suffix) and their replacements.

    substitutionsPrefix

    Prefix of the variable to substitute, e.g. "$evolutions

    ".
    @param substitutionsSuffix Suffix of the variable to substitute, e.g. "

    ".

    substitutionsEscape

    Whetever escaping of variables is enabled via a preceding "!". E.g. "!$evolutions

    my_variable

    " ends up as "$evolutions

    my_variable

    " in the final sql instead of replacing it with its substitution.

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  10. def evolve(db: String, scripts: Seq[Script], autocommit: Boolean, schema: String, metaTable: String): Unit

    Apply evolution scripts to the database.

    Apply evolution scripts to the database.

    db

    the database name

    scripts

    the evolution scripts to run

    autocommit

    determines whether the connection uses autocommit

    schema

    The schema where all the play evolution tables are saved in

    metaTable

    Table to keep evolutions' data

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  11. def evolve(db: String, scripts: Seq[Script], autocommit: Boolean, schema: String): Unit

    Apply evolution scripts to the database.

    Apply evolution scripts to the database.

    db

    the database name

    scripts

    the evolution scripts to run

    autocommit

    determines whether the connection uses autocommit

    schema

    The schema where all the play evolution tables are saved in

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. def resetScripts(db: String, schema: String, metaTable: String): Seq[Script]

    Get all scripts necessary to reset the database state to its initial state.

    Get all scripts necessary to reset the database state to its initial state.

    db

    the database name

    schema

    The schema where all the play evolution tables are saved in

    metaTable

    Table to keep evolutions' data

    returns

    evolution scripts

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  19. def resetScripts(db: String, schema: String): Seq[Script]

    Get all scripts necessary to reset the database state to its initial state.

    Get all scripts necessary to reset the database state to its initial state.

    db

    the database name

    schema

    The schema where all the play evolution tables are saved in

    returns

    evolution scripts

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  20. def resolve(db: String, revision: Int, schema: String, metaTable: String): Unit

    Resolve evolution conflicts.

    Resolve evolution conflicts.

    db

    the database name

    revision

    the revision to mark as resolved

    schema

    The schema where all the play evolution tables are saved in

    metaTable

    Table to keep evolutions' meta data

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  21. def resolve(db: String, revision: Int, schema: String): Unit

    Resolve evolution conflicts.

    Resolve evolution conflicts.

    db

    the database name

    revision

    the revision to mark as resolved

    schema

    The schema where all the play evolution tables are saved in

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  22. def scripts(db: String, reader: EvolutionsReader, schema: String, metaTable: String): Seq[Script]

    Create evolution scripts.

    Create evolution scripts.

    db

    the database name

    reader

    evolution file reader

    schema

    The schema where all the play evolution tables are saved in

    metaTable

    Table to keep evolutions' meta data

    returns

    evolution scripts

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  23. def scripts(db: String, reader: EvolutionsReader, schema: String): Seq[Script]

    Create evolution scripts.

    Create evolution scripts.

    db

    the database name

    reader

    evolution file reader

    schema

    The schema where all the play evolution tables are saved in

    returns

    evolution scripts

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  24. def scripts(db: String, evolutions: Seq[Evolution], schema: String, metaTable: String): Seq[Script]

    Create evolution scripts.

    Create evolution scripts.

    db

    the database name

    evolutions

    the evolutions for the application

    schema

    The schema where all the play evolution tables are saved in

    metaTable

    Table to keep evolutions' meta data

    returns

    evolution scripts

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  25. def scripts(db: String, evolutions: Seq[Evolution], schema: String): Seq[Script]

    Create evolution scripts.

    Create evolution scripts.

    db

    the database name

    evolutions

    the evolutions for the application

    schema

    The schema where all the play evolution tables are saved in

    returns

    evolution scripts

    Definition Classes
    DefaultEvolutionsApiEvolutionsApi
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from EvolutionsApi

Inherited from AnyRef

Inherited from Any

Ungrouped