Flyway plugin for Play 2.1 or later. It aims to be a substitute for play-evolutions.

Features

  • Based on Flyway
  • No 'Downs' part.
  • Independent of DBPlugin(play.api.db).

Install

For Play 2.3.x

In Build.scala/build.sbt

libraryDependencies += "com.github.tototoshi" %% "play-flyway" % "1.2.0"

and write play.plugins.

1000:com.github.tototoshi.play2.flyway.Plugin

For Play 2.2.x

In Build.scala/build.sbt

libraryDependencies += "com.github.tototoshi" %% "play-flyway" % "1.0.4"

and write play.plugins.

1000:com.github.tototoshi.play2.flyway.Plugin

For Play 2.1.x

In Build.scala/build.sbt

libraryDependencies += "com.github.tototoshi" %% "play-flyway" % "0.2.0"

and write play.plugins.

1000:com.github.tototoshi.play2.flyway.Plugin

Getting Started

Place migration scripts

A migration script is just a simple SQL file.

CREATE TABLE FOO (.............

Place your migration scripts in conf/db/migration/${dbName} .

playapp
├── app
│   ├── controllers
│   ├── models
│   └── views
├── conf
│   ├── application.conf
│   ├── db
│   │   └── migration
│   │       ├── default
│   │       │   ├── V1__Create_person_table.sql
│   │       │   └── V2__Add_people.sql
│   │       └── secondary
│   │           ├── V1__create_job_table.sql
│   │           └── V2__Add_job.sql
│   ├── play.plugins
│   └── routes

Please see flyway's documents about the naming convention for migration scripts.

http://flywaydb.org/documentation/migration/sql.html

Placeholders

Flyway can replace placeholders in Sql migrations. The default pattern is ${placeholder}. This can be configured using the placeholderPrefix and placeholderSuffix properties.

The placeholder prefix, suffix and key-value pairs can be specificed in application.conf, e.g.

db.default.migration.placeholderPrefix="$flyway{{{"
db.default.migration.placeholderSuffix="}}}"
db.default.migration.placeholders.foo="bar"
db.default.migration.placeholders.hoge="pupi"

This would cause

INSERT INTO USERS ($flyway{{{foo}}}) VALUES ('$flyway{{{hoge}}}')

to be rewritten to

INSERT INTO USERS (bar) VALUES ('pupi')

Enable/disable Validation

From flyway 3.0, validate run before migrate by default. Set validateOnMigrate to false if you want to disable this.

db.${dbName}.migration.validateOnMigrate=false // true by default

Dev

screenshot

For existing schema, Flyway has a option called 'initOnMigrate'. This option is enabled when -Ddb.${dbName}.migration.initOnMigrate=true. For example, $ play -Ddb.default.migration.initOnMigrate=true

Of course, You can write this in your application.conf.

Manual migration is also supported. Click 'Other operations' or open /@flyway/${dbName} directly.

screenshot

Test

In Test mode, migration is done automatically.

Prod

In production mode, migration is done automatically if db.${dbName}.migration.auto is set to be true in application.conf. Otherwise it failed to start when migration is needed.

$ play -Ddb.default.migration.auto=true start

Example application

seratch/devteam-app is using play-flyway. Maybe this is a good example.

Change Log

1.2.0

  • Support Java-based migration (#28)

1.1.4

  • Flyway 3.1 (#27)

1.1.3

  • Added encoding explicitly for Windows PC (#26)

1.1.2

  • Added support for placeholders in migration files (#22)

1.1.1

  • Added a configuration key to disable validateOnMigrate for compatibility (#18)

1.1.0

  • Suport Play 2.3.0 and Flyway 3.0
  • Applied Twitter Bootstrap theme
  • Delay initialization (#17)
  • Init with version number (#8)

1.0.4

  • Add URL parser for URLs starting with "postgres://" etc. (#11)

1.0.3

  • Disable the plugin when flywayplugin=disabled is found in application.conf.

1.0.2

  • Fixed #7: Reading "db.${dbName}.password", but not "db.${dbName}.pass"

1.0.1

  • Supports reading the driver configuration parameter from Play2 config.
  • Updated flyway to 2.3.

License

  • Apache 2.0 License