org.mariadb.jdbc.MariaDbClientPreparedStatement Maven / Gradle / Ivy
package org.mariadb.jdbc;
/*
MariaDB Client for Java
Copyright (c) 2012-2014 Monty Program 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, Trond Norbye, Stephane Giron
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.
*/
import org.mariadb.jdbc.internal.logging.Logger;
import org.mariadb.jdbc.internal.logging.LoggerFactory;
import org.mariadb.jdbc.internal.packet.dao.parameters.ParameterHolder;
import org.mariadb.jdbc.internal.queryresults.*;
import org.mariadb.jdbc.internal.queryresults.resultset.MariaSelectResultSet;
import org.mariadb.jdbc.internal.util.ExceptionMapper;
import org.mariadb.jdbc.internal.util.Utils;
import org.mariadb.jdbc.internal.util.dao.ClientPrepareResult;
import org.mariadb.jdbc.internal.util.dao.QueryException;
import java.sql.*;
import java.util.*;
public class MariaDbClientPreparedStatement extends AbstractMariaDbPrepareStatement implements Cloneable {
private static Logger logger = LoggerFactory.getLogger(MariaDbClientPreparedStatement.class);
private String sqlQuery;
private ClientPrepareResult prepareResult;
private ParameterHolder[] parameters;
private List parameterList = new ArrayList<>();
private ResultSetMetaData resultSetMetaData = null;
private ParameterMetaData parameterMetaData = null;
/**
* Constructor.
* @param connection connection
* @param sql sql query
* @param resultSetScrollType one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY,
* ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
* @throws SQLException exception
*/
public MariaDbClientPreparedStatement(MariaDbConnection connection, String sql, int resultSetScrollType) throws SQLException {
super(connection, resultSetScrollType);
this.sqlQuery = sql;
useFractionalSeconds = options.useFractionalSeconds;
if (options.cachePrepStmts) {
String key = new StringBuilder(this.protocol.getDatabase()).append("-").append(sqlQuery).toString();
prepareResult = connection.getClientPrepareStatementCache().get(key);
}
if (prepareResult == null) {
if (options.rewriteBatchedStatements) {
prepareResult = ClientPrepareResult.createRewritableParts(sqlQuery, connection.noBackslashEscapes);
} else {
prepareResult = ClientPrepareResult.createParameterParts(sqlQuery, connection.noBackslashEscapes);
}
if (options.cachePrepStmts && sql.length() < 1024) {
String key = new StringBuilder(this.protocol.getDatabase()).append("-").append(sqlQuery).toString();
connection.getClientPrepareStatementCache().put(key, prepareResult);
}
}
parameters = new ParameterHolder[prepareResult.getParamCount()];
}
/**
* Clone statement.
*
* @return Clone statement.
* @throws CloneNotSupportedException if any error occur.
*/
public MariaDbClientPreparedStatement clone() throws CloneNotSupportedException {
MariaDbClientPreparedStatement clone = (MariaDbClientPreparedStatement) super.clone();
clone.sqlQuery = sqlQuery;
clone.prepareResult = prepareResult;
clone.parameters = new ParameterHolder[prepareResult.getParamCount()];
clone.resultSetMetaData = resultSetMetaData;
clone.parameterMetaData = parameterMetaData;
return clone;
}
@Override
protected boolean isNoBackslashEscapes() {
return connection.noBackslashEscapes;
}
@Override
protected boolean useFractionalSeconds() {
return useFractionalSeconds;
}
@Override
protected Calendar cal() {
return protocol.getCalendar();
}
/**
* Executes the SQL statement in this PreparedStatement object,
* which may be any kind of SQL statement.
* Some prepared statements return multiple results; the execute
* method handles these complex statements as well as the simpler
* form of statements handled by the methods executeQuery
* and executeUpdate.
*
* The execute method returns a boolean to
* indicate the form of the first result. You must call either the method
* getResultSet or getUpdateCount
* to retrieve the result; you must call getInternalMoreResults to
* move to any subsequent result(s).
*
* @return true if the first result is a ResultSet
* object; false if the first result is an update
* count or there is no result
* @throws SQLException if a database access error occurs;
* this method is called on a closed PreparedStatement
* or an argument is supplied to this method
* @see Statement#execute
* @see Statement#getResultSet
* @see Statement#getUpdateCount
* @see Statement#getMoreResults
*/
public boolean execute() throws SQLException {
return executeInternal();
}
/**
* Executes the SQL query in this PreparedStatement object
* and returns the ResultSet object generated by the query.
*
* @return a ResultSet object that contains the data produced by the
* query; never null
* @throws SQLException if a database access error occurs;
* this method is called on a closed PreparedStatement or the SQL
* statement does not return a ResultSet object
*/
public ResultSet executeQuery() throws SQLException {
if (executeInternal()) {
return executionResult.getResultSet();
}
return MariaSelectResultSet.EMPTY;
}
/**
* Executes the SQL statement in this PreparedStatement object, which must be an SQL Data Manipulation
* Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL
* statement that returns nothing, such as a DDL statement.
*
* @return either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements
* that return nothing
* @throws SQLException if a database access error occurs; this method is called on a closed
* PreparedStatement or the SQL statement returns a
* ResultSet object
*/
public int executeUpdate() throws SQLException {
if (executeInternal()) {
return 0;
}
return getUpdateCount();
}
protected boolean executeInternal() throws SQLException {
executing = true;
QueryException exception = null;
//valid parameters
for (int i = 0; i < prepareResult.getParamCount(); i++) {
if (parameters[i] == null) {
logger.error("You need to set exactly " + prepareResult.getParamCount()
+ " parameters on the prepared statement");
throw ExceptionMapper.getSqlException("You need to set exactly " + prepareResult.getParamCount()
+ " parameters on the prepared statement");
}
}
lock.lock();
try {
executeQueryProlog();
batchResultSet = null;
ExecutionResult executionResultTmp;
if (options.allowMultiQueries || options.rewriteBatchedStatements) {
//permit multi query in one execution
executionResultTmp = new MultiVariableIntExecutionResult(this, getFetchSize(), 0, true);
} else {
executionResultTmp = new SingleExecutionResult(this, getFetchSize(), true, false, true);
}
protocol.executeQuery(protocol.isMasterConnection(), executionResultTmp, prepareResult,
parameters, resultSetScrollType);
executionResult = executionResultTmp;
return executionResult.getResultSet() != null;
} catch (QueryException e) {
exception = e;
return false;
} finally {
lock.unlock();
executeQueryEpilog(exception);
executing = false;
}
}
/**
* Adds a set of parameters to this PreparedStatement object's batch of send.
*
*
*
* @throws SQLException if a database access error occurs or this method is called on a closed
* PreparedStatement
* @see Statement#addBatch
* @since 1.2
*/
public void addBatch() throws SQLException {
ParameterHolder[] holder = new ParameterHolder[prepareResult.getParamCount()];
for (int i = 0; i < holder.length; i++) {
holder[i] = parameters[i];
if (holder[i] == null) {
logger.error("You need to set exactly " + prepareResult.getParamCount()
+ " parameters on the prepared statement");
throw ExceptionMapper.getSqlException("You need to set exactly " + prepareResult.getParamCount()
+ " parameters on the prepared statement");
}
}
parameterList.add(holder);
}
/**
* Add batch.
* @param sql typically this is a SQL INSERT or UPDATE statement
* @throws SQLException every time since that method is forbidden on prepareStatement
*/
@Override
public void addBatch(final String sql) throws SQLException {
throw new SQLException("Cannot do addBatch(String) on preparedStatement");
}
/**
* Clear batch.
*/
@Override
public void clearBatch() {
parameterList.clear();
this.parameters = new ParameterHolder[prepareResult.getParamCount()];
}
/**
* {inheritdoc}.
*/
public int[] executeBatch() throws SQLException {
checkClose();
int size = parameterList.size();
if (size == 0) return new int[0];
int[] affectedRows = null;
MultiExecutionResult internalExecutionResult;
if (options.allowMultiQueries || options.rewriteBatchedStatements) {
//permit multi query in one execution
internalExecutionResult = new MultiVariableIntExecutionResult(this, size, 0, false);
} else {
internalExecutionResult = new MultiFixedIntExecutionResult(this, size, 0, false);
}
lock.lock();
try {
QueryException exception = null;
executeQueryProlog();
try {
affectedRows = executeInternalBatch(internalExecutionResult, size);
} catch (QueryException e) {
internalExecutionResult.fixStatsError(size);
if (options.rewriteBatchedStatements) {
if (prepareResult.isQueryMultiValuesRewritable()) {
affectedRows = internalExecutionResult.updateResultsForRewrite(size, true);
} else if (prepareResult.isQueryMultipleRewritable()) {
affectedRows = internalExecutionResult.updateResultsMultiple(size, true);
}
} else affectedRows = internalExecutionResult.getAffectedRows();
exception = e;
} finally {
executionResult = internalExecutionResult;
executing = false;
executeQueryEpilog(exception);
}
} catch (SQLException sqle) {
throw new BatchUpdateException(sqle.getMessage(), sqle.getSQLState(), sqle.getErrorCode(),
affectedRows, sqle);
} finally {
lock.unlock();
clearBatch();
}
return affectedRows;
}
/**
* Choose better way to execute queries according to query and options.
*
* @param internalExecutionResult results
* @param size parameters number
* @return affected rows
* @throws QueryException if any error occur
*/
private int[] executeInternalBatch(MultiExecutionResult internalExecutionResult, int size) throws QueryException {
if (options.rewriteBatchedStatements) {
if (prepareResult.isQueryMultiValuesRewritable()) {
//values rewritten in one query :
// INSERT INTO X(a,b) VALUES (1,2), (3,4), ...
protocol.executeBatchRewrite(protocol.isMasterConnection(), internalExecutionResult, prepareResult,
parameterList, resultSetScrollType, true);
return internalExecutionResult.updateResultsForRewrite(size, false);
} else if (prepareResult.isQueryMultipleRewritable()) {
//multi rewritten in one query :
// INSERT INTO X(a,b) VALUES (1,2);INSERT INTO X(a,b) VALUES (3,4); ...
protocol.executeBatchRewrite(protocol.isMasterConnection(), internalExecutionResult, prepareResult,
parameterList, resultSetScrollType, false);
return internalExecutionResult.updateResultsMultiple(size, false);
}
}
if (options.useBatchMultiSend) {
//send by bulk : send data by bulk before reading corresponding results
protocol.executeBatchMulti(protocol.isMasterConnection(), internalExecutionResult, prepareResult, parameterList, resultSetScrollType);
} else {
//send query one by one, reading results for each query before sending another one
QueryException exception = null;
for (int batchQueriesCount = 0; batchQueriesCount < size; batchQueriesCount++) {
try {
protocol.executeQuery(protocol.isMasterConnection(), internalExecutionResult, prepareResult,
parameterList.get(batchQueriesCount), resultSetScrollType);
} catch (QueryException e) {
if (options.continueBatchOnError) {
exception = e;
} else {
throw e;
}
}
}
if (exception != null) throw exception;
}
return internalExecutionResult.getAffectedRows();
}
/**
* {inheritdoc}.
*/
@Override
public ResultSet getGeneratedKeys() throws SQLException {
if (executionResult != null && executionResult.getResultSet() == null) {
int autoIncrementIncrement = connection.getAutoIncrementIncrement();
//multi insert in one execution. will create result based on autoincrement
if (executionResult.hasMoreThanOneAffectedRows()) {
long[] data;
if (executionResult.isSingleExecutionResult()) {
int updateCount = executionResult.getFirstAffectedRows();
data = new long[updateCount];
for (int i = 0; i < updateCount; i++) {
data[i] = ((SingleExecutionResult) executionResult).getInsertId() + i * autoIncrementIncrement;
}
} else {
if (options.rewriteBatchedStatements && prepareResult.isQueryMultiValuesRewritable()) {
MultiVariableIntExecutionResult multiExecution = (MultiVariableIntExecutionResult) executionResult;
data = multiExecution.getInsertIdsForRewrite(autoIncrementIncrement);
} else {
MultiExecutionResult multiExecution = (MultiExecutionResult) executionResult;
int size = 0;
int affectedRowsLength = multiExecution.getAffectedRows().length;
for (int i = 0; i < affectedRowsLength; i++) {
int affectedRows = multiExecution.getAffectedRows()[i];
if (affectedRows >= 0) {
size += multiExecution.getAffectedRows()[i];
} else {
size += 1;
}
}
data = new long[(size < 0) ? 0 : size];
int insertIdCounter = 0;
for (int affectedRowsCounter = 0; affectedRowsCounter < affectedRowsLength; affectedRowsCounter++) {
int affectedRows = multiExecution.getAffectedRows()[affectedRowsCounter];
if (affectedRows > 0) {
for (int i = 0; i < affectedRows; i++) {
data[insertIdCounter++] = multiExecution.getInsertIds()[affectedRowsCounter] + i * autoIncrementIncrement;
}
} else {
data[insertIdCounter++] = multiExecution.getInsertIds()[affectedRowsCounter];
}
}
}
}
return MariaSelectResultSet.createGeneratedData(data, connection.getProtocol(), true);
}
return MariaSelectResultSet.createGeneratedData(executionResult.getInsertIds(), connection.getProtocol(), true);
}
return MariaSelectResultSet.EMPTY;
}
/**
* Retrieves a ResultSetMetaData object that contains information about the columns of the
* ResultSet object that will be returned when this PreparedStatement object is executed.
*
* Because a PreparedStatement object is precompiled, it is possible to know about the
* ResultSet object that it will return without having to execute it. Consequently, it is possible to
* invoke the method getMetaData on a PreparedStatement object rather than waiting to
* execute it and then invoking the ResultSet.getMetaData method on the ResultSet object
* that is returned.
*
* NOTE: Using this method may be expensive for some drivers due to the lack of underlying DBMS support.
*
* @return the description of a ResultSet object's columns or null if the driver cannot
* return a ResultSetMetaData object
* @throws SQLException if a database access error occurs or this method is called on a closed
* PreparedStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.2
*/
public ResultSetMetaData getMetaData() throws SQLException {
checkClose();
ResultSet rs = getResultSet();
if (rs != null) {
return rs.getMetaData();
}
if (resultSetMetaData == null) {
setParametersData();
}
return resultSetMetaData;
}
protected void setParameter(final int parameterIndex, final ParameterHolder holder) throws SQLException {
if (parameterIndex >= 1 && parameterIndex < prepareResult.getParamCount() + 1) {
parameters[parameterIndex - 1] = holder;
} else {
logger.error("Could not set parameter at position " + parameterIndex
+ " (values vas " + holder.toString() + ")");
throw ExceptionMapper.getSqlException("Could not set parameter at position " + parameterIndex
+ " (values vas " + holder.toString() + ")");
}
}
/**
* Retrieves the number, types and properties of this PreparedStatement object's parameters.
*
* @return a ParameterMetaData object that contains information about the number, types and properties
* for each parameter marker of this PreparedStatement object
* @throws SQLException if a database access error occurs or this method is called on a closed
* PreparedStatement
* @see ParameterMetaData
* @since 1.4
*/
public ParameterMetaData getParameterMetaData() throws SQLException {
checkClose();
if (parameterMetaData == null) {
setParametersData();
}
return parameterMetaData;
}
private void setParametersData() throws SQLException {
MariaDbServerPreparedStatement ssps = new MariaDbServerPreparedStatement(connection, this.sqlQuery,
ResultSet.TYPE_SCROLL_INSENSITIVE, true);
resultSetMetaData = ssps.getMetaData();
parameterMetaData = ssps.getParameterMetaData();
ssps.close();
}
/**
* Clears the current parameter values immediately. In general, parameter values remain in force for repeated use
* of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is
* useful to immediately release the resources used by the current parameter values; this can be done by calling the
* method clearParameters.
*/
public void clearParameters() {
parameters = new ParameterHolder[prepareResult.getParamCount()];
}
// Close prepared statement, maybe fire closed-statement events
@Override
public void close() throws SQLException {
super.close();
if (connection == null || connection.pooledConnection == null
|| connection.pooledConnection.statementEventListeners.isEmpty()) {
return;
}
}
protected int getParameterCount() {
return prepareResult.getParamCount();
}
/**
* {inherit}.
*/
@Override
public String toString() {
StringBuffer sb = new StringBuffer("sql : '" + sqlQuery + "'");
sb.append(", parameters : [");
for (int i = 0; i < parameters.length; i++) {
ParameterHolder holder = parameters[i];
if (holder == null) {
sb.append("null");
} else {
sb.append(holder.toString());
}
if (i != parameters.length - 1) {
sb.append(",");
}
}
sb.append("]");
return sb.toString();
}
protected ClientPrepareResult getPrepareResult() {
return prepareResult;
}
protected void initializeFallbackClient(MariaDbServerPreparedStatement serverPreparedStatement) throws SQLException {
if (serverPreparedStatement.currentParameterHolder.size() == prepareResult.getParamCount()) {
this.parameters = serverPreparedStatement.currentParameterHolder.values().toArray(new ParameterHolder[0]);
} else {
Iterator paramsIterator = serverPreparedStatement.currentParameterHolder.values().iterator();
for (int i = 0 ; i < prepareResult.getParamCount() && paramsIterator.hasNext(); i++) {
this.parameters[i] = paramsIterator.next();
}
}
this.parameterList = serverPreparedStatement.queryParameters;
this.resultSetMetaData = serverPreparedStatement.metadata;
this.parameterMetaData = serverPreparedStatement.parameterMetaData;
this.batchQueries = serverPreparedStatement.batchQueries;
if (serverPreparedStatement.queryTimeout != 0) setQueryTimeout(serverPreparedStatement.queryTimeout);
if (serverPreparedStatement.getFetchSize() != 0) setFetchSize(serverPreparedStatement.getFetchSize());
if (serverPreparedStatement.maxRows != 0) setMaxRows(serverPreparedStatement.maxRows);
if (serverPreparedStatement.isCloseOnCompletion()) closeOnCompletion();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy