org.mariadb.jdbc.internal.protocol.AbstractMultiSend Maven / Gradle / Ivy
/*
MariaDB Client for Java
Copyright (c) 2012-2014 Monty Program Ab.
Copyright (c) 2015-2016 MariaDB Ab.
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option)
any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
for more details.
You should have received a copy of the GNU Lesser General Public License along
with this library; if not, write to Monty Program Ab [email protected].
This particular MariaDB Client for Java file is work
derived from a Drizzle-JDBC. Drizzle-JDBC file which is covered by subject to
the following copyright and notice provisions:
Copyright (c) 2009-2011, Marcus Eriksson
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
Neither the name of the driver nor the names of its contributors may not be
used to endorse or promote products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
*/
package org.mariadb.jdbc.internal.protocol;
import org.mariadb.jdbc.internal.MariaDbType;
import org.mariadb.jdbc.internal.packet.ComStmtPrepare;
import org.mariadb.jdbc.internal.packet.dao.parameters.ParameterHolder;
import org.mariadb.jdbc.internal.queryresults.ExecutionResult;
import org.mariadb.jdbc.internal.stream.MaxAllowedPacketException;
import org.mariadb.jdbc.internal.stream.PacketOutputStream;
import org.mariadb.jdbc.internal.util.BulkStatus;
import org.mariadb.jdbc.internal.util.dao.ClientPrepareResult;
import org.mariadb.jdbc.internal.util.dao.PrepareResult;
import org.mariadb.jdbc.internal.util.dao.QueryException;
import org.mariadb.jdbc.internal.util.dao.ServerPrepareResult;
import org.mariadb.jdbc.internal.util.scheduler.SchedulerServiceProviderHolder;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.FutureTask;
import java.util.concurrent.ThreadPoolExecutor;
import static org.mariadb.jdbc.internal.util.ExceptionMapper.SqlStates.CONNECTION_EXCEPTION;
import static org.mariadb.jdbc.internal.util.ExceptionMapper.SqlStates.INTERRUPTED_EXCEPTION;
public abstract class AbstractMultiSend {
private static final ThreadPoolExecutor readScheduler = SchedulerServiceProviderHolder.getBulkScheduler();
private Protocol protocol;
private PacketOutputStream writer;
private ExecutionResult executionResult;
private List parametersList;
private PrepareResult prepareResult;
private int resultSetScrollType;
private List queries;
private boolean binaryProtocol;
private boolean readPrepareStmtResult;
private String sql;
int statementId = -1;
MariaDbType[] parameterTypeHeader;
/**
* Bulk execute for Server PreparedStatement.executeBatch (when no COM_MULTI)
*
* @param protocol protocol
* @param writer outputStream
* @param executionResult query results
* @param serverPrepareResult Prepare result
* @param parametersList parameters
* @param resultSetScrollType resultSet scroll type
* @param readPrepareStmtResult must execute prepare result
* @param sql sql query.
*/
public AbstractMultiSend(Protocol protocol, PacketOutputStream writer, ExecutionResult executionResult, ServerPrepareResult serverPrepareResult,
List parametersList, int resultSetScrollType, boolean readPrepareStmtResult, String sql) {
this.protocol = protocol;
this.writer = writer;
this.executionResult = executionResult;
this.prepareResult = serverPrepareResult;
this.parametersList = parametersList;
this.resultSetScrollType = resultSetScrollType;
this.binaryProtocol = true;
this.readPrepareStmtResult = readPrepareStmtResult;
this.sql = sql;
}
/**
* Bulk execute for client-sier PreparedStatement.executeBatch (no prepare).
*
* @param protocol current protocol
* @param writer outputStream
* @param executionResult results
* @param clientPrepareResult clientPrepareResult
* @param parametersList parameters
* @param resultSetScrollType resultSet scroll type
*/
public AbstractMultiSend(Protocol protocol, PacketOutputStream writer, ExecutionResult executionResult,
final ClientPrepareResult clientPrepareResult, List parametersList, int resultSetScrollType) {
this.protocol = protocol;
this.writer = writer;
this.executionResult = executionResult;
this.prepareResult = clientPrepareResult;
this.parametersList = parametersList;
this.resultSetScrollType = resultSetScrollType;
this.binaryProtocol = false;
this.readPrepareStmtResult = false;
}
/**
* Bulk execute for statement.executeBatch().
*
* @param protocol protocol
* @param writer outputStream
* @param executionResult results
* @param queries query list
* @param resultSetScrollType resultset type
*/
public AbstractMultiSend(Protocol protocol, PacketOutputStream writer, ExecutionResult executionResult, List queries,
int resultSetScrollType) {
this.protocol = protocol;
this.writer = writer;
this.executionResult = executionResult;
this.queries = queries;
this.resultSetScrollType = resultSetScrollType;
this.binaryProtocol = false;
this.readPrepareStmtResult = false;
}
public abstract void sendCmd(PacketOutputStream writer, ExecutionResult executionResult,
List parametersList, List queries, int paramCount, BulkStatus status,
PrepareResult prepareResult) throws QueryException, IOException;
public abstract QueryException handleResultException(QueryException qex, ExecutionResult executionResult,
List parametersList, List queries, int currentCounter,
int sendCmdCounter, int paramCount, PrepareResult prepareResult)
throws QueryException;
public abstract int getParamCount();
public abstract int getTotalExecutionNumber();
public PrepareResult getPrepareResult() {
return prepareResult;
}
/**
* Execute Bulk execution (send packets by batch of useBatchMultiSendNumber or when max packet is reached) before reading results.
*
* @param handleMinusOnePrepare can use '-1' for last prepareStatementId
* @return prepare result
* @throws QueryException if any error occur
*/
public PrepareResult executeBatch(boolean handleMinusOnePrepare) throws QueryException {
int paramCount = getParamCount();
int totalExecutionNumber = getTotalExecutionNumber();
QueryException exception = null;
BulkStatus status = new BulkStatus();
//Handle prepare if needed
if (binaryProtocol) {
if (readPrepareStmtResult) {
parameterTypeHeader = new MariaDbType[paramCount];
if (prepareResult == null) {
if (protocol.getOptions().cachePrepStmts) {
String key = new StringBuilder(protocol.getDatabase()).append("-").append(sql).toString();
prepareResult = protocol.prepareStatementCache().get(key);
if (prepareResult != null && !((ServerPrepareResult) prepareResult).incrementShareCounter()) {
//in cache but been de-allocated
prepareResult = null;
}
}
}
statementId = (prepareResult == null) ? -1 : ((ServerPrepareResult) prepareResult).getStatementId();
} else if (prepareResult != null) {
statementId = ((ServerPrepareResult) prepareResult).getStatementId();
}
}
ComStmtPrepare comStmtPrepare = null;
FutureTask futureReadTask = null;
int requestNumberByBulk;
try {
do {
status.sendSubCmdCounter = 0;
requestNumberByBulk = Math.min(totalExecutionNumber - status.sendCmdCounter, protocol.getOptions().useBatchMultiSendNumber);
protocol.changeSocketTcpNoDelay(false); //enable NAGLE algorithm temporary.
//add prepare sub-command
if (readPrepareStmtResult && prepareResult == null) {
comStmtPrepare = new ComStmtPrepare(protocol, sql);
comStmtPrepare.send(writer);
if (!handleMinusOnePrepare) {
//read prepare result
try {
prepareResult = comStmtPrepare.read(protocol.getPacketFetcher());
statementId = ((ServerPrepareResult) prepareResult).getStatementId();
paramCount = getParamCount();
} catch (QueryException queryException) {
throw queryException;
}
} else {
futureReadTask = new FutureTask<>(new AsyncMultiRead(comStmtPrepare, requestNumberByBulk, status.sendCmdCounter,
protocol, readPrepareStmtResult && prepareResult == null, this, paramCount,
resultSetScrollType, binaryProtocol, executionResult, parametersList, queries, prepareResult));
readScheduler.execute(futureReadTask);
}
}
for (; status.sendSubCmdCounter < requestNumberByBulk;) {
sendCmd(writer, executionResult, parametersList, queries, paramCount, status, prepareResult);
status.sendSubCmdCounter++;
status.sendCmdCounter++;
writer.finishPacketWithoutRelease();
if (futureReadTask == null) {
futureReadTask = new FutureTask<>(new AsyncMultiRead(comStmtPrepare, requestNumberByBulk, (status.sendCmdCounter - 1),
protocol, false, this, paramCount,
resultSetScrollType, binaryProtocol, executionResult, parametersList, queries, prepareResult));
readScheduler.execute(futureReadTask);
}
}
protocol.changeSocketTcpNoDelay(protocol.getOptions().tcpNoDelay);
try {
AsyncMultiReadResult asyncMultiReadResult = futureReadTask.get();
if (binaryProtocol && prepareResult == null && asyncMultiReadResult.getPrepareResult() != null) {
prepareResult = asyncMultiReadResult.getPrepareResult();
statementId = ((ServerPrepareResult) prepareResult).getStatementId();
paramCount = prepareResult.getParamCount();
}
if (asyncMultiReadResult.getException() != null) {
if (((readPrepareStmtResult && prepareResult == null) || !protocol.getOptions().continueBatchOnError)) {
throw asyncMultiReadResult.getException();
} else {
exception = asyncMultiReadResult.getException();
}
}
} catch (ExecutionException executionException) {
if (executionException.getCause() == null) {
throw new QueryException("Error reading results " + executionException.getMessage());
}
throw new QueryException("Error reading results " + executionException.getCause().getMessage());
} catch (InterruptedException interruptedException) {
} finally {
//bulk can prepare, and so if prepare cache is enable, can replace an already cached prepareStatement
//this permit to release those old prepared statement without conflict.
protocol.forceReleaseWaitingPrepareStatement();
}
futureReadTask = null;
} while (status.sendCmdCounter < totalExecutionNumber);
if (exception != null) throw exception;
return prepareResult;
} catch (MaxAllowedPacketException e) {
if (e.isMustReconnect()) protocol.connect();
throw new QueryException("Could not send query: " + e.getMessage(), -1, INTERRUPTED_EXCEPTION.getSqlState(), e);
} catch (IOException e) {
throw new QueryException("Could not send query: " + e.getMessage(), -1, CONNECTION_EXCEPTION.getSqlState(), e);
} finally {
writer.releaseBufferIfNotLogging();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy