Package org.mariadb.jdbc
Class ServerSidePreparedStatement
- java.lang.Object
-
- org.mariadb.jdbc.MariaDbStatement
-
- org.mariadb.jdbc.BasePrepareStatement
-
- org.mariadb.jdbc.ServerSidePreparedStatement
-
- All Implemented Interfaces:
AutoCloseable,Cloneable,PreparedStatement,Statement,Wrapper
- Direct Known Subclasses:
CallableProcedureStatement
public class ServerSidePreparedStatement extends BasePrepareStatement implements Cloneable
-
-
Field Summary
Fields Modifier and Type Field Description protected intparameterCountprotected ServerPrepareResultserverPrepareResultprotected Stringsql-
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 Description ServerSidePreparedStatement(MariaDbConnection connection, String sql, int resultSetScrollType, int resultSetConcurrency, int autoGeneratedKeys, ExceptionFactory exceptionFactory, boolean canDelayPrepare)Constructor for creating Server prepared statement.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddBatch()voidaddBatch(String sql)Add batch.voidclearBatch()Empties thisStatementobject's current list of SQL send.voidclearParameters()ServerSidePreparedStatementclone(MariaDbConnection connection)Clone statement.voidclose()Releases thisStatementobject's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.booleanexecute()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 booleanexecuteInternal(int fetchSize)long[]executeLargeBatch()Execute batch, like executeBatch(), with returning results with long[].ResultSetexecuteQuery()intexecuteUpdate()Executes the SQL statement in thisPreparedStatementobject, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.ResultSetMetaDatagetMetaData()protected intgetParameterCount()ParameterMetaDatagetParameterMetaData()Retrieves the number, types and properties of thisPreparedStatementobject's parameters.longgetServerThreadId()Permit to retrieve current connection thread id, or -1 if unknown.protected voidprepare(String sql)voidsetParameter(int parameterIndex, ParameterHolder holder)voidsetQueryTimeout(int seconds)Sets the number of seconds the driver will wait for aStatementobject to execute to the given number of seconds.StringtoString()Return sql String value.protected voidvalidParameters()-
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, getTimeoutSql, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, isWrapperFor, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setLocalInfileInputStream, setMaxFieldSize, setMaxRows, setPoolable, 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.Statement
cancel, clearWarnings, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, 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, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable
-
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
-
-
-
Field Detail
-
parameterCount
protected int parameterCount
-
sql
protected String sql
-
serverPrepareResult
protected ServerPrepareResult serverPrepareResult
-
-
Constructor Detail
-
ServerSidePreparedStatement
public ServerSidePreparedStatement(MariaDbConnection connection, String sql, int resultSetScrollType, int resultSetConcurrency, int autoGeneratedKeys, ExceptionFactory exceptionFactory, boolean canDelayPrepare) throws SQLException
Constructor for creating Server prepared statement.- Parameters:
connection- current connectionsql- Sql String to prepareresultSetScrollType- one of the followingResultSetconstants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVEresultSetConcurrency- a concurrency type; one ofResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLEautoGeneratedKeys- a flag indicating whether auto-generated keys should be returned; one ofStatement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYSexceptionFactory- Exception factorycanDelayPrepare- can delay prepare command- Throws:
SQLException- exception
-
-
Method Detail
-
clone
public ServerSidePreparedStatement clone(MariaDbConnection connection) throws CloneNotSupportedException
Clone statement.- Overrides:
clonein classBasePrepareStatement- Parameters:
connection- connection- Returns:
- Clone statement.
- Throws:
CloneNotSupportedException- if any error occur.
-
prepare
protected void prepare(String sql) throws SQLException
- Throws:
SQLException
-
setParameter
public void setParameter(int parameterIndex, ParameterHolder holder) throws SQLException- Specified by:
setParameterin classBasePrepareStatement- Throws:
SQLException
-
addBatch
public void addBatch() throws SQLException- Specified by:
addBatchin interfacePreparedStatement- Throws:
SQLException
-
addBatch
public void addBatch(String sql) throws SQLException
Add batch.- Specified by:
addBatchin interfaceStatement- Overrides:
addBatchin classMariaDbStatement- Parameters:
sql- typically this is a SQLINSERTorUPDATEstatement- Throws:
SQLException- every time since that method is forbidden on prepareStatement- See Also:
MariaDbStatement.executeBatch(),DatabaseMetaData.supportsBatchUpdates()
-
clearBatch
public void clearBatch()
Description copied from class:MariaDbStatementEmpties thisStatementobject's current list of SQL send.- Specified by:
clearBatchin interfaceStatement- Overrides:
clearBatchin classMariaDbStatement- See Also:
MariaDbStatement.addBatch(java.lang.String),DatabaseMetaData.supportsBatchUpdates()
-
getParameterMetaData
public ParameterMetaData getParameterMetaData() throws SQLException
Description copied from class:BasePrepareStatementRetrieves the number, types and properties of thisPreparedStatementobject's parameters.- Specified by:
getParameterMetaDatain interfacePreparedStatement- Specified by:
getParameterMetaDatain classBasePrepareStatement- Returns:
- a
ParameterMetaDataobject that contains information about the number, types and properties for each parameter marker of thisPreparedStatementobject - Throws:
SQLException- if a database access error occurs or this method is called on a closedPreparedStatement- See Also:
ParameterMetaData
-
getMetaData
public ResultSetMetaData getMetaData() throws SQLException
- Specified by:
getMetaDatain interfacePreparedStatement- Throws:
SQLException
-
executeBatch
public int[] executeBatch() throws SQLExceptionSubmits a batch of send to the database for execution and if all send execute successfully, returns an array of update counts. Theintelements 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 methodexecuteBatchmay be one of the following:- 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
- 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 aBatchUpdateException, 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 methodBatchUpdateException.getUpdateCountswill contain as many elements as there are send in the batch, and at least one of the elements will be the following: - 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
BatchUpdateExceptionobject has been thrown.- Specified by:
executeBatchin interfaceStatement- Overrides:
executeBatchin classMariaDbStatement- 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:
SQLException- if a database access error occurs, this method is called on a closedStatementor the driver does not support batch statements. ThrowsBatchUpdateException(a subclass ofSQLException) if one of the send sent to the database fails to execute properly or attempts to return a result set.- Since:
- 1.3
- See Also:
addBatch(),DatabaseMetaData.supportsBatchUpdates()
-
executeLargeBatch
public long[] executeLargeBatch() throws SQLExceptionExecute batch, like executeBatch(), with returning results with long[]. For when row count may exceed Integer.MAX_VALUE.- Specified by:
executeLargeBatchin interfaceStatement- Overrides:
executeLargeBatchin classMariaDbStatement- Returns:
- an array of update counts (one element for each command in the batch)
- Throws:
SQLException- if a database error occur.
-
setQueryTimeout
public void setQueryTimeout(int seconds) throws SQLExceptionDescription copied from class:MariaDbStatementSets the number of seconds the driver will wait for aStatementobject to execute to the given number of seconds. If the limit is exceeded, anSQLExceptionis thrown. A JDBC driver must apply this limit to theexecute,executeQueryandexecuteUpdatemethods.- Specified by:
setQueryTimeoutin interfaceStatement- Overrides:
setQueryTimeoutin classMariaDbStatement- Parameters:
seconds- the new query timeout limit in seconds; zero means there is no limit- Throws:
SQLException- if a database access error occurs, this method is called on a closedStatementor the condition seconds >= 0 is not satisfied- See Also:
MariaDbStatement.getQueryTimeout()
-
executeQuery
public ResultSet executeQuery() throws SQLException
- Specified by:
executeQueryin interfacePreparedStatement- Throws:
SQLException
-
executeUpdate
public int executeUpdate() throws SQLExceptionExecutes the SQL statement in thisPreparedStatementobject, which must be an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement. Result-set are permitted for historical reason, even if spec indicate to throw exception.- Specified by:
executeUpdatein interfacePreparedStatement- Returns:
- 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 closedPreparedStatement
-
clearParameters
public void clearParameters()
- Specified by:
clearParametersin interfacePreparedStatement
-
execute
public boolean execute() throws SQLException- Specified by:
executein interfacePreparedStatement- Throws:
SQLException
-
validParameters
protected void validParameters() throws SQLException- Throws:
SQLException
-
executeInternal
protected boolean executeInternal(int fetchSize) throws SQLException- Specified by:
executeInternalin classBasePrepareStatement- Throws:
SQLException
-
close
public void close() throws SQLExceptionReleases thisStatementobject's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed. It is generally good practice to release resources as soon as you are finished with them to avoid tying up database resources.Calling the method
closeon aStatementobject that is already closed has no effect.Note:When a
Statementobject is closed, its currentResultSetobject, if one exists, is also closed.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceStatement- Overrides:
closein classMariaDbStatement- Throws:
SQLException- if a database access error occurs
-
getParameterCount
protected int getParameterCount()
-
toString
public String toString()
Return sql String value.
-
getServerThreadId
public long getServerThreadId()
Permit to retrieve current connection thread id, or -1 if unknown.- Returns:
- current connection thread id.
-
-