class DefaultEvolutionsApi extends EvolutionsApi
Default implementation of the evolutions API.
- Annotations
- @Singleton()
- Source
- EvolutionsApi.scala
- Alphabetic
- By Inheritance
- DefaultEvolutionsApi
- EvolutionsApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- 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
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi
- 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
- DefaultEvolutionsApi → EvolutionsApi