org.flywaydb.core.api.migration.jdbc.JdbcMigration Maven / Gradle / Ivy
/**
* Copyright 2010-2016 Boxfuse GmbH
*
* 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 org.flywaydb.core.api.migration.jdbc;
import java.sql.Connection;
/**
* Interface to be implemented by Jdbc Java Migrations. By default the migration version and description will be extracted
* from the class name. This can be overridden by also implementing the {@link org.flywaydb.core.api.migration.MigrationInfoProvider}
* interface, in which case it can be specified programmatically. The checksum of this migration (for validation)
* will also be null, unless the migration also implements the {@link org.flywaydb.core.api.migration.MigrationChecksumProvider},
* in which case it can be returned programmatically.
*
* When the JdbcMigration implements {@link org.flywaydb.core.api.configuration.ConfigurationAware},
* the master {@link org.flywaydb.core.api.configuration.FlywayConfiguration} is automatically injected upon creation,
* which is especially useful for getting placeholder and schema information.
*
* It is encouraged not to implement this interface directly and subclass {@link JdbcMigration} instead.
*/
public interface JdbcMigration {
/**
* Executes this migration. The execution will automatically take place within a transaction, when the underlying
* database supports it.
*
* @param connection The connection to use to execute statements.
* @throws Exception when the migration failed.
*/
void migrate(Connection connection) throws Exception;
}