org.apache.metamodel.jdbc.JdbcUpdateCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of MetaModel-jdbc Show documentation
The newest version!
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.metamodel.jdbc;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.sql.Statement;

import org.apache.metamodel.AbstractUpdateCallback;
import org.apache.metamodel.DataContext;
import org.apache.metamodel.UpdateCallback;
import org.apache.metamodel.UpdateSummary;
import org.apache.metamodel.UpdateSummaryBuilder;
import org.apache.metamodel.create.TableCreationBuilder;
import org.apache.metamodel.delete.RowDeletionBuilder;
import org.apache.metamodel.drop.TableDropBuilder;
import org.apache.metamodel.insert.RowInsertionBuilder;
import org.apache.metamodel.jdbc.JdbcUtils.JdbcActionType;
import org.apache.metamodel.schema.Schema;
import org.apache.metamodel.schema.Table;
import org.apache.metamodel.update.RowUpdationBuilder;
import org.apache.metamodel.util.FileHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

abstract class JdbcUpdateCallback extends AbstractUpdateCallback implements UpdateCallback {

    private static final Logger logger = LoggerFactory.getLogger(JdbcUpdateCallback.class);

    private Connection _connection;
    private String _preparedStatementSql;
    private PreparedStatement _preparedStatement;
    private final UpdateSummaryBuilder _updateSummaryBuilder;

    public JdbcUpdateCallback(JdbcDataContext dataContext) {
        super(dataContext);
        _updateSummaryBuilder = new UpdateSummaryBuilder();
    }

    protected final UpdateSummaryBuilder getUpdateSummaryBuilder() {
        return _updateSummaryBuilder;
    }
    
    protected abstract boolean isGeneratedKeysCollectionEnabled();

    protected abstract void closePreparedStatement(PreparedStatement preparedStatement);

    protected abstract int executePreparedStatement(PreparedStatement preparedStatement) throws SQLException;

    public int executePreparedStatement(PreparedStatement preparedStatement, boolean reusedStatement,
            boolean collectGeneratedKeys) throws SQLException {
        final int result = executePreparedStatement(preparedStatement);

        if (collectGeneratedKeys && isGeneratedKeysCollectionEnabled()) {
            try {
                final ResultSet generatedKeysResultSet = preparedStatement.getGeneratedKeys();
                try {
                    while (generatedKeysResultSet.next()) {
                        final Object key = generatedKeysResultSet.getObject(1);
                        getUpdateSummaryBuilder().addGeneratedKey(key);
                    }
                } finally {
                    FileHelper.safeClose(generatedKeysResultSet);
                }
            } catch (SQLFeatureNotSupportedException e) {
                // ignore
                logger.debug("Getting generated keys from JDBC statement is not supported by driver: {}", e
                        .getMessage(), e);
            } catch (SQLException | RuntimeException e) {
                logger.warn("Failed to get generated keys from JDBC statement: {}", e.getMessage(), e);
            }
        }

        if (!reusedStatement) {
            closePreparedStatement(preparedStatement);
        }
        return result;
    }

    protected final Connection getConnection() {
        if (_connection == null) {
            _connection = getJdbcDataContext().getConnection();
            if (getJdbcDataContext().getQueryRewriter().isTransactional()) {
                try {
                    _connection.setAutoCommit(false);
                } catch (SQLException e) {
                    throw JdbcUtils.wrapException(e, "disable auto-commit", JdbcActionType.OTHER);
                }
            }
        }
        return _connection;
    }

    public final void close(boolean success) {
        if (_connection != null) {
            if (success && _preparedStatement != null) {
                closePreparedStatement(_preparedStatement);
            }

            if (getJdbcDataContext().getQueryRewriter().isTransactional()) {
                try {
                    commitOrRollback(success);

                    if (getJdbcDataContext().isDefaultAutoCommit()) {
                        try {
                            getConnection().setAutoCommit(true);
                        } catch (SQLException e) {
                            throw JdbcUtils.wrapException(e, "enable auto-commit", JdbcActionType.OTHER);
                        }
                    }
                } finally {
                    getJdbcDataContext().close(_connection);
                }
            }
        }
    }

    private void commitOrRollback(boolean success) {
        if (success) {
            try {
                getConnection().commit();
            } catch (SQLException e) {
                throw JdbcUtils.wrapException(e, "commit transaction", JdbcActionType.COMMIT_ROLLBACK);
            }
        } else {
            try {
                getConnection().rollback();
            } catch (SQLException e) {
                throw JdbcUtils.wrapException(e, "rollback transaction", JdbcActionType.COMMIT_ROLLBACK);
            }
        }
    }

    @Override
    public final TableCreationBuilder createTable(Schema schema, String name) throws IllegalArgumentException,
            IllegalStateException {
        return new JdbcCreateTableBuilder(this, schema, name);
    }

    @Override
    public final RowInsertionBuilder insertInto(Table table) throws IllegalArgumentException, IllegalStateException {
        return new JdbcInsertBuilder(this, table, getJdbcDataContext().getQueryRewriter());
    }
    
    protected final JdbcDataContext getJdbcDataContext() {
        return (JdbcDataContext) super.getDataContext();
    }

    // override the return type to the more specific subtype.
    @Override
    public final DataContext getDataContext() {
        final Connection connection = getConnection();
        return new JdbcUpdateCallbackDataContext(getJdbcDataContext(), connection);
    }

    protected String quoteIfNescesary(String identifier) {
        if (identifier == null) {
            return null;
        }
        final String quote = getJdbcDataContext().getIdentifierQuoteString();
        if (quote == null) {
            return identifier;
        }
        boolean quotes = false;
        if (identifier.indexOf(' ') != -1 || identifier.indexOf('-') != -1) {
            quotes = true;
        } else {
            if (SqlKeywords.isKeyword(identifier)) {
                quotes = true;
            }
        }

        if (quotes) {
            identifier = quote + identifier + quote;
        }
        return identifier;
    }

    public final PreparedStatement getPreparedStatement(String sql, boolean reuseStatement,
            boolean returnGeneratedKeys) {
        final PreparedStatement preparedStatement;
        if (reuseStatement) {
            if (sql.equals(_preparedStatementSql)) {
                preparedStatement = _preparedStatement;
            } else {
                if (_preparedStatement != null) {
                    try {
                        closePreparedStatement(_preparedStatement);
                    } catch (RuntimeException e) {
                        logger.error("Exception occurred while closing prepared statement: " + _preparedStatementSql);
                        throw e;
                    }
                }
                preparedStatement = createPreparedStatement(sql, returnGeneratedKeys);
                _preparedStatement = preparedStatement;
                _preparedStatementSql = sql;
            }
        } else {
            preparedStatement = createPreparedStatement(sql, returnGeneratedKeys);
        }
        return preparedStatement;
    }
    
    private final PreparedStatement createPreparedStatement(String sql, boolean returnGeneratedKeys) {
        try {
            if (returnGeneratedKeys && isGeneratedKeysCollectionEnabled()) {
                return getConnection().prepareStatement(sql, Statement.RETURN_GENERATED_KEYS);
            }
            return getConnection().prepareStatement(sql);
        } catch (SQLException e) {
            if (returnGeneratedKeys) {
                // not all databases support the RETURN_GENERATED_KEYS flag, so retry without
                return createPreparedStatement(sql, false);
            }
            throw JdbcUtils.wrapException(e, "create prepared statement for: " + sql, JdbcActionType.OTHER);
        }
    }

    @Override
    public boolean isDeleteSupported() {
        return true;
    }

    @Override
    public final RowDeletionBuilder deleteFrom(Table table) throws IllegalArgumentException, IllegalStateException,
            UnsupportedOperationException {
        return new JdbcDeleteBuilder(this, table, getJdbcDataContext().getQueryRewriter());
    }

    @Override
    public boolean isDropTableSupported() {
        return true;
    }

    @Override
    public TableDropBuilder dropTable(Table table) throws IllegalArgumentException, IllegalStateException,
            UnsupportedOperationException {
        return new JdbcDropTableBuilder(this, table, getJdbcDataContext().getQueryRewriter());
    }

    @Override
    public boolean isUpdateSupported() {
        return true;
    }

    @Override
    public final RowUpdationBuilder update(Table table) throws IllegalArgumentException, IllegalStateException,
            UnsupportedOperationException {
        return new JdbcUpdateBuilder(this, table, getJdbcDataContext().getQueryRewriter());
    }

    public void executeInsert(PreparedStatement st, boolean reuseStatement) throws SQLException {
        executePreparedStatement(st, reuseStatement, true);
        _updateSummaryBuilder.addInsert();
    }

    public void executeUpdate(PreparedStatement st, boolean reuseStatement) throws SQLException {
        final int updates = executePreparedStatement(st, reuseStatement, false);
        _updateSummaryBuilder.addUpdates(updates);
    }

    public void executeDelete(PreparedStatement st, boolean reuseStatement) throws SQLException {
        final int deletes = executePreparedStatement(st, reuseStatement, false);
        _updateSummaryBuilder.addDeletes(deletes);
    }

    @Override
    public UpdateSummary getUpdateSummary() {
        return _updateSummaryBuilder.build();
    }

}