com.google.code.flyway.maven.MigrateMojo Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2009-2010 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 com.google.code.flyway.maven;

import java.util.Map;

import org.apache.maven.plugin.MojoExecutionException;

import com.google.code.flyway.core.Flyway;

/**
 * Maven goal that triggers the migration of the configured database to the latest version.
 *
 * @goal migrate
 * @requiresDependencyResolution compile
 * @configurator include-project-dependencies
 */
public class MigrateMojo extends AbstractFlywayMojo {
    /**
     * The base package where the Java migrations are located. (default: db.migration)
     *
     * @parameter
     */
    private String basePackage;

    /**
     * The base directory on the classpath where the Sql migrations are located. (default: sql/location)
     *
     * @parameter
     */
    private String baseDir;

    /**
     * The name of the schema metadata table that will be used by flyway. (default: schema_version)
     *
     * @parameter
     */
    private String schemaMetaDataTable;

    /**
     * A map of  to apply to sql migration scripts.
     *
     * @parameter
     */
    private Map placeholders;

    @Override
    public void execute() throws MojoExecutionException {
        try {
            Flyway flyway = new Flyway();
            flyway.setDataSource(getDataSource());
            if (basePackage != null) {
                flyway.setBasePackage(basePackage);
            }
            if (baseDir != null) {
                flyway.setBaseDir(baseDir);
            }
            if (schemaMetaDataTable != null) {
                flyway.setSchemaMetaDataTable(schemaMetaDataTable);
            }
            if (placeholders != null) {
                flyway.setPlaceholders(placeholders);
            }

            flyway.migrate();
        } catch (Exception e) {
            throw new MojoExecutionException("Error migrating database: " + e.getMessage(), e);
        }
    }

}