/*
* 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.internal.sqlscript;
import org.flywaydb.core.internal.resource.LoadableResource;
import java.util.Collection;
SQL script containing a series of statements terminated by a delimiter (eg: ;).
Single-line (--) and multi-line (/* * /) comments are stripped and ignored.
/**
* SQL script containing a series of statements terminated by a delimiter (eg: ;).
* Single-line (--) and multi-line (/* * /) comments are stripped and ignored.
*/
public interface SqlScript extends Comparable<SqlScript> {
Returns: The sql statements contained in this script.
/**
* @return The sql statements contained in this script.
*/
SqlStatementIterator getSqlStatements();
Returns: The number of sql statements contained in this script.
/**
* @return The number of sql statements contained in this script.
*/
int getSqlStatementCount();
Returns: The resource containing the statements.
/**
* @return The resource containing the statements.
*/
LoadableResource getResource();
Whether the execution should take place inside a transaction. This is useful for databases
like PostgreSQL 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 should take place inside a transaction. This is useful for databases
* like PostgreSQL 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 executeInTransaction();
Validates this SQL script.
/**
* Validates this SQL script.
*/
void validate();
}