https://flywaydb.org/flyway-core: Flyway: Database Migrations Made Easy.
  • Axel Fontaine 
/*
 * Copyright 2010-2020 Redgate Software Ltd
 *
 * 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.executor;

import java.sql.SQLException;


Executes a migration.

/**
 * Executes a migration.
 */
public interface MigrationExecutor {
    
Executes the migration this executor is associated with.

Params:
  • context – The context to use to execute the migration against the DB.
Throws:
/**
     * Executes the migration this executor is associated with.
     *
     * @param context The context to use to execute the migration against the DB.
     * @throws SQLException when the execution of a statement failed.
     */
    void execute(Context context) throws SQLException;

    
Whether the execution can take place inside a transaction. Almost all implementation should return true. This however makes it possible to execute certain migrations outside a transaction. This is useful for databases like PostgreSQL and SQL Server where certain statement can only execute outside a transaction. 
Returns:true if a transaction should be used (highly recommended), or false if not.
/**
     * Whether the execution can take place inside a transaction. Almost all implementation should return {@code true}.
     * This however makes it possible to execute certain migrations outside a transaction. This is useful for databases
     * like PostgreSQL and SQL Server where certain statement can only execute outside a transaction.
     *
     * @return {@code true} if a transaction should be used (highly recommended), or {@code false} if not.
     */
    boolean canExecuteInTransaction();
}