- java.lang.Object
-
- org.hsqldb.jdbc.JDBCStatement
-
- All Implemented Interfaces:
java.lang.AutoCloseable,java.sql.Statement,java.sql.Wrapper
public class JDBCStatement extends java.lang.Object implements java.sql.Statement, java.sql.WrapperThe object used for executing a static SQL statement and returning the results it produces.By default, only one
ResultSetobject perStatementobject can be open at the same time. Therefore, if the reading of oneResultSetobject is interleaved with the reading of another, each must have been generated by differentStatementobjects. All execution methods in theStatementinterface implicitly close a currentResultSetobject of the statement if an open one exists.HSQLDB-Specific Information:
From version 2.0, the implementation meets the JDBC specification requirement that any existing ResultSet is closed when execute() or executeQuery() methods are called. The connection property close_result=true is required for this behaviour.Methods added in JAVA 8 are generally supported.
(fredt@users)
(campbell-burnet@users)- Since:
- HSQLDB 1.9.0
- Author:
- Campbell Burnet (campbell-burnet@users dot sourceforge.net), Fred Toussi (fredt@users dot sourceforge.net)
- See Also:
JDBCConnection.createStatement(),JDBCResultSet
-
-
Field Summary
Fields Modifier and Type Field Description static intRETURN_PRIMARY_KEYS
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddBatch(java.lang.String sql)Adds 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.voidclearBatch()Empties thisStatementobject's current list of SQL commands.voidclearWarnings()Clears all the warnings reported on thisStatementobject.voidclose()Releases thisStatementobject's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.voidcloseOnCompletion()Specifies that thisStatementwill be closed when all its dependent result sets are closed.booleanexecute(java.lang.String sql)Executes the given SQL statement, which may return multiple results.booleanexecute(java.lang.String sql, int autoGeneratedKeys)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.booleanexecute(java.lang.String sql, int[] columnIndexes)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.booleanexecute(java.lang.String sql, java.lang.String[] columnNames)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.int[]executeBatch()Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.long[]executeLargeBatch()Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.longexecuteLargeUpdate(java.lang.String sql)Executes the given SQL statement, which may be anINSERT,UPDATE, orDELETEstatement or an SQL statement that returns nothing, such as an SQL DDL statement.longexecuteLargeUpdate(java.lang.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.longexecuteLargeUpdate(java.lang.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.longexecuteLargeUpdate(java.lang.String sql, java.lang.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.java.sql.ResultSetexecuteQuery(java.lang.String sql)Executes the given SQL statement, which returns a singleResultSetobject.intexecuteUpdate(java.lang.String sql)Executes the given SQL statement, which may be anINSERT,UPDATE, orDELETEstatement or an SQL statement that returns nothing, such as an SQL DDL statement.intexecuteUpdate(java.lang.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(java.lang.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(java.lang.String sql, java.lang.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.java.sql.ConnectiongetConnection()Retrieves theConnectionobject that produced thisStatementobject.intgetFetchDirection()Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatementobject.intgetFetchSize()Retrieves the number of result set rows that is the default fetch size forResultSetobjects generated from thisStatementobject.java.sql.ResultSetgetGeneratedKeys()Retrieves any auto-generated keys created as a result of executing thisStatementobject.longgetLargeMaxRows()Retrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain.longgetLargeUpdateCount()Retrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned.intgetMaxFieldSize()Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSetobject produced by thisStatementobject.intgetMaxRows()Retrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain.booleangetMoreResults()Moves 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.intgetQueryTimeout()Retrieves the number of seconds the driver will wait for aStatementobject to execute.java.sql.ResultSetgetResultSet()Retrieves the current result as aResultSetobject.intgetResultSetConcurrency()Retrieves the result set concurrency forResultSetobjects generated by thisStatementobject.intgetResultSetHoldability()Retrieves the result set holdability forResultSetobjects generated by thisStatementobject.intgetResultSetScrollability()intgetResultSetType()Retrieves the result set type forResultSetobjects generated by thisStatementobject.intgetUpdateCount()Retrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned.java.sql.SQLWarninggetWarnings()Retrieves the first warning reported by calls on thisStatementobject.booleanisClosed()Retrieves whether thisStatementobject has been closed.booleanisCloseOnCompletion()Returns a value indicating whether thisStatementwill be closed when all its dependent result sets are closed.booleanisPoolable()Returns a value indicating whether thisStatementwill be closed when all its dependent result sets are closed.booleanisWrapperFor(java.lang.Class<?> iface)Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.voidsetCursorName(java.lang.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 anyResultSetobject generated by thisStatementobject can contain to the given number.voidsetMaxFieldSize(int max)Sets the limit for the maximum number of bytes in aResultSetSets 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.<T> Tunwrap(java.lang.Class<T> iface)Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
-
-
-
Field Detail
-
RETURN_PRIMARY_KEYS
public static final int RETURN_PRIMARY_KEYS
- See Also:
- Constant Field Values
-
-
Method Detail
-
executeQuery
public java.sql.ResultSet executeQuery(java.lang.String sql) throws java.sql.SQLExceptionExecutes the given SQL statement, which returns a singleResultSetobject.Note:This method cannot be called on a
PreparedStatementorCallableStatement.HSQLDB-Specific Information:
This method should not be used for statements other than SELECT queries.From 2.0, HSQLDB throws an exception when the statement is a DDL statement or an UPDATE or DELETE statement.
- Specified by:
executeQueryin interfacejava.sql.Statement- Parameters:
sql- an SQL statement to be sent to the database, typically a static SQLSELECTstatement- Returns:
- a
ResultSetobject that contains the data produced by the given query; nevernull - Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the given SQL statement produces anything other than a singleResultSetobject, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement
-
executeUpdate
public int executeUpdate(java.lang.String sql) throws java.sql.SQLExceptionExecutes the given SQL statement, which may be anINSERT,UPDATE, orDELETEstatement or an SQL statement that returns nothing, such as an SQL DDL statement.Note:This method cannot be called on a
PreparedStatementorCallableStatement.- Specified by:
executeUpdatein interfacejava.sql.Statement- Parameters:
sql- an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the given SQL statement produces aResultSetobject, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement
-
close
public void close() throws java.sql.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 interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.sql.Statement- Throws:
java.sql.SQLException- if a database access error occurs
-
getMaxFieldSize
public int getMaxFieldSize() throws java.sql.SQLExceptionRetrieves 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.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB always returns zero, meaning there is no limit.- Specified by:
getMaxFieldSizein interfacejava.sql.Statement- Returns:
- the current column size limit for columns storing character and binary values; zero means there is no limit
- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
setMaxFieldSize(int)
-
setMaxFieldSize
public void setMaxFieldSize(int max) throws java.sql.SQLExceptionSets the limit for the maximum number of bytes in aResultSetSets 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.HSQLDB-Specific Information:
To present, calls to this method are simply ignored; HSQLDB always stores the full number of bytes when dealing with any of the field types mentioned above. These types all have an absolute maximum element upper bound determined by the Java array index limit java.lang.Integer.MAX_VALUE. For XXXBINARY types, this translates to Integer.MAX_VALUE bytes. For XXXCHAR types, this translates to 2 * Integer.MAX_VALUE bytes (2 bytes / character).In practice, field sizes are limited to values much smaller than the absolute maximum element upper bound, in particular due to limits imposed on the maximum available Java heap memory.
- Specified by:
setMaxFieldSizein interfacejava.sql.Statement- Parameters:
max- the new column size limit in bytes; zero means there is no limit- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionmax >= 0is not satisfied- See Also:
getMaxFieldSize()
-
getMaxRows
public int getMaxRows() throws java.sql.SQLExceptionRetrieves 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 interfacejava.sql.Statement- Returns:
- the current maximum number of rows for a
ResultSetobject produced by thisStatementobject; zero means there is no limit - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
setMaxRows(int)
-
setMaxRows
public void setMaxRows(int max) throws java.sql.SQLExceptionSets 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 interfacejava.sql.Statement- Parameters:
max- the new max rows limit; zero means there is no limit- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionmax >= 0is not satisfied- See Also:
getMaxRows()
-
setEscapeProcessing
public void setEscapeProcessing(boolean enable) throws java.sql.SQLExceptionSets 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.The
ConnectionandDataSourcepropertyescapeProcessingmay be used to change the default escape processing behavior. A value of true (the default) enables escape Processing for allStatementobjects. A value of false disables escape processing for allStatementobjects. ThesetEscapeProcessingmethod may be used to specify the escape processing behavior for an individualStatementobject.Note: Since prepared statements have usually been parsed prior to making this call, disabling escape processing for
PreparedStatementsobjects will have no effect.- Specified by:
setEscapeProcessingin interfacejava.sql.Statement- Parameters:
enable-trueto enable escape processing;falseto disable it- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement
-
getQueryTimeout
public int getQueryTimeout() throws java.sql.SQLExceptionRetrieves the number of seconds the driver will wait for aStatementobject to execute. If the limit is exceeded, aSQLExceptionis thrown.HSQLDB-Specific Information:
To present, HSQLDB always returns zero, meaning there is no limit.- Specified by:
getQueryTimeoutin interfacejava.sql.Statement- Returns:
- the current query timeout limit in seconds; zero means there is no limit
- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
setQueryTimeout(int)
-
setQueryTimeout
public void setQueryTimeout(int seconds) throws java.sql.SQLExceptionSets the number of seconds the driver will wait for aStatementobject to execute to the given number of seconds. By default there is no limit on the amount of time allowed for a running statement to complete. If the limit is exceeded, anSQLTimeoutExceptionis thrown. A JDBC driver must apply this limit to theexecute,executeQueryandexecuteUpdatemethods.Note: JDBC driver implementations may also apply this limit to
ResultSetmethods (consult your driver vendor documentation for details).Note: In the case of
Statementbatching, it is implementation defined as to whether the time-out is applied to individual SQL commands added via theaddBatchmethod or to the entire batch of SQL commands invoked by theexecuteBatchmethod (consult your driver vendor documentation for details).HSQLDB-Specific Information:
The maximum number of seconds to wait is 32767.- Specified by:
setQueryTimeoutin interfacejava.sql.Statement- Parameters:
seconds- the new query timeout limit in seconds; zero means there is no limit- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionseconds >= 0is not satisfied- See Also:
getQueryTimeout()
-
cancel
public void cancel() throws java.sql.SQLExceptionCancels 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.HSQLDB-Specific Information:
HSQLDB version 2.3.4 and later supports aborting an SQL query or data update statement.- Specified by:
cancelin interfacejava.sql.Statement- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method
-
getWarnings
public java.sql.SQLWarning getWarnings() throws java.sql.SQLExceptionRetrieves 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.HSQLDB-Specific Information:
In 2.0, HSQLDB may produces Statement warnings; this method always returns null.- Specified by:
getWarningsin interfacejava.sql.Statement- Returns:
- the first
SQLWarningobject ornullif there are no warnings - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement
-
clearWarnings
public void clearWarnings() throws java.sql.SQLExceptionClears all the warnings reported on thisStatementobject. After a call to this method, the methodgetWarningswill returnnulluntil a new warning is reported for thisStatementobject.HSQLDB-Specific Information:
In HSQLDB 2.0,SQLWarningobjects may be produced for Statement Objects; calls to this method clear the warnings.- Specified by:
clearWarningsin interfacejava.sql.Statement- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement
-
setCursorName
public void setCursorName(java.lang.String name) throws java.sql.SQLExceptionSets 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 ensure 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.HSQLDB-Specific Information:
Including 2.0, HSQLDB does not support named cursors; calls to this method are ignored.- Specified by:
setCursorNamein interfacejava.sql.Statement- Parameters:
name- the new cursor name, which must be unique within a connection- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method
-
execute
public boolean execute(java.lang.String sql) throws java.sql.SQLExceptionExecutes the given SQL statement, which may return multiple results. 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, andgetMoreResultsto move to any subsequent result(s).Note:This method cannot be called on a
PreparedStatementorCallableStatement.- Specified by:
executein interfacejava.sql.Statement- Parameters:
sql- any SQL statement- Returns:
trueif the first result is aResultSetobject;falseif it is an update count or there are no results- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- See Also:
getResultSet(),getUpdateCount(),getMoreResults()
-
getResultSet
public java.sql.ResultSet getResultSet() throws java.sql.SQLExceptionRetrieves the current result as aResultSetobject. This method should be called only once per result.HSQLDB-Specific Information:
- Specified by:
getResultSetin interfacejava.sql.Statement- Returns:
- the current result as a
ResultSetobject ornullif the result is an update count or there are no more results - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
execute(java.lang.String)
-
getUpdateCount
public int getUpdateCount() throws java.sql.SQLExceptionRetrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned. This method should be called only once per result.- Specified by:
getUpdateCountin interfacejava.sql.Statement- Returns:
- the current result as an update count; -1 if the current result is a
ResultSetobject or there are no more results - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
execute(java.lang.String)
-
getMoreResults
public boolean getMoreResults() throws java.sql.SQLExceptionMoves to thisStatementobject's next result, returnstrueif it is aResultSetobject, and implicitly closes any currentResultSetobject(s) obtained with the methodgetResultSet.There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))- Specified by:
getMoreResultsin interfacejava.sql.Statement- Returns:
trueif the next result is aResultSetobject;falseif it is an update count or there are no more results- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
execute(java.lang.String)
-
setFetchDirection
public void setFetchDirection(int direction) throws java.sql.SQLExceptionGives the driver a hint as to the direction in which rows will be processed inResultSetobjects 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.HSQLDB-Specific Information:
HSQLDB accepts all valid parameters.- Specified by:
setFetchDirectionin interfacejava.sql.Statement- Parameters:
direction- the initial direction for processing rows- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the given direction is not one ofResultSet.FETCH_FORWARD,ResultSet.FETCH_REVERSE, orResultSet.FETCH_UNKNOWN- Since:
- JDK 1.2
- See Also:
getFetchDirection()
-
getFetchDirection
public int getFetchDirection() throws java.sql.SQLExceptionRetrieves 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.HSQLDB-Specific Information:
HSQLDB returns the fetch direction.- Specified by:
getFetchDirectionin interfacejava.sql.Statement- Returns:
- the default fetch direction for result sets generated
from this
Statementobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
- See Also:
setFetchDirection(int)
-
setFetchSize
public void setFetchSize(int rows) throws java.sql.SQLExceptionGives 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.HSQLDB-Specific Information:
HSQLDB uses the specified value as a hint, but may process more or fewer rows than specified.- Specified by:
setFetchSizein interfacejava.sql.Statement- Parameters:
rows- the number of rows to fetch- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionrows >= 0is not satisfied.- Since:
- JDK 1.2
- See Also:
getFetchSize()
-
getFetchSize
public int getFetchSize() throws java.sql.SQLExceptionRetrieves 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.HSQLDB-Specific InformationHSQLDB returns 0 by default, or the fetch size specified by setFetchSize
- Specified by:
getFetchSizein interfacejava.sql.Statement- Returns:
- the default fetch size for result sets generated
from this
Statementobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
- See Also:
setFetchSize(int)
-
getResultSetConcurrency
public int getResultSetConcurrency() throws java.sql.SQLExceptionRetrieves the result set concurrency forResultSetobjects generated by thisStatementobject.HSQLDB-Specific Information:
HSQLDB supportsCONCUR_READ_ONLYandCONCUR_UPDATABLEconcurrency.- Specified by:
getResultSetConcurrencyin interfacejava.sql.Statement- Returns:
- either
ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
-
getResultSetType
public int getResultSetType() throws java.sql.SQLExceptionRetrieves the result set type forResultSetobjects generated by thisStatementobject.HSQLDB-Specific Information:
HSQLDB 1.7.0 and later versions supportTYPE_FORWARD_ONLYandTYPE_SCROLL_INSENSITIVE.- Specified by:
getResultSetTypein interfacejava.sql.Statement- Returns:
- one of
ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
-
addBatch
public void addBatch(java.lang.String sql) throws java.sql.SQLExceptionAdds the given SQL command to the current list of commands for thisStatementobject. The commands in this list can be executed as a batch by calling the methodexecuteBatch.Note:This method cannot be called on a
PreparedStatementorCallableStatement.HSQLDB-Specific Information:
Starting with 1.7.2, this feature is supported.- Specified by:
addBatchin interfacejava.sql.Statement- Parameters:
sql- typically this is a SQLINSERTorUPDATEstatement- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the driver does not support batch updates, the method is called on aPreparedStatementorCallableStatement- Since:
- JDK 1.2
- See Also:
executeBatch(),DatabaseMetaData.supportsBatchUpdates()
-
clearBatch
public void clearBatch() throws java.sql.SQLExceptionEmpties thisStatementobject's current list of SQL commands.NOTE: Support of an ability to batch updates is optional.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported.- Specified by:
clearBatchin interfacejava.sql.Statement- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the driver does not support batch updates- Since:
- JDK 1.2
- See Also:
addBatch(java.lang.String),DatabaseMetaData.supportsBatchUpdates()
-
executeBatch
public int[] executeBatch() throws java.sql.SQLExceptionSubmits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Theintelements of the array that is returned are ordered to correspond to the commands 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 unknownIf one of the commands 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 commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the methodBatchUpdateException.getUpdateCountswill contain as many elements as there are commands 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 commands 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 process commands in a batch update after a
BatchUpdateExceptionobject has been thrown.HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported.HSQLDB stops execution of commands in a batch when one of the commands results in an exception. The size of the returned array equals the number of commands that were executed successfully.
- Specified by:
executeBatchin interfacejava.sql.Statement- 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 commands were added to the batch.
- Throws:
java.sql.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 commands sent to the database fails to execute properly or attempts to return a result set.java.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- JDK 1.3
- See Also:
addBatch(java.lang.String),DatabaseMetaData.supportsBatchUpdates()
-
getConnection
public java.sql.Connection getConnection() throws java.sql.SQLExceptionRetrieves theConnectionobject that produced thisStatementobject.- Specified by:
getConnectionin interfacejava.sql.Statement- Returns:
- the connection that produced this statement
- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.2
-
getMoreResults
public boolean getMoreResults(int current) throws java.sql.SQLExceptionMoves 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.There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))HSQLDB-Specific Information:
HSQLDB moves to the next ResultSet and returns the correct result.- Specified by:
getMoreResultsin interfacejava.sql.Statement- 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:
java.sql.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_RESULTSjava.sql.SQLFeatureNotSupportedException- ifDatabaseMetaData.supportsMultipleOpenResultsreturnsfalseand eitherStatement.KEEP_CURRENT_RESULTorStatement.CLOSE_ALL_RESULTSare supplied as the argument.- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
execute(java.lang.String)
-
getGeneratedKeys
public java.sql.ResultSet getGeneratedKeys() throws java.sql.SQLExceptionRetrieves 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.
HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports this feature with single-row and multi-row insert, update and merge statements.This method returns a result set only if the executeUpdate methods that was used is one of the three methods that have the extra parameter indicating return of generated keys
If the executeUdate method did not specify the columns which represent the auto-generated keys the IDENTITY column or GENERATED column(s) of the table are returned.
The executeUpdate methods with column indexes or column names return the post-insert or post-update values of the specified columns, whether the columns are generated or not. This allows values that have been modified by execution of triggers to be returned.
If column names or indexes provided by the user in the executeUpdate() method calls do not correspond to table columns (incorrect names or indexes larger than the column count), an empty result is returned.
- Specified by:
getGeneratedKeysin interfacejava.sql.Statement- Returns:
- a
ResultSetobject containing the auto-generated key(s) generated by the execution of thisStatementobject - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
executeUpdate
public int executeUpdate(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLExceptionExecutes 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).HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns with single-row and multi-row INSERT, UPDATE and MERGE statements.If the table has an IDENTITY or GENERATED column(s) the values for these columns are returned in the next call to getGeneratedKeys(). HSQLDB also supports returning primary key values from the rows by using the
org.hsqldb.jdbc.JDBCStatement.RETURN_PRIMARY_KEYSconstant.- Specified by:
executeUpdatein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the given SQL statement returns aResultSetobject, the given constant is not one of those allowed, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYSjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- JDK 1.4, HSQLDB 1.7.0
-
executeUpdate
public int executeUpdate(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLExceptionExecutes 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).Note:This method cannot be called on a
PreparedStatementorCallableStatement.HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns with single-row and multi-row INSERT, UPDATE and MERGE statements.The columnIndexes may specify any set of columns of the table.
- Specified by:
executeUpdatein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the SQL statement returns aResultSetobject, the second argument supplied to this method is not anintarray whose elements are valid column indexes, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this methodjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- JDK 1.4, HSQLDB 1.7.0
-
executeUpdate
public int executeUpdate(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLExceptionExecutes 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).Note:This method cannot be called on a
PreparedStatementorCallableStatement.HSQLDB-Specific Information:
Starting with version 2.0, HSQLDB supports returning generated columns with single-row and multi-row INSERT, UPDATE and MERGE statements.The columnNames may specify any set of columns of the table.
- Specified by:
executeUpdatein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the SQL statement returns aResultSetobject, the second argument supplied to this method is not aStringarray whose elements are valid column names, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this methodjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- JDK 1.4, HSQLDB 1.7
-
execute
public boolean execute(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLExceptionExecutes 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 anINSERTstatement, 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, andgetMoreResultsto move to any subsequent result(s).Note:This method cannot be called on a
PreparedStatementorCallableStatement.HSQLDB-Specific Information:
Starting with 2.0, HSQLDB supports this feature. HSQLDB also supports returning primary key values from the rows by using theorg.hsqldb.result.ResultConstants.RETURN_PRIMARY_KEYSconstant.- Specified by:
executein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the second parameter supplied to this method is notStatement.RETURN_GENERATED_KEYSorStatement.NO_GENERATED_KEYS, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYSjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- JDK 1.4, HSQLDB 1.7
- See Also:
getResultSet(),getUpdateCount(),getMoreResults(),getGeneratedKeys()
-
execute
public boolean execute(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLExceptionExecutes 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.
The
executemethod executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSetorgetUpdateCountto retrieve the result, andgetMoreResultsto move to any subsequent result(s).Note:This method cannot be called on a
PreparedStatementorCallableStatement.HSQLDB-Specific Information:
Starting with 2.0, HSQLDB supports this feature.- Specified by:
executein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the elements in theintarray passed to this method are not valid column indexes, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this methodjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- JDK 1.4, HSQLDB 1.7
- See Also:
getResultSet(),getUpdateCount(),getMoreResults()
-
execute
public boolean execute(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLExceptionExecutes 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 anINSERTstatement, 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, andgetMoreResultsto move to any subsequent result(s).Note:This method cannot be called on a
PreparedStatementorCallableStatement.HSQLDB-Specific Information:
Starting with 2.0, HSQLDB supports this feature.- Specified by:
executein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the elements of theStringarray passed to this method are not valid column names, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this methodjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- JDK 1.4, HSQLDB 1.7
- See Also:
getResultSet(),getUpdateCount(),getMoreResults(),getGeneratedKeys()
-
getResultSetHoldability
public int getResultSetHoldability() throws java.sql.SQLExceptionRetrieves the result set holdability forResultSetobjects generated by thisStatementobject.- Specified by:
getResultSetHoldabilityin interfacejava.sql.Statement- Returns:
- either
ResultSet.HOLD_CURSORS_OVER_COMMITorResultSet.CLOSE_CURSORS_AT_COMMIT - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- JDK 1.4, HSQLDB 1.7
-
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.- Specified by:
isClosedin interfacejava.sql.Statement- Returns:
- true if this
Statementobject is closed; false if it is still open - Since:
- JDK 1.6, HSQLDB 2.0
-
setPoolable
public void setPoolable(boolean poolable) throws java.sql.SQLExceptionRequests that aStatementbe pooled or not pooled. The value specified is a hint to the statement pool implementation indicating whether the application 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 interfacejava.sql.Statement- Parameters:
poolable- requests that the statement be pooled if true and that the statement not be pooled if false- Throws:
java.sql.SQLException- if this method is called on a closedStatement- Since:
- JDK 1.6, HSQLDB 2.0
-
isPoolable
public boolean isPoolable() throws java.sql.SQLExceptionReturns a value indicating whether thisStatementwill be closed when all its dependent result sets are closed.- Specified by:
isPoolablein interfacejava.sql.Statement- Returns:
trueif theStatementwill be closed when all of its dependent result sets are closed;falseotherwise- Throws:
java.sql.SQLException- if this method is called on a closedStatement- Since:
- JDK 1.7, HSQLDB 2.0
- See Also:
setPoolable(boolean)
-
unwrap
public <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLExceptionReturns 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 result of callingunwraprecursively 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 interfacejava.sql.Wrapper- 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:
java.sql.SQLException- If no object found that implements the interface- Since:
- JDK 1.6, HSQLDB 2.0
-
isWrapperFor
public boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLExceptionReturns 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 interfacejava.sql.Wrapper- Parameters:
iface- a Class defining an interface.- Returns:
- true if this implements the interface or directly or indirectly wraps an object that does.
- Throws:
java.sql.SQLException- if an error occurs while determining whether this is a wrapper for an object with the given interface.- Since:
- JDK 1.6, HSQLDB 2.0
-
getLargeUpdateCount
public long getLargeUpdateCount() throws java.sql.SQLExceptionRetrieves the current result as an update count; if the result is aResultSetobject or there are no more results, -1 is returned. This method should be called only once per result.This method should be used when the returned row count may exceed
Integer.MAX_VALUE.The default implementation will throw
UnsupportedOperationException- Specified by:
getLargeUpdateCountin interfacejava.sql.Statement- Returns:
- the current result as an update count; -1 if the current result
is a
ResultSetobject or there are no more results - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- 1.8
- See Also:
execute(java.lang.String)
-
setLargeMaxRows
public void setLargeMaxRows(long max) throws java.sql.SQLExceptionSets 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.This method should be used when the row limit may exceed
Integer.MAX_VALUE.The default implementation will throw
UnsupportedOperationException- Specified by:
setLargeMaxRowsin interfacejava.sql.Statement- Parameters:
max- the new max rows limit; zero means there is no limit- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatementor the conditionmax >= 0is not satisfied- Since:
- 1.8
- See Also:
getMaxRows()
-
getLargeMaxRows
public long getLargeMaxRows() throws java.sql.SQLExceptionRetrieves the maximum number of rows that aResultSetobject produced by thisStatementobject can contain. If this limit is exceeded, the excess rows are silently dropped.This method should be used when the returned row limit may exceed
Integer.MAX_VALUE.The default implementation will return
0- Specified by:
getLargeMaxRowsin interfacejava.sql.Statement- Returns:
- the current maximum number of rows for a
ResultSetobject produced by thisStatementobject; zero means there is no limit - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- Since:
- 1.8
- See Also:
setMaxRows(int)
-
executeLargeBatch
public long[] executeLargeBatch() throws java.sql.SQLExceptionSubmits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Thelongelements of the array that is returned are ordered to correspond to the commands 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 methodexecuteLargeBatchmay 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 unknownIf one of the commands 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 commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the methodBatchUpdateException.getLargeUpdateCountswill contain as many elements as there are commands 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 commands after a command fails
This method should be used when the returned row count may exceed
Integer.MAX_VALUE.The default implementation will throw
UnsupportedOperationException- Specified by:
executeLargeBatchin interfacejava.sql.Statement- 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 commands were added to the batch.
- Throws:
java.sql.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 commands sent to the database fails to execute properly or attempts to return a result set.java.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- 1.8
- See Also:
addBatch(java.lang.String),DatabaseMetaData.supportsBatchUpdates()
-
executeLargeUpdate
public long executeLargeUpdate(java.lang.String sql) throws java.sql.SQLExceptionExecutes the given SQL statement, which may be anINSERT,UPDATE, orDELETEstatement 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.Note:This method cannot be called on a
PreparedStatementorCallableStatement.The default implementation will throw
UnsupportedOperationException- Specified by:
executeLargeUpdatein interfacejava.sql.Statement- Parameters:
sql- an SQL Data Manipulation Language (DML) statement, such asINSERT,UPDATEorDELETE; or an SQL statement that returns nothing, such as a DDL statement.- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the given SQL statement produces aResultSetobject, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- 1.8
-
executeLargeUpdate
public long executeLargeUpdate(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLExceptionExecutes 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).This method should be used when the returned row count may exceed
Integer.MAX_VALUE.Note:This method cannot be called on a
PreparedStatementorCallableStatement.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
executeLargeUpdatein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the given SQL statement returns aResultSetobject, the given constant is not one of those allowed, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYSjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- 1.8
-
executeLargeUpdate
public long executeLargeUpdate(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLExceptionExecutes 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).This method should be used when the returned row count may exceed
Integer.MAX_VALUE.Note:This method cannot be called on a
PreparedStatementorCallableStatement.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
executeLargeUpdatein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the SQL statement returns aResultSetobject,the second argument supplied to this method is not anintarray whose elements are valid column indexes, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this methodjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- 1.8
-
executeLargeUpdate
public long executeLargeUpdate(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLExceptionExecutes 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).This method should be used when the returned row count may exceed
Integer.MAX_VALUE.Note:This method cannot be called on a
PreparedStatementorCallableStatement.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
executeLargeUpdatein interfacejava.sql.Statement- 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:
java.sql.SQLException- if a database access error occurs, this method is called on a closedStatement, the SQL statement returns aResultSetobject, the second argument supplied to this method is not aStringarray whose elements are valid column names, the method is called on aPreparedStatementorCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this methodjava.sql.SQLTimeoutException- when the driver has determined that the timeout value that was specified by thesetQueryTimeoutmethod has been exceeded and has at least attempted to cancel the currently runningStatement- Since:
- 1.8
-
getResultSetScrollability
public int getResultSetScrollability()
-
closeOnCompletion
public void closeOnCompletion() throws java.sql.SQLExceptionSpecifies that thisStatementwill be closed when all its dependent result sets are closed. If execution of theStatementdoes not produce any result sets, this method has no effect.Note: Multiple calls to
closeOnCompletiondo not toggle the effect on thisStatement. However, a call tocloseOnCompletiondoes effect both the subsequent execution of statements, and statements that currently have open, dependent, result sets.- Throws:
java.sql.SQLException- if this method is called on a closedStatement- Since:
- JDK 1.7, HSQLDB 2.0.1
-
isCloseOnCompletion
public boolean isCloseOnCompletion() throws java.sql.SQLExceptionReturns a value indicating whether thisStatementwill be closed when all its dependent result sets are closed.- Returns:
trueif theStatementwill be closed when all of its dependent result sets are closed;falseotherwise- Throws:
java.sql.SQLException- if this method is called on a closedStatement- Since:
- JDK 1.7, HSQLDB 2.0.1
-
-