/*
 * Copyright (c) 2016, PostgreSQL Global Development Group
 * See the LICENSE file in the project root for more information.
 */

package org.postgresql.jdbc;

import org.postgresql.core.Field;
import org.postgresql.core.ParameterList;
import org.postgresql.core.Query;
import org.postgresql.core.ResultCursor;
import org.postgresql.core.ResultHandlerBase;
import org.postgresql.core.v3.BatchedQuery;
import org.postgresql.util.GT;
import org.postgresql.util.PSQLException;
import org.postgresql.util.PSQLState;

import java.sql.BatchUpdateException;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.SQLWarning;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

Internal class, it is not a part of public API.
/** * Internal class, it is not a part of public API. */
public class BatchResultHandler extends ResultHandlerBase { private PgStatement pgStatement; private int resultIndex = 0; private final Query[] queries; private final int[] updateCounts; private final ParameterList[] parameterLists; private final boolean expectGeneratedKeys; private PgResultSet generatedKeys; private int committedRows; // 0 means no rows committed. 1 means row 0 was committed, and so on private List<List<byte[][]>> allGeneratedRows; private List<byte[][]> latestGeneratedRows; private PgResultSet latestGeneratedKeysRs; BatchResultHandler(PgStatement pgStatement, Query[] queries, ParameterList[] parameterLists, boolean expectGeneratedKeys) { this.pgStatement = pgStatement; this.queries = queries; this.parameterLists = parameterLists; this.updateCounts = new int[queries.length]; this.expectGeneratedKeys = expectGeneratedKeys; this.allGeneratedRows = !expectGeneratedKeys ? null : new ArrayList<List<byte[][]>>(); } public void handleResultRows(Query fromQuery, Field[] fields, List<byte[][]> tuples, ResultCursor cursor) { // If SELECT, then handleCommandStatus call would just be missing resultIndex++; if (!expectGeneratedKeys) { // No rows expected -> just ignore rows return; } if (generatedKeys == null) { try { // If SELECT, the resulting ResultSet is not valid // Thus it is up to handleCommandStatus to decide if resultSet is good enough latestGeneratedKeysRs = (PgResultSet) pgStatement.createResultSet(fromQuery, fields, new ArrayList<byte[][]>(), cursor); } catch (SQLException e) { handleError(e); } } latestGeneratedRows = tuples; } public void handleCommandStatus(String status, int updateCount, long insertOID) { if (latestGeneratedRows != null) { // We have DML. Decrease resultIndex that was just increased in handleResultRows resultIndex--; // If exception thrown, no need to collect generated keys // Note: some generated keys might be secured in generatedKeys if (updateCount > 0 && (getException() == null || isAutoCommit())) { allGeneratedRows.add(latestGeneratedRows); if (generatedKeys == null) { generatedKeys = latestGeneratedKeysRs; } } latestGeneratedRows = null; } if (resultIndex >= queries.length) { handleError(new PSQLException(GT.tr("Too many update results were returned."), PSQLState.TOO_MANY_RESULTS)); return; } latestGeneratedKeysRs = null; updateCounts[resultIndex++] = updateCount; } private boolean isAutoCommit() { try { return pgStatement.getConnection().getAutoCommit(); } catch (SQLException e) { assert false : "pgStatement.getConnection().getAutoCommit() should not throw"; return false; } } @Override public void secureProgress() { if (isAutoCommit()) { committedRows = resultIndex; updateGeneratedKeys(); } } private void updateGeneratedKeys() { if (allGeneratedRows == null || allGeneratedRows.isEmpty()) { return; } for (List<byte[][]> rows : allGeneratedRows) { generatedKeys.addRows(rows); } allGeneratedRows.clear(); } public void handleWarning(SQLWarning warning) { pgStatement.addWarning(warning); } @Override public void handleError(SQLException newError) { if (getException() == null) { Arrays.fill(updateCounts, committedRows, updateCounts.length, Statement.EXECUTE_FAILED); if (allGeneratedRows != null) { allGeneratedRows.clear(); } String queryString = "<unknown>"; if (resultIndex < queries.length) { queryString = queries[resultIndex].toString(parameterLists[resultIndex]); } BatchUpdateException batchException = new BatchUpdateException( GT.tr("Batch entry {0} {1} was aborted: {2} Call getNextException to see other errors in the batch.", resultIndex, queryString, newError.getMessage()), newError.getSQLState(), uncompressUpdateCount()); batchException.initCause(newError); super.handleError(batchException); } resultIndex++; super.handleError(newError); } public void handleCompletion() throws SQLException { updateGeneratedKeys(); SQLException batchException = getException(); if (batchException != null) { if (isAutoCommit()) { // Re-create batch exception since rows after exception might indeed succeed. BatchUpdateException newException = new BatchUpdateException( batchException.getMessage(), batchException.getSQLState(), uncompressUpdateCount() ); newException.initCause(batchException.getCause()); SQLException next = batchException.getNextException(); if (next != null) { newException.setNextException(next); } batchException = newException; } throw batchException; } } public ResultSet getGeneratedKeys() { return generatedKeys; } private int[] uncompressUpdateCount() { if (!(queries[0] instanceof BatchedQuery)) { return updateCounts; } int totalRows = 0; boolean hasRewrites = false; for (Query query : queries) { int batchSize = query.getBatchSize(); totalRows += batchSize; hasRewrites |= batchSize > 1; } if (!hasRewrites) { return updateCounts; } /* In this situation there is a batch that has been rewritten. Substitute * the running total returned by the database with a status code to * indicate successful completion for each row the driver client added * to the batch. */ int[] newUpdateCounts = new int[totalRows]; int offset = 0; for (int i = 0; i < queries.length; i++) { Query query = queries[i]; int batchSize = query.getBatchSize(); int superBatchResult = updateCounts[i]; if (batchSize == 1) { newUpdateCounts[offset++] = superBatchResult; continue; } if (superBatchResult > 0) { // If some rows inserted, we do not really know how did they spread over individual // statements superBatchResult = Statement.SUCCESS_NO_INFO; } Arrays.fill(newUpdateCounts, offset, offset + batchSize, superBatchResult); offset += batchSize; } return newUpdateCounts; } public int[] getUpdateCount() { return uncompressUpdateCount(); } }