Class MariaDbStatement
- All Implemented Interfaces:
AutoCloseable,Cloneable,Statement,Wrapper
- Direct Known Subclasses:
BasePrepareStatement
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final booleanprotected booleanprotected MariaDbConnectionthe Connection object.protected booleanprotected intprivate booleanprotected final ReentrantLockprivate static final Loggerprivate intprotected longprivate booleanprotected final Optionsprotected Protocolthe protocol used to talk to the server.protected intprotected Resultsprotected final intprotected final intprivate static final ScheduledExecutorServiceprivate Future<?> private booleanFields 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
ConstructorsConstructorDescriptionMariaDbStatement(MariaDbConnection connection, int resultSetScrollType, int resultSetConcurrency) Creates a new Statement. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the given SQL command to the current list of commands for thisStatementobject.voidcancel()Cancels thisStatementobject if both the DBMS and driver support aborting an SQL statement.protected voidCheck if statement is closed, and throw exception if so.voidcheckCloseOnCompletion(ResultSet resultSet) Check that close on completion is asked, and close if so.voidEmpties thisStatementobject's current list of SQL send.voidClears all the warnings reported on thisStatementobject.clone(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.voidbooleanexecutes a query.booleanExecutes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval.booleanExecutes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.booleanExecutes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.int[]Execute statements.protected voidprotected BatchUpdateExceptionexecuteBatchExceptionEpilogue(SQLException initialSqle, int size) protected voidprotected SQLExceptionReset timeout after query, re-throw SQL exception.private booleanexecuteInternal(String sql, int fetchSize, int autoGeneratedKeys) Executes a query.long[]Execute batch, like executeBatch(), with returning results with long[].longexecuteLargeUpdate(String sql) Executes the given SQL statement, which may be an INSERT, UPDATE, or DELETE statement or an SQL statement that returns nothing, such as an SQL DDL statement.longexecuteLargeUpdate(String sql, int autoGeneratedKeys) Identical to executeLargeUpdate(String sql), with a flag that indicate that autoGeneratedKeys (primary key fields with "auto_increment") generated id's must be retrieved.longexecuteLargeUpdate(String sql, int[] columnIndexes) Identical to executeLargeUpdate(String sql, int autoGeneratedKeys) with autoGeneratedKeys = Statement.RETURN_GENERATED_KEYS set.longexecuteLargeUpdate(String sql, String[] columnNames) Identical to executeLargeUpdate(String sql, int autoGeneratedKeys) with autoGeneratedKeys = Statement.RETURN_GENERATED_KEYS set.executeQuery(String sql) executes a select query.protected voidexecuteQueryPrologue(boolean isBatch) Command prolog.intexecuteUpdate(String sql) Executes an update.intexecuteUpdate(String sql, int autoGeneratedKeys) Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatementobject should be made available for retrieval.intexecuteUpdate(String sql, int[] columnIndexes) Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.intexecuteUpdate(String sql, String[] columnNames) Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.Gets the connection that created this statement.intRetrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatementobject.intRetrieves the number of result set rows that is the default fetch size forResultSetobjects generated from thisStatementobject.Retrieves any auto-generated keys created as a result of executing thisStatementobject.longRetrieves the maximum number of rows that a ResultSet object produced by this Statement object can contain.longRetrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.intRetrieves the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject.intRetrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain.booleanMoves to thisStatementobject's next result, returnstrueif it is aResultSetobject, and implicitly closes any currentResultSetobject(s) obtained with the methodgetResultSet.booleangetMoreResults(int current) Moves to thisStatementobject's next result, deals with any currentResultSetobject(s) according to the instructions specified by the given flag, and returnstrueif the next result is aResultSetobject.intRetrieves the number of seconds the driver will wait for aStatementobject to execute.Retrieves the current result as a ResultSet object.intRetrieves the result set concurrency forResultSetobjects generated by thisStatementobject.intRetrieves the result set holdability forResultSetobjects generated by thisStatementobject.intRetrieves the result set type forResultSetobjects generated by thisStatementobject.longPermit to retrieve current connection thread id, or -1 if unknown.private StringgetTimeoutSql(String sql) intRetrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.Retrieves the first warning reported by calls on thisStatementobject.private SQLExceptionprivate voidinternalBatchExecution(int size) Internal batch execution.booleanisClosed()Retrieves whether thisStatementobject has been closed.booleanbooleanReturns a value indicating whether theStatementis poolable or not.booleanisWrapperFor(Class<?> interfaceOrWrapper) Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.voidsetCursorName(String name) Sets the SQL cursor name to the givenString, which will be used by subsequentStatementobjectexecutemethods.voidsetEscapeProcessing(boolean enable) Sets escape processing on or off.voidsetFetchDirection(int direction) Gives the driver a hint as to the direction in which rows will be processed inResultSetobjects created using thisStatementobject.voidsetFetchSize(int rows) Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed forResultSetobjects generated by thisStatement.voidsetLargeMaxRows(long max) Sets the limit for the maximum number of rows that any ResultSet object generated by this Statement object can contain to the given number.voidsetLocalInfileInputStream(InputStream inputStream) Sets the inputStream that will be used for the next execute that uses "LOAD DATA LOCAL INFILE".voidsetMaxFieldSize(int max) Sets the limit for the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject.voidsetMaxRows(int max) Sets the limit for the maximum number of rows that anyResultSetobject generated by thisStatementobject can contain to the given number.voidsetPoolable(boolean poolable) Requests that aStatementbe pooled or not pooled.voidsetQueryTimeout(int seconds) Sets the number of seconds the driver will wait for aStatementobject to execute to the given number of seconds.protected voidsetTimerTask(boolean isBatch) protected voidprivate voidbooleantestExecute(String sql, Charset charset) ! This method is for test only ! This permit sending query using specific charset.<T> TReturns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.sql.Statement
enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, isSimpleIdentifier
-
Field Details
-
timeoutScheduler
-
logger
-
lock
-
resultSetScrollType
protected final int resultSetScrollType -
resultSetConcurrency
protected final int resultSetConcurrency -
options
-
canUseServerTimeout
protected final boolean canUseServerTimeout -
protocol
the protocol used to talk to the server. -
connection
the Connection object. -
closed
protected volatile boolean closed -
queryTimeout
protected int queryTimeout -
maxRows
protected long maxRows -
results
-
fetchSize
protected int fetchSize -
executing
protected volatile boolean executing -
warningsCleared
private boolean warningsCleared -
mustCloseOnCompletion
private boolean mustCloseOnCompletion -
batchQueries
-
timerTaskFuture
-
isTimedout
private boolean isTimedout -
maxFieldSize
private int maxFieldSize
-
-
Constructor Details
-
MariaDbStatement
public MariaDbStatement(MariaDbConnection connection, int resultSetScrollType, int resultSetConcurrency) Creates a new Statement.- Parameters:
connection- the connection to return in getConnection.resultSetScrollType- 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_UPDATABLE
-
-
Method Details
-
clone
Clone statement.- Parameters:
connection- connection- Returns:
- Clone statement.
- Throws:
CloneNotSupportedException- if any error occur.
-
setTimerTask
protected void setTimerTask(boolean isBatch) -
executeQueryPrologue
Command prolog.- clear previous query state
- launch timeout timer if needed
- Parameters:
isBatch- is batch- Throws:
SQLException- if statement is closed
-
stopTimeoutTask
private void stopTimeoutTask() -
executeExceptionEpilogue
Reset timeout after query, re-throw SQL exception.- Parameters:
sqle- current exception- Returns:
- SQLException exception with new message in case of timer timeout.
-
executeEpilogue
protected void executeEpilogue() -
executeBatchEpilogue
protected void executeBatchEpilogue() -
handleFailoverAndTimeout
-
executeBatchExceptionEpilogue
-
executeInternal
private boolean executeInternal(String sql, int fetchSize, int autoGeneratedKeys) throws SQLException Executes a query.- Parameters:
sql- the queryfetchSize- fetch sizeautoGeneratedKeys- a flag indicating whether auto-generated keys should be returned; one ofStatement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYS- Returns:
- true if there was a result set, false otherwise.
- Throws:
SQLException- the error description
-
getTimeoutSql
-
testExecute
! This method is for test only ! This permit sending query using specific charset.- Parameters:
sql- sqlcharset- charset- Returns:
- boolean if execution went well
- Throws:
SQLException- if any exception occur
-
execute
executes a query.- Specified by:
executein interfaceStatement- Parameters:
sql- the query- Returns:
- true if there was a result set, false otherwise.
- Throws:
SQLException- if the query could not be sent to server
-
execute
Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval. The driver will ignore this signal if the SQL statement is not an
INSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
Theexecutemethod executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSetorgetUpdateCountto retrieve the result, andgetInternalMoreResultsto move to any subsequent result(s).- Specified by:
executein interfaceStatement- Parameters:
sql- any SQL statementautoGeneratedKeys- a constant indicating whether auto-generated keys should be made available for retrieval using the methodgetGeneratedKeys; one of the following constants:Statement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYS- Returns:
trueif the first result is aResultSetobject;falseif it is an update count or there are no results- Throws:
SQLException- if a database access error occurs, this method is called on a closedStatementor the second parameter supplied to this method is notStatement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYS.- See Also:
-
execute
Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not anINSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).Under some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
Theexecutemethod executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSetorgetUpdateCountto retrieve the result, andgetInternalMoreResultsto move to any subsequent result(s).- Specified by:
executein interfaceStatement- Parameters:
sql- any SQL statementcolumnIndexes- an array of the indexes of the columns in the inserted row that should be made available for retrieval by a call to the methodgetGeneratedKeys- Returns:
trueif the first result is aResultSetobject;falseif it is an update count or there are no results- Throws:
SQLException- if a database access error occurs, this method is called on a closedStatementor the elements in theintarray passed to this method are not valid column indexes- See Also:
-
execute
Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the names of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not an
INSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
The
executemethod executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSetorgetUpdateCountto retrieve the result, andgetInternalMoreResultsto move to any subsequent result(s).- Specified by:
executein interfaceStatement- Parameters:
sql- any SQL statementcolumnNames- an array of the names of the columns in the inserted row that should be made available for retrieval by a call to the methodgetGeneratedKeys- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
SQLException- if a database access error occurs, this method is called on a closedStatementor the elements of theStringarray passed to this method are not valid column names- See Also:
-
executeQuery
executes a select query.- Specified by:
executeQueryin interfaceStatement- Parameters:
sql- the query to send to the server- Returns:
- a result set
- Throws:
SQLException- if something went wrong
-
executeUpdate
Executes an update.- Specified by:
executeUpdatein interfaceStatement- Parameters:
sql- the update query.- Returns:
- update count
- Throws:
SQLException- if the query could not be sent to server.
-
executeUpdate
Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatementobject should be made available for retrieval. The driver will ignore the flag if the SQL statement is not anINSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).- Specified by:
executeUpdatein interfaceStatement- Parameters:
sql- an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.autoGeneratedKeys- a flag indicating whether auto-generated keys should be made available for retrieval; one of the following constants:Statement.RETURN_GENERATED_KEYSStatement.NO_GENERATED_KEYS- 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 closedStatement, the given SQL statement returns aResultSetobject, or the given constant is not one of those allowed
-
executeUpdate
Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not anINSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).- Specified by:
executeUpdatein interfaceStatement- Parameters:
sql- an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.columnIndexes- an array of column indexes indicating the columns that should be returned from the inserted row- 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 closedStatement, the SQL statement returns aResultSetobject, or the second argument supplied to this method is not anintarray whose elements are valid column indexes
-
executeUpdate
Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the names of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not anINSERTstatement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).- Specified by:
executeUpdatein interfaceStatement- Parameters:
sql- an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.columnNames- an array of the names of the columns that should be returned from the inserted row- Returns:
- either the row count for
INSERT,UPDATE, orDELETEstatements, or 0 for SQL statements that return nothing - Throws:
SQLException- if a database access error occurs, this method is called on a closedStatement, the SQL statement returns aResultSetobject, or the second argument supplied to this method is not aStringarray whose elements are valid column names
-
executeLargeUpdate
Executes the given SQL statement, which may be an INSERT, UPDATE, or DELETE statement or an SQL statement that returns nothing, such as an SQL DDL statement. This method should be used when the returned row count may exceed Integer.MAX_VALUE.- Specified by:
executeLargeUpdatein interfaceStatement- Parameters:
sql- sql command- Returns:
- update counts
- Throws:
SQLException- if any error occur during execution
-
executeLargeUpdate
Identical to executeLargeUpdate(String sql), with a flag that indicate that autoGeneratedKeys (primary key fields with "auto_increment") generated id's must be retrieved.Those id's will be available using getGeneratedKeys() method.
- Specified by:
executeLargeUpdatein interfaceStatement- Parameters:
sql- sql commandautoGeneratedKeys- a flag indicating whether auto-generated keys should be made available for retrieval; one of the following constants: Statement.RETURN_GENERATED_KEYS Statement.NO_GENERATED_KEYS- Returns:
- update counts
- Throws:
SQLException- if any error occur during execution
-
executeLargeUpdate
Identical to executeLargeUpdate(String sql, int autoGeneratedKeys) with autoGeneratedKeys = Statement.RETURN_GENERATED_KEYS set.- Specified by:
executeLargeUpdatein interfaceStatement- Parameters:
sql- sql commandcolumnIndexes- column Indexes- Returns:
- update counts
- Throws:
SQLException- if any error occur during execution
-
executeLargeUpdate
Identical to executeLargeUpdate(String sql, int autoGeneratedKeys) with autoGeneratedKeys = Statement.RETURN_GENERATED_KEYS set.- Specified by:
executeLargeUpdatein interfaceStatement- Parameters:
sql- sql commandcolumnNames- columns names- Returns:
- update counts
- Throws:
SQLException- if any error occur during execution
-
close
Releases 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 methodcloseon aStatementobject that is already closed has no effect. Note:When aStatementobject is closed, its currentResultSetobject, if one exists, is also closed.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceStatement- Throws:
SQLException- if a database access error occurs
-
getMaxFieldSize
public int getMaxFieldSize()Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject. This limit applies only toBINARY,VARBINARY,LONGVARBINARY,CHAR,VARCHAR,NCHAR,NVARCHAR,LONGNVARCHARandLONGVARCHARcolumns. If the limit is exceeded, the excess data is silently discarded.- Specified by:
getMaxFieldSizein interfaceStatement- Returns:
- the current column size limit for columns storing character and binary values; zero means there is no limit
- See Also:
-
setMaxFieldSize
public void setMaxFieldSize(int max) Sets the limit for the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject. This limit applies only toBINARY,VARBINARY,LONGVARBINARY,CHAR,VARCHAR,NCHAR,NVARCHAR,LONGNVARCHARandLONGVARCHARfields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.- Specified by:
setMaxFieldSizein interfaceStatement- Parameters:
max- the new column size limit in bytes; zero means there is no limit- See Also:
-
getMaxRows
public int getMaxRows()Retrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain. If this limit is exceeded, the excess rows are silently dropped.- Specified by:
getMaxRowsin interfaceStatement- Returns:
- the current maximum number of rows for a
ResultSetobject produced by thisStatementobject; zero means there is no limit - See Also:
-
setMaxRows
Sets the limit for the maximum number of rows that anyResultSetobject generated by thisStatementobject can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.- Specified by:
setMaxRowsin interfaceStatement- Parameters:
max- the new max rows limit; zero means there is no limit- Throws:
SQLException- if the condition max >= 0 is not satisfied- See Also:
-
getLargeMaxRows
public long getLargeMaxRows()Retrieves the maximum number of rows that a ResultSet object produced by this Statement object can contain. If this limit is exceeded, the excess rows are silently dropped.- Specified by:
getLargeMaxRowsin interfaceStatement- Returns:
- the current maximum number of rows for a ResultSet object produced by this Statement object; zero means there is no limit
-
setLargeMaxRows
Sets the limit for the maximum number of rows that any ResultSet object generated by this Statement object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.- Specified by:
setLargeMaxRowsin interfaceStatement- Parameters:
max- the new max rows limit; zero means there is no limit- Throws:
SQLException- if the condition max >= 0 is not satisfied
-
setEscapeProcessing
public void setEscapeProcessing(boolean enable) Sets escape processing on or off. If escape scanning is on (the default), the driver will do escape substitution before sending the SQL statement to the database. Note: Since prepared statements have usually been parsed prior to making this call, disabling escape processing forPreparedStatementsobjects will have no effect.- Specified by:
setEscapeProcessingin interfaceStatement- Parameters:
enable-trueto enable escape processing;falseto disable it
-
getQueryTimeout
public int getQueryTimeout()Retrieves the number of seconds the driver will wait for aStatementobject to execute. If the limit is exceeded, aSQLExceptionis thrown.- Specified by:
getQueryTimeoutin interfaceStatement- Returns:
- the current query timeout limit in seconds; zero means there is no limit
- See Also:
-
setQueryTimeout
Sets 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- 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:
-
setLocalInfileInputStream
Sets the inputStream that will be used for the next execute that uses "LOAD DATA LOCAL INFILE". The name specified as local file/URL will be ignored.- Parameters:
inputStream- inputStream instance, that will be used to send data to server- Throws:
SQLException- if statement is closed
-
cancel
Cancels thisStatementobject if both the DBMS and driver support aborting an SQL statement. This method can be used by one thread to cancel a statement that is being executed by another thread.In case there is result-set from this Statement that are still streaming data from server, will cancel streaming.
- Specified by:
cancelin interfaceStatement- Throws:
SQLException- if a database access error occurs or this method is called on a closedStatement
-
getWarnings
Retrieves the first warning reported by calls on thisStatementobject. SubsequentStatementobject warnings will be chained to thisSQLWarningobject.The warning chain is automatically cleared each time a statement is (re)executed. This method may not be called on a closed
Statementobject; doing so will cause anSQLExceptionto be thrown.Note: If you are processing a
ResultSetobject, any warnings associated with reads on thatResultSetobject will be chained on it rather than on theStatementobject that produced it.- Specified by:
getWarningsin interfaceStatement- Returns:
- the first
SQLWarningobject ornullif there are no warnings - Throws:
SQLException- if a database access error occurs or this method is called on a closedStatement
-
clearWarnings
public void clearWarnings()Clears all the warnings reported on thisStatementobject. After a call to this method, the methodgetWarningswill returnnulluntil a new warning is reported for thisStatementobject.- Specified by:
clearWarningsin interfaceStatement
-
setCursorName
Sets the SQL cursor name to the givenString, which will be used by subsequentStatementobjectexecutemethods. This name can then be used in SQL positioned update or delete statements to identify the current row in theResultSetobject generated by this statement. If the database does not support positioned update/delete, this method is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor'sSELECTstatement should have the formSELECT FOR UPDATE. IfFOR UPDATEis not present, positioned updates may fail.Note: By definition, the execution of positioned updates and deletes must be done by a different
Statementobject than the one that generated theResultSetobject being used for positioning. Also, cursor names must be unique within a connection.- Specified by:
setCursorNamein interfaceStatement- Parameters:
name- the new cursor name, which must be unique within a connection- Throws:
SQLException- if a database access error occurs or this method is called on a closedStatement
-
getConnection
Gets the connection that created this statement.- Specified by:
getConnectionin interfaceStatement- Returns:
- the connection
-
getGeneratedKeys
Retrieves any auto-generated keys created as a result of executing thisStatementobject. If thisStatementobject did not generate any keys, an emptyResultSetobject is returned.Note:If the columns which represent the auto-generated keys were not specified, the JDBC driver implementation will determine the columns which best represent the auto-generated keys.
- Specified by:
getGeneratedKeysin interfaceStatement- Returns:
- a
ResultSetobject containing the auto-generated key(s) generated by the execution of thisStatementobject - Throws:
SQLException- if a database access error occurs or this method is called on a closedStatement
-
getResultSetHoldability
public int getResultSetHoldability()Retrieves the result set holdability forResultSetobjects generated by thisStatementobject.- Specified by:
getResultSetHoldabilityin interfaceStatement- Returns:
- either
ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT - Since:
- 1.4
-
isClosed
public boolean isClosed()Retrieves whether thisStatementobject has been closed. AStatementis closed if the method close has been called on it, or if it is automatically closed. -
isPoolable
public boolean isPoolable()Returns a value indicating whether theStatementis poolable or not.- Specified by:
isPoolablein interfaceStatement- Returns:
trueif theStatementis poolable;falseotherwise- Since:
- 1.6
- See Also:
-
setPoolable
public void setPoolable(boolean poolable) Requests that a
Statementbe pooled or not pooled. The value specified is a hint to the statement pool implementation indicating whether the applicaiton wants the statement to be pooled. It is up to the statement pool manager as to whether the hint is used.The poolable value of a statement is applicable to both internal statement caches implemented by the driver and external statement caches implemented by application servers and other applications.
By default, a
Statementis not poolable when created, and aPreparedStatementandCallableStatementare poolable when created.- Specified by:
setPoolablein interfaceStatement- Parameters:
poolable- requests that the statement be pooled if true and that the statement not be pooled if false- Since:
- 1.6
-
getResultSet
Retrieves the current result as a ResultSet object. This method should be called only once per result.- Specified by:
getResultSetin interfaceStatement- Returns:
- the current result as a ResultSet object or null if the result is an update count or there are no more results
- Throws:
SQLException- if a database access error occurs or this method is called on a closed Statement
-
getUpdateCount
public int getUpdateCount()Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned. This method should be called only once per result.- Specified by:
getUpdateCountin interfaceStatement- Returns:
- the current result as an update count; -1 if the current result is a ResultSet object or there are no more results
-
getLargeUpdateCount
public long getLargeUpdateCount()Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.- Specified by:
getLargeUpdateCountin interfaceStatement- Returns:
- last update count
-
skipMoreResults
- Throws:
SQLException
-
getMoreResults
Moves to this
There are no more results when the following is true:Statementobject's next result, returnstrueif it is aResultSetobject, and implicitly closes any currentResultSetobject(s) obtained with the methodgetResultSet.// stmt is a Statement object ((stmt.getInternalMoreResults() == false) && (stmt.getUpdateCount() == -1))
- Specified by:
getMoreResultsin interfaceStatement- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
-
getMoreResults
Moves to this
There are no more results when the following is true:Statementobject's next result, deals with any currentResultSetobject(s) according to the instructions specified by the given flag, and returnstrueif the next result is aResultSetobject.// stmt is a Statement object ((stmt.getInternalMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
- Specified by:
getMoreResultsin interfaceStatement- Parameters:
current- one of the followingStatementconstants indicating what should happen to currentResultSetobjects obtained using the methodgetResultSet:Statement.CLOSE_CURRENT_RESULT,Statement.KEEP_CURRENT_RESULT, orStatement.CLOSE_ALL_RESULTS- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
SQLException- if a database access error occurs, this method is called on a closedStatementor the argument supplied is not one of the following:Statement.CLOSE_CURRENT_RESULT,Statement.KEEP_CURRENT_RESULTorStatement.CLOSE_ALL_RESULTS- See Also:
-
getFetchDirection
public int getFetchDirection()Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatementobject. If thisStatementobject has not set a fetch direction by calling the methodsetFetchDirection, the return value is implementation-specific.- Specified by:
getFetchDirectionin interfaceStatement- Returns:
- the default fetch direction for result sets generated from this
Statementobject - Since:
- 1.2
- See Also:
-
setFetchDirection
public void setFetchDirection(int direction) Gives the driver a hint as to the direction in which rows will be processed in
ResultSetobjects created using thisStatementobject. The default value isResultSet.FETCH_FORWARD.Note that this method sets the default fetch direction for result sets generated by this
Statementobject. Each result set has its own methods for getting and setting its own fetch direction.- Specified by:
setFetchDirectionin interfaceStatement- Parameters:
direction- the initial direction for processing rows- Since:
- 1.2
- See Also:
-
getFetchSize
public int getFetchSize()Retrieves the number of result set rows that is the default fetch size forResultSetobjects generated from thisStatementobject. If thisStatementobject has not set a fetch size by calling the methodsetFetchSize, the return value is implementation-specific.- Specified by:
getFetchSizein interfaceStatement- Returns:
- the default fetch size for result sets generated from this
Statementobject - See Also:
-
setFetchSize
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed forResultSetobjects generated by thisStatement. If the value specified is zero, then the hint is ignored. The default value is zero.- Specified by:
setFetchSizein interfaceStatement- Parameters:
rows- the number of rows to fetch- Throws:
SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionrows >= 0is not satisfied.- See Also:
-
getResultSetConcurrency
public int getResultSetConcurrency()Retrieves the result set concurrency forResultSetobjects generated by thisStatementobject.- Specified by:
getResultSetConcurrencyin interfaceStatement- Returns:
- either
ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE - Since:
- 1.2
-
getResultSetType
public int getResultSetType()Retrieves the result set type forResultSetobjects generated by thisStatementobject.- Specified by:
getResultSetTypein interfaceStatement- Returns:
- one of
ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE
-
addBatch
Adds the given SQL command to the current list of commands for thisStatementobject. The send in this list can be executed as a batch by calling the methodexecuteBatch.- Specified by:
addBatchin interfaceStatement- Parameters:
sql- typically this is a SQLINSERTorUPDATEstatement- Throws:
SQLException- if a database access error occurs, this method is called on a closedStatementor the driver does not support batch updates- See Also:
-
clearBatch
public void clearBatch()Empties thisStatementobject's current list of SQL send.- Specified by:
clearBatchin interfaceStatement- Since:
- 1.2
- See Also:
-
executeBatch
Execute statements. depending on option, queries mays be rewritten :those queries will be rewritten if possible to INSERT INTO ... VALUES (...) ; INSERT INTO ... VALUES (...);
if option rewriteBatchedStatements is set to true, rewritten to INSERT INTO ... VALUES (...), (...);
- Specified by:
executeBatchin interfaceStatement- 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:
-
executeLargeBatch
Execute batch, like executeBatch(), with returning results with long[]. For when row count may exceed Integer.MAX_VALUE.- Specified by:
executeLargeBatchin interfaceStatement- Returns:
- an array of update counts (one element for each command in the batch)
- Throws:
SQLException- if a database error occur.
-
internalBatchExecution
Internal batch execution.- Parameters:
size- expected result-set size- Throws:
SQLException- throw exception if batch error occur
-
unwrap
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling
unwraprecursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then anSQLExceptionis thrown.- Specified by:
unwrapin interfaceWrapper- Parameters:
iface- A Class defining an interface that the result must implement.- Returns:
- an object that implements the interface. May be a proxy for the actual implementing object.
- Throws:
SQLException- If no object found that implements the interface- Since:
- 1.6
-
isWrapperFor
Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively callingisWrapperForon the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared tounwrapso that callers can use this method to avoid expensiveunwrapcalls that may fail. If this method returns true then callingunwrapwith the same argument should succeed.- Specified by:
isWrapperForin interfaceWrapper- Parameters:
interfaceOrWrapper- a Class defining an interface.- Returns:
- true if this implements the interface or directly or indirectly wraps an object that does.
- Throws:
SQLException- if an error occurs while determining whether this is a wrapper for an object with the given interface.- Since:
- 1.6
-
closeOnCompletion
public void closeOnCompletion()- Specified by:
closeOnCompletionin interfaceStatement
-
isCloseOnCompletion
public boolean isCloseOnCompletion()- Specified by:
isCloseOnCompletionin interfaceStatement
-
checkCloseOnCompletion
Check that close on completion is asked, and close if so.- Parameters:
resultSet- resultSet- Throws:
SQLException- if close has error
-
checkClose
Check if statement is closed, and throw exception if so.- Throws:
SQLException- if statement close
-
getServerThreadId
public long getServerThreadId()Permit to retrieve current connection thread id, or -1 if unknown.- Returns:
- current connection thread id.
-