org.jooby.flyway

Class Flywaydb

java.lang.Object

org.jooby.flyway.Flywaydb

All Implemented Interfaces:

Jooby.Module

public class Flywaydb
extends Object
implements Jooby.Module

flyway module

Run database migrations on startup and exposes a Flyway instance.

usage

 flyway.url = ...
 flyway.user = ...
 flyway.password = ...
 

 {
   use(new Flywaydb());
 }
 

If for any reason you need to maintain two or more databases:

 flyway.db1.url = "..."
 flyway.db1.locations = "db1/migration"
 flyway.db2.url = "..."
 flyway.db2.locations = "db2/migration"
 

 {
   use(new Flywaydb("flyway.db1"));
   use(new Flywaydb("flyway.db2"));
 }
 

migration scripts

Flyway looks for migration scripts at the db/migration classpath location. We recommend to use Semantic versioning for naming the migration scripts:

 v0.1.0_My_description.sql
 v0.1.1_My_small_change.sql
 

commands

It is possible to run Flyway commands on startup, default command is: migrate.

If you need to run multiple commands, set the flyway.run property:

 flyway.run = [clean, migrate, validate, info]
 

configuration

Configuration is done via application.conf under the flyway.* path. There are some defaults setting that you can see in the appendix.

Since:

0.8.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Flywaydb() Creates a new Flywaydb module, using flyway as property.
Flywaydb(String name) Creates a new Flywaydb.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Flywaydb

public Flywaydb(String name)

Creates a new Flywaydb. The given name is use it to read flyway properties, keep in mind that custom configuration will inherited all the properties from flyway.*.

Parameters:

name - Name of the property with flyway properties.

Flywaydb

public Flywaydb()

Creates a new Flywaydb module, using flyway as property.

Method Detail

configure

public void configure(Env env,
                      com.typesafe.config.Config config,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

config

public com.typesafe.config.Config config()

Specified by:

config in interface Jooby.Module