ninja.migrations.flyway.MigrationEngineFlyway Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ninja-db-classic Show documentation

This provides database support (JPA + migrations) for ninja. This package exists for compatibility reasons and likely you want to use ninja-db as replacement.

There is a newer version: 7.0.0

Show newest version

/**
 * Copyright (C) the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ninja.migrations.flyway;

import com.google.inject.Provider;
import ninja.utils.NinjaConstant;
import ninja.utils.NinjaProperties;

import org.flywaydb.core.Flyway;

import com.google.inject.Inject;
import com.google.inject.Singleton;
import ninja.migrations.MigrationEngine;

@Singleton
public class MigrationEngineFlyway implements MigrationEngine {

    private final NinjaProperties ninjaProperties;
    private final Provider flywayProvider;

    @Inject
    public MigrationEngineFlyway(NinjaProperties ninjaProperties,
                                 Provider flywayProvider) {
        this.ninjaProperties = ninjaProperties;
        this.flywayProvider = flywayProvider;
    }
    
    @Override
    public void migrate() {  
        // Get the connection credentials from application.conf
        String connectionUrl = ninjaProperties.getOrDie(NinjaConstant.DB_CONNECTION_URL);
        String connectionUsername = ninjaProperties.getOrDie(NinjaConstant.DB_CONNECTION_USERNAME);
        String connectionPassword = ninjaProperties.getOrDie(NinjaConstant.DB_CONNECTION_PASSWORD);
        String locations = ninjaProperties.get(NinjaConstant.NINJA_MIGRATION_LOCATIONS);
        String schemas = ninjaProperties.get(NinjaConstant.NINJA_MIGRATION_SCHEMAS);

        // We migrate automatically => if you do not want that (eg in production)
        // set ninja.migration.run=false in application.conf
        Flyway flyway = flywayProvider.get();
        flyway.setDataSource(connectionUrl, connectionUsername, connectionPassword);

        if (locations != null) {
            flyway.setLocations(locations);
        }
        if (schemas != null) {
            flyway.setSchemas(schemas);
        }

        // In testmode we are cleaning the database so that subsequent testcases
        // get a fresh database.
        if (ninjaProperties.getBooleanWithDefault(NinjaConstant.NINJA_MIGRATION_DROP_SCHEMA,
                ninjaProperties.isTest() ? true : false )) {
            flyway.clean();
        }

        flyway.migrate();
    }

}