DBRawSQLTransaction.java

/*
 * Copyright 2013 Gregory Graham.
 *
 * 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 nz.co.gregs.dbvolution.transactions;

import java.sql.SQLException;
import java.sql.Statement;
import nz.co.gregs.dbvolution.databases.DBDatabase;
import nz.co.gregs.dbvolution.databases.DBStatement;
import nz.co.gregs.dbvolution.exceptions.ExceptionThrownDuringTransaction;

/**
 * Performs transactions for arbitrary SQL strings.
 *
 * <p style="color: #F90;">Support DBvolution at
 * <a href="http://patreon.com/dbvolution" target=new>Patreon</a></p>
 *
 * @author Gregory Graham
 */
public class DBRawSQLTransaction implements DBTransaction<Boolean> {

	private final String sql;

	/**
	 * Create a DBRawSQLTransaction object for the SQL provided.
	 *
	 * @param rawSQL rawSQL
	 */
	public DBRawSQLTransaction(String rawSQL) {
		this.sql = rawSQL;
	}

	/**
	 * Perform the SQL on the database within a transaction.
	 *
	 * @param dbDatabase dbDatabase
	 * <p style="color: #F90;">Support DBvolution at
	 * <a href="http://patreon.com/dbvolution" target=new>Patreon</a></p>
	 * @return TRUE if the transaction succeeded, FALSE otherwise.
	 *
	 */
	@Override
	public Boolean doTransaction(DBDatabase dbDatabase) throws ExceptionThrownDuringTransaction {
		try (DBStatement dbStatement = dbDatabase.getDBStatement()) {
			dbDatabase.printSQLIfRequested(sql);
			dbStatement.addBatch(sql);
			int[] executeBatchResults = dbStatement.executeBatch();
			for (int result : executeBatchResults) {
				if (result == Statement.EXECUTE_FAILED) {
					return Boolean.FALSE;
				}
			}
		} catch (SQLException ex) {
			throw new ExceptionThrownDuringTransaction(ex);
		}
		return Boolean.TRUE;
	}

}