org.mariadb.jdbc

Class MariaDbProcedureStatement

java.lang.Object

org.mariadb.jdbc.MariaDbStatement

org.mariadb.jdbc.BasePrepareStatement

org.mariadb.jdbc.ServerSidePreparedStatement

org.mariadb.jdbc.CallableProcedureStatement

org.mariadb.jdbc.MariaDbProcedureStatement

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Cloneable, java.sql.CallableStatement, java.sql.PreparedStatement, java.sql.Statement, java.sql.Wrapper, CloneableCallableStatement

public class MariaDbProcedureStatement
extends CallableProcedureStatement
implements CloneableCallableStatement

Field Summary

Fields

Modifier and Type	Field and Description
private SelectResultSet	outputResultSet

Fields inherited from class org.mariadb.jdbc.CallableProcedureStatement

hasInOutParameters, outputParameterMapper, parameterMetadata, params

Fields inherited from class org.mariadb.jdbc.ServerSidePreparedStatement

parameterCount

Fields inherited from class org.mariadb.jdbc.BasePrepareStatement

autoGeneratedKeys, SPEC_ISO_ZONED_DATE_TIME

Fields inherited from class org.mariadb.jdbc.MariaDbStatement

canUseServerTimeout, closed, connection, exceptionFactory, executing, fetchSize, lock, maxRows, options, protocol, queryTimeout, results, resultSetConcurrency, resultSetScrollType

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Constructor Summary

Constructors

Constructor and Description
MariaDbProcedureStatement(java.lang.String query, MariaDbConnection connection, java.lang.String procedureName, java.lang.String database, int resultSetType, int resultSetConcurrency, ExceptionFactory exceptionFactory) Specific implementation of CallableStatement to handle function call, represent by call like {?= call procedure-name[(arg1,arg2, ...)]}.

Method Summary

Modifier and Type	Method and Description
MariaDbProcedureStatement	clone(MariaDbConnection connection) Clone statement.
boolean	execute()
int[]	executeBatch() Submits a batch of send to the database for execution and if all send execute successfully, returns an array of update counts.
protected SelectResultSet	getOutputResult()
private void	retrieveOutputResult()
private void	setInputOutputParameterMap()
void	setParameter(int parameterIndex, ParameterHolder holder)
private void	setParamsAccordingToSetArguments()
private void	validAllParameters() Valid that all parameters are set.

Methods inherited from class org.mariadb.jdbc.CallableProcedureStatement

getArray, getArray, getBigDecimal, getBigDecimal, getBigDecimal, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getDate, getDate, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getParameterMetaData, getRef, getRef, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getURL, getURL, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setParametersVariables, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setURL, wasNull

Methods inherited from class org.mariadb.jdbc.ServerSidePreparedStatement

addBatch, addBatch, clearBatch, clearParameters, close, executeInternal, executeLargeBatch, executeQuery, executeUpdate, getMetaData, getParameterCount, getServerThreadId, toString, validParameters

Methods inherited from class org.mariadb.jdbc.BasePrepareStatement

executeLargeUpdate, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from class org.mariadb.jdbc.MariaDbStatement

cancel, checkClose, checkCloseOnCompletion, clearWarnings, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatchEpilogue, executeBatchExceptionEpilogue, executeEpilogue, executeExceptionEpilogue, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeQueryPrologue, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, isWrapperFor, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setLocalInfileInputStream, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, setTimerTask, skipMoreResults, testExecute, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.sql.CallableStatement

getArray, getArray, getBigDecimal, getBigDecimal, getBigDecimal, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getDate, getDate, getDate, getDate, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getURL, getURL, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setURL, wasNull

Methods inherited from interface java.sql.PreparedStatement

addBatch, clearParameters, executeLargeUpdate, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

outputResultSet

private SelectResultSet outputResultSet

Constructor Detail

MariaDbProcedureStatement

public MariaDbProcedureStatement(java.lang.String query,
                                 MariaDbConnection connection,
                                 java.lang.String procedureName,
                                 java.lang.String database,
                                 int resultSetType,
                                 int resultSetConcurrency,
                                 ExceptionFactory exceptionFactory)
                          throws java.sql.SQLException

Specific implementation of CallableStatement to handle function call, represent by call like {?= call procedure-name[(arg1,arg2, ...)]}.

Parameters:

query - query

connection - current connection

procedureName - procedure name

database - database

resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

exceptionFactory - Exception Factory

Throws:

java.sql.SQLException - exception

Method Detail

setParamsAccordingToSetArguments

private void setParamsAccordingToSetArguments()

setInputOutputParameterMap

private void setInputOutputParameterMap()

getOutputResult

protected SelectResultSet getOutputResult()
                                   throws java.sql.SQLException

Specified by:

getOutputResult in class CallableProcedureStatement

Throws:

java.sql.SQLException

clone

public MariaDbProcedureStatement clone(MariaDbConnection connection)
                                throws java.lang.CloneNotSupportedException

Clone statement.

Specified by:

clone in interface CloneableCallableStatement

Overrides:

clone in class CallableProcedureStatement

Parameters:

connection - connection

Returns:

Clone statement.

Throws:

java.lang.CloneNotSupportedException - if any error occur.

retrieveOutputResult

private void retrieveOutputResult()
                           throws java.sql.SQLException

Throws:

java.sql.SQLException

setParameter

public void setParameter(int parameterIndex,
                         ParameterHolder holder)
                  throws java.sql.SQLException

Overrides:

setParameter in class ServerSidePreparedStatement

Throws:

java.sql.SQLException

execute

public boolean execute()
                throws java.sql.SQLException

Specified by:

execute in interface java.sql.PreparedStatement

Overrides:

execute in class ServerSidePreparedStatement

Throws:

java.sql.SQLException

validAllParameters

private void validAllParameters()
                         throws java.sql.SQLException

Valid that all parameters are set.

Throws:

java.sql.SQLException - if set parameters is not right

executeBatch

public int[] executeBatch()
                   throws java.sql.SQLException

Description copied from class: ServerSidePreparedStatement

Submits a batch of send to the database for execution and if all send execute successfully, returns an array of update counts. The int elements of the array that is returned are ordered to correspond to the send in the batch, which are ordered according to the order in which they were added to the batch. The elements in the array returned by the method executeBatch may be one of the following:

1. A number greater than or equal to zero -- indicates that the command was processed successfully and is an update count giving the number of rows in the database that were affected by the command's execution
2. A value of SUCCESS_NO_INFO -- indicates that the command was processed successfully but that the number of rows affected is unknown. If one of the send in a batch update fails to execute properly, this method throws a BatchUpdateException , and a JDBC driver may or may not continue to process the remaining send in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process send or never continuing to process send. If the driver continues processing after a failure, the array returned by the method BatchUpdateException.getUpdateCounts will contain as many elements as there are send in the batch, and at least one of the elements will be the following:
3. A value of EXECUTE_FAILED -- indicates that the command failed to execute successfully and occurs only if a driver continues to process send after a command fails

The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to proccess send in a batch update after a BatchUpdateException object has been thrown.

Specified by:

executeBatch in interface java.sql.Statement

Overrides:

executeBatch in class ServerSidePreparedStatement

Returns:

an array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which send were added to the batch.

Throws:

java.sql.SQLException - if a database access error occurs, this method is called on a closed Statement or the driver does not support batch statements. Throws BatchUpdateException (a subclass of SQLException) if one of the send sent to the database fails to execute properly or attempts to return a result set.

See Also:

ServerSidePreparedStatement.addBatch(), DatabaseMetaData.supportsBatchUpdates()