object Evolutions
- Alphabetic
- By Inheritance
- Evolutions
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- def applyEvolutions(database: Database, evolutionsReader: EvolutionsReader = ThisClassLoaderEvolutionsReader, autocommit: Boolean = true, schema: String = "", metaTable: String = "play_evolutions", substitutionsMappings: Map[String, String] = Map.empty, substitutionsPrefix: String = "$evolutions{{{", substitutionsSuffix: String = "}}}", substitutionsEscape: Boolean = true): Unit
Apply evolutions for the given database.
Apply evolutions for the given database.
- database
The database to apply the evolutions to.
- evolutionsReader
The reader to read the evolutions.
- autocommit
Whether to use autocommit or not, evolutions will be manually committed if false.
- schema
The schema that all the play evolution tables are saved in
- metaTable
Table to keep evolutions' meta 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.
- def cleanupEvolutions(database: Database, autocommit: Boolean = true, schema: String = "", metaTable: String = "play_evolutions", substitutionsMappings: Map[String, String] = Map.empty, substitutionsPrefix: String = "$evolutions{{{", substitutionsSuffix: String = "}}}", substitutionsEscape: Boolean = true): Unit
Cleanup evolutions for the given database.
Cleanup evolutions for the given database.
This will leave the database in the original state it was before evolutions were applied, by running the down scripts for all the evolutions that have been previously applied to the database.
- database
The database to clean the evolutions for.
- autocommit
Whether to use autocommit or not, evolutions will be manually committed if false.
- schema
The schema where all the play evolution tables are saved in
- metaTable
Table to keep evolutions' meta 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.
- def conflictings(downs: Seq[Evolution], ups: Seq[Evolution]): (Seq[Evolution], Seq[Evolution])
Compare two evolution sequences.
Compare two evolution sequences.
- downs
the seq of downs
- ups
the seq of ups
- returns
the downs and ups to run to have the db synced to the current stage
- def directoryName(db: String, path: String = "evolutions"): String
Default evolutions directory location.
- def fileName(db: String, revision: String, path: String = "evolutions"): String
- def fileName(db: String, revision: Int, path: String): String
- def fileName(db: String, revision: Int): String
Default evolution file location.
- def resourceName(db: String, revision: String, path: String = "evolutions"): String
- def resourceName(db: String, revision: Int, path: String): String
- def resourceName(db: String, revision: Int): String
Default evolution resource name.
- def toHumanReadableScript(scripts: Seq[Script]): String
Translates evolution scripts into something human-readable.
Translates evolution scripts into something human-readable.
- scripts
the evolution scripts
- returns
a formatted script
- def updateEvolutionScript(db: String = "default", path: String = "evolutions", revision: Int = 1, comment: String = "Generated", ups: String, downs: String)(implicit environment: Environment): Unit
Updates a local (file-based) evolution script.
- def withEvolutions[T](database: Database, evolutionsReader: EvolutionsReader = ThisClassLoaderEvolutionsReader, autocommit: Boolean = true, schema: String = "", metaTable: String = "play_evolutions", substitutionsMappings: Map[String, String] = Map.empty, substitutionsPrefix: String = "$evolutions{{{", substitutionsSuffix: String = "}}}", substitutionsEscape: Boolean = true)(block: => T): T
Execute the following code block with the evolutions for the database, cleaning up afterwards by running the downs.
Execute the following code block with the evolutions for the database, cleaning up afterwards by running the downs.
- database
The database to execute the evolutions on
- evolutionsReader
The evolutions reader to use. Defaults to reading evolutions from the evolution readers own classloader.
- autocommit
Whether to use autocommit or not, evolutions will be manually committed if false.
- schema
The schema where all the play evolution tables are saved in
- metaTable
Table to keep evolutions' meta 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.
- block
The block to execute