How to run flyway:clean before migrations in a SpringBoot app?

Question

I am using Springboot and Flyway. The migrations work just fine but I wanted to be able perform a clean flyway command when the application context gets loaded with test profile.

Is it possible to configure SpringBoot to do clean and then migrate if active profile is test?

score 42 · Accepted Answer · edited Nov 27 '17 at 00:30

You can overwrite the Flyway autoconfiguration like this:

@Bean
@Profile("test")
public Flyway flyway(DataSource theDataSource) {
    Flyway flyway = new Flyway();
    flyway.setDataSource(theDataSource);
    flyway.setLocations("classpath:db/migration");
    flyway.clean();
    flyway.migrate();

    return flyway;
}

In Spring Boot 1.3 (current version is 1.3.0.M1, GA release is planned for September), you can use a FlywayMigrationStrategy bean to define the actions you want to run:

@Bean
@Profile("test")
public FlywayMigrationStrategy cleanMigrateStrategy() {
    FlywayMigrationStrategy strategy = new FlywayMigrationStrategy() {
        @Override
        public void migrate(Flyway flyway) {
            flyway.clean();
            flyway.migrate();
        }
    };

    return strategy;
}

Your solution works but is there a way to avoid this behavior if the server reboots only to hot-swapping? During development it's not necessary, in fact it's rather annoying, to drop the entire data base. Is there a solution for this? — Stefan Falk, May 11 '18 at 22:48

score 9 · Answer 2 · answered Jul 19 '18 at 23:33

9

in more recent versions of spring boot (eg 2.0.2) you can use the property spring.flyway.clean-on-validation-error if you want to use clean because of a change in the sql files

answered Jul 19 '18 at 23:33

stelios.anastasakis

950
9
11

score 1 · Answer 3 · answered Aug 03 '22 at 19:02

1

Same answer as @dunni (Thanks, by the way!), but updated to modern Java 8+

@Profile("test")
@Bean
public FlywayMigrationStrategy flywayCleanMigrationStrategy() {
  return flyway -> {
    flyway.clean();
    flyway.migrate();
  };
}

answered Aug 03 '22 at 19:02

t0r0X

4,212
1
38
34

spyro · Answer 4 · 2022-10-23T12:59:28.663

1

... and here's the Kotlin version, if needed :)

@Profile("test")
@Configuration
class FlywayMigrationConfig {
    @Bean
    fun flywayCleanMigrationStrategy() = FlywayMigrationStrategy {
        it.clean()
        it.migrate()
    }
}

edited Oct 23 '22 at 12:59

answered Oct 23 '22 at 12:46

spyro

475
4
10

How to run flyway:clean before migrations in a SpringBoot app?

4 Answers4

Linked