org.flywaydb.core.api.resolver.MigrationResolver Maven / Gradle / Ivy
/*
* Copyright (C) Red Gate Software Ltd 2010-2024
*
* 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.resolver;
import lombok.RequiredArgsConstructor;
import org.flywaydb.core.api.ResourceProvider;
import org.flywaydb.core.api.configuration.Configuration;
import org.flywaydb.core.extensibility.MigrationType;
import org.flywaydb.core.extensibility.Plugin;
import org.flywaydb.core.internal.jdbc.StatementInterceptor;
import org.flywaydb.core.internal.sqlscript.SqlScriptExecutorFactory;
import org.flywaydb.core.internal.sqlscript.SqlScriptFactory;
import java.util.Collection;
/**
* Resolves available migrations. This interface can be implemented to create custom resolvers. A custom resolver
* can be used to create additional types of migrations not covered by the standard resolvers (jdbc, sql).
* Using the skipDefaultResolvers configuration property, the built-in resolvers can also be completely replaced.
*/
public interface MigrationResolver extends Plugin {
@RequiredArgsConstructor
class Context {
public final Configuration configuration;
public final ResourceProvider resourceProvider;
public final SqlScriptFactory sqlScriptFactory;
public final SqlScriptExecutorFactory sqlScriptExecutorFactory;
public final StatementInterceptor statementInterceptor;
}
Collection resolveMigrations(Context context);
/**
* @return The prefix this resolver looks for. {@code null} if no particular prefix is used
*/
default String getPrefix(Configuration configuration) {
return null;
}
default MigrationType getDefaultMigrationType() {
return null;
}
}