object Evolutions
- Alphabetic
- By Inheritance
- Evolutions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
def
applyEvolutions(database: Database, evolutionsReader: EvolutionsReader = ThisClassLoaderEvolutionsReader, autocommit: Boolean = true, schema: String = ""): 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 where all the play evolution tables are saved in
-
def
cleanupEvolutions(database: Database, autocommit: Boolean = true, schema: String = ""): 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 atocommit or not, evolutions will be manually committed if false.
- schema
The schema where all the play evolution tables are saved in
-
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): String
Default evolutions directory location.
- def fileName(db: String, revision: String): String
-
def
fileName(db: String, revision: Int): String
Default evolution file location.
- def resourceName(db: String, revision: 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", 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 = "")(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
- block
The block to execute
Deprecated Value Members
-
def
applyFor(dbName: String, path: File = new java.io.File("."), autocommit: Boolean = true, schema: String = ""): Unit
Apply pending evolutions for the given database.
Apply pending evolutions for the given database.
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Inject or create an instance of EvolutionsApi and use EvolutionsApi#applyFor