DBAlterTableAddColumnIfNeeded.java

/*
 * Copyright 2023 Gregory Graham.
 *
 * Commercial licenses are available, please contact info@gregs.co.nz for details.
 * 
 * This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. 
 * To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/ 
 * or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
 * 
 * You are free to:
 *     Share - copy and redistribute the material in any medium or format
 *     Adapt - remix, transform, and build upon the material
 * 
 *     The licensor cannot revoke these freedoms as long as you follow the license terms.               
 *     Under the following terms:
 *                 
 *         Attribution - 
 *             You must give appropriate credit, provide a link to the license, and indicate if changes were made. 
 *             You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
 *         NonCommercial - 
 *             You may not use the material for commercial purposes.
 *         ShareAlike - 
 *             If you remix, transform, or build upon the material, 
 *             you must distribute your contributions under the same license as the original.
 *         No additional restrictions - 
 *             You may not apply legal terms or technological measures that legally restrict others from doing anything the 
 *             license permits.
 * 
 * Check the Creative Commons website for any details, legalese, and updates.
 */
package nz.co.gregs.dbvolution.actions;

import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import nz.co.gregs.dbvolution.DBRow;
import nz.co.gregs.dbvolution.databases.DBDatabase;
import nz.co.gregs.dbvolution.databases.QueryIntention;
import nz.co.gregs.dbvolution.exceptions.AccidentalBlankQueryException;
import nz.co.gregs.dbvolution.exceptions.UnableToInstantiateDBRowSubclassException;
import nz.co.gregs.dbvolution.internal.properties.PropertyWrapper;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 *
 * @author gregorygraham
 */
public class DBAlterTableAddColumnIfNeeded extends DBAction {

	private static final long serialVersionUID = 1L;
	private static final Log LOG = LogFactory.getLog(DBDropTable.class);

	private final DBRow existingTable;
	private final PropertyWrapper<?, ?, ?> columnPropertyWrapper;

	public <R extends DBRow> DBAlterTableAddColumnIfNeeded(DBRow existingTable, PropertyWrapper<?, ?, ?> columnPropertyWrapper) {
		super(existingTable, QueryIntention.ALTER_TABLE_ADD_COLUMN);
		this.existingTable = existingTable;
		this.columnPropertyWrapper = columnPropertyWrapper;
	}

	@Override
	protected DBActionList getRevertDBActionList() {
		DBActionList reverts = new DBActionList();
		return reverts;
	}

	@Override
	public List<String> getSQLStatements(DBDatabase db) {
		List<String> result = new ArrayList<>(1);

		String sqlString = db.getDefinition().getAlterTableAddColumnSQL(existingTable, columnPropertyWrapper);
		result.add(sqlString);

		return result;
	}

	@Override
	public DBActionList execute(DBDatabase db) throws SQLException {
		return execute2(db);
	}

	@Override
	public DBActionList execute2(DBDatabase db) throws SQLException {
		DBActionList actions = prepareActionList(db);
		prepareRollbackData(db, actions);
		try {
			executeOnStatement(db);
		} catch (Exception exc) {
			if (!db.getDefinition().isDuplicateColumnException(exc)) {
				throw exc;
			}
		}
		return actions;
	}

	@Override
	protected DBActionList prepareActionList(DBDatabase db) throws AccidentalBlankQueryException, SQLException, UnableToInstantiateDBRowSubclassException {
		final DBAlterTableAddColumnIfNeeded newAction = new DBAlterTableAddColumnIfNeeded(existingTable, columnPropertyWrapper);
		DBActionList actions = new DBActionList(newAction);
		return actions;
	}

	@Override
	protected void prepareRollbackData(DBDatabase db, DBActionList actions) {
		// with any real database attempting this is absurd
	}
}