Class jdbcStatement
- java.lang.Object
-
- org.hsqldb.jdbc.jdbcStatement
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,java.sql.Statement
,java.sql.Wrapper
- Direct Known Subclasses:
jdbcPreparedStatement
public class jdbcStatement extends java.lang.Object implements java.sql.Statement
The object used for executing a static SQL statement and returning the results it produces.By default, only one
ResultSet
object perStatement
object can be open at the same time. Therefore, if the reading of oneResultSet
object is interleaved with the reading of another, each must have been generated by differentStatement
objects. All execution methods in theStatement
interface implicitly close a statment's currentResultSet
object if an open one exists.HSQLDB-Specific Information:
JRE 1.1.x Notes:
In general, JDBC 2 support requires Java 1.2 and above, and JDBC3 requires Java 1.4 and above. In HSQLDB, support for methods introduced in different versions of JDBC depends on the JDK version used for compiling and building HSQLDB.
Since 1.7.0, all JDBC 2 methods can be called while executing under the version 1.1.x Java Runtime EnvironmentTM. However, in addition to this technique requiring explicit casts to the org.hsqldb.jdbcXXX classes, some of these method calls require
int
values that are defined only in the JDBC 2 or greater version of theResultSet
interface. For this reason these values are defined injdbcResultSet
.In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the JDBC2-only
ResultSet
values can be achieved by referring to them in parameter specifications and return value comparisons, respectively, as follows:jdbcResultSet.FETCH_FORWARD jdbcResultSet.TYPE_FORWARD_ONLY jdbcResultSet.TYPE_SCROLL_INSENSITIVE jdbcResultSet.CONCUR_READ_ONLY //etc.
However, please note that code written to use HSQLDB JDBC 2 features under JDK 1.1.x will not be compatible for use with other JDBC 2 drivers. Please also note that this feature is offered solely as a convenience to developers who must work under JDK 1.1.x due to operating constraints, yet wish to use some of the more advanced features available under the JDBC 2 specification.
(fredt@users)
(boucherb@users)- Author:
- boucherb@users, fredt@user
- See Also:
jdbcConnection.createStatement()
,jdbcResultSet
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addBatch(java.lang.String sql)
Adds the given SQL command to the current list of commmands for thisStatement
object.void
cancel()
Cancels thisStatement
object if both the DBMS and driver support aborting an SQL statement.void
clearBatch()
Empties thisStatement
object's current list of SQL commands.void
clearWarnings()
Clears all the warnings reported on thisStatement
object.void
close()
Releases thisStatement
object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.void
closeOnCompletion()
boolean
execute(java.lang.String sql)
Executes the given SQL statement, which may return multiple results.boolean
execute(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.boolean
execute(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.boolean
execute(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.java.sql.ResultSet
executeQuery(java.lang.String sql)
Executes the given SQL statement, which returns a singleResultSet
object.int
executeUpdate(java.lang.String sql)
Executes the given SQL statement, which may be anINSERT
,UPDATE
, orDELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statement.int
executeUpdate(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 thisStatement
object should be made available for retrieval.int
executeUpdate(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.int
executeUpdate(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.Connection
getConnection()
Retrieves theConnection
object that produced thisStatement
object.int
getFetchDirection()
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatement
object.int
getFetchSize()
Retrieves the number of result set rows that is the default fetch size forResultSet
objects generated from thisStatement
object.java.sql.ResultSet
getGeneratedKeys()
Retrieves any auto-generated keys created as a result of executing thisStatement
object.int
getMaxFieldSize()
Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object.int
getMaxRows()
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain.boolean
getMoreResults()
Moves to thisStatement
object's next result, returnstrue
if it is aResultSet
object, and implicitly closes any currentResultSet
object(s) obtained with the methodgetResultSet
.boolean
getMoreResults(int current)
Moves to thisStatement
object's next result, deals with any currentResultSet
object(s) according to the instructions specified by the given flag, and returnstrue
if the next result is aResultSet
object.int
getQueryTimeout()
Retrieves the number of seconds the driver will wait for aStatement
object to execute.java.sql.ResultSet
getResultSet()
Retrieves the current result as aResultSet
object.int
getResultSetConcurrency()
Retrieves the result set concurrency forResultSet
objects generated by thisStatement
object.int
getResultSetHoldability()
Retrieves the result set holdability forResultSet
objects generated by thisStatement
object.int
getResultSetType()
Retrieves the result set type forResultSet
objects generated by thisStatement
object.int
getUpdateCount()
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned.java.sql.SQLWarning
getWarnings()
Retrieves the first warning reported by calls on thisStatement
object.boolean
isClosed()
Retrieves whether this statement is closed.boolean
isCloseOnCompletion()
boolean
isPoolable()
boolean
isWrapperFor(java.lang.Class<?> iface)
void
setCursorName(java.lang.String name)
Sets the SQL cursor name to the givenString
, which will be used by subsequentStatement
objectexecute
methods.void
setEscapeProcessing(boolean enable)
Sets escape processing on or off.void
setFetchDirection(int direction)
Gives the driver a hint as to the direction in which rows will be processed inResultSet
objects created using thisStatement
object.void
setFetchSize(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.void
setMaxFieldSize(int max)
Sets the limit for the maximum number of bytes in aResultSet
column storing character or binary values to the given number of bytes.void
setMaxRows(int max)
Sets the limit for the maximum number of rows that anyResultSet
object can contain to the given number.void
setPoolable(boolean poolable)
void
setQueryTimeout(int seconds)
Sets the number of seconds the driver will wait for aStatement
object to execute to the given number of seconds.<T> T
unwrap(java.lang.Class<T> iface)
-
-
-
Method Detail
-
executeQuery
public java.sql.ResultSet executeQuery(java.lang.String sql) throws java.sql.SQLException
Executes the given SQL statement, which returns a singleResultSet
object.HSQLDB-Specific Information:
This method should not be used for statements other than SELECT queries.
Including 1.7.2, HSQLDB does not throw an exception when the statement is a DDL statement or an UPDATE or DELETE statement. This will certainly change in future version.
- Specified by:
executeQuery
in interfacejava.sql.Statement
- Parameters:
sql
- an SQL statement to be sent to the database, typically a static SQLSELECT
statement- Returns:
- a
ResultSet
object that contains the data produced by the given query; nevernull
- Throws:
java.sql.SQLException
- if a database access error occurs or the given SQL statement produces anything other than a singleResultSet
object
-
executeUpdate
public int executeUpdate(java.lang.String sql) throws java.sql.SQLException
Executes the given SQL statement, which may be anINSERT
,UPDATE
, orDELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statement.- Specified by:
executeUpdate
in interfacejava.sql.Statement
- Parameters:
sql
- an SQLINSERT
,UPDATE
orDELETE
statement or an SQL statement that returns nothing- Returns:
- either the row count for
INSERT
,UPDATE
orDELETE
statements, or0
for SQL statements that return nothing - Throws:
java.sql.SQLException
- if a database access error occurs or the given SQL statement produces aResultSet
object
-
close
public void close() throws java.sql.SQLException
Releases thisStatement
object'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
close
on aStatement
object that is already closed has no effect.Note: A
Statement
object is automatically closed when it is garbage collected. When aStatement
object is closed, its currentResultSet
object, if one exists, is also closed.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.sql.Statement
- Throws:
java.sql.SQLException
- if a database access error occurs
-
getMaxFieldSize
public int getMaxFieldSize() throws java.sql.SQLException
Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARY
,CHAR
,VARCHAR
, andLONGVARCHAR
columns. 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:
getMaxFieldSize
in 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- See Also:
setMaxFieldSize(int)
-
setMaxFieldSize
public void setMaxFieldSize(int max) throws java.sql.SQLException
Sets the limit for the maximum number of bytes in aResultSet
column storing character or binary values to the given number of bytes. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARY
,CHAR
,VARCHAR
, andLONGVARCHAR
fields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.HSQLDB-Specific Information:
Including 1.7.2, 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)
- Specified by:
setMaxFieldSize
in 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 or the condition max >= 0 is not satisfied- See Also:
getMaxFieldSize()
-
getMaxRows
public int getMaxRows() throws java.sql.SQLException
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain. If this limit is exceeded, the excess rows are silently dropped.- Specified by:
getMaxRows
in interfacejava.sql.Statement
- Returns:
- the current maximum number of rows for a
ResultSet
object produced by thisStatement
object; zero means there is no limit - Throws:
java.sql.SQLException
- if a database access error occurs- See Also:
setMaxRows(int)
-
setMaxRows
public void setMaxRows(int max) throws java.sql.SQLException
Sets the limit for the maximum number of rows that anyResultSet
object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.- Specified by:
setMaxRows
in 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 or the condition max >= 0 is not satisfied- See Also:
getMaxRows()
-
setEscapeProcessing
public void setEscapeProcessing(boolean enable) throws java.sql.SQLException
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 forPreparedStatements
objects will have no effect.- Specified by:
setEscapeProcessing
in interfacejava.sql.Statement
- Parameters:
enable
-true
to enable escape processing;false
to disable it- Throws:
java.sql.SQLException
- if a database access error occurs
-
getQueryTimeout
public int getQueryTimeout() throws java.sql.SQLException
Retrieves the number of seconds the driver will wait for aStatement
object to execute. If the limit is exceeded, anSQLException
is thrown.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB always returns zero, meaning there is no limit.
- Specified by:
getQueryTimeout
in 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- See Also:
setQueryTimeout(int)
-
setQueryTimeout
public void setQueryTimeout(int seconds) throws java.sql.SQLException
Sets the number of seconds the driver will wait for aStatement
object to execute to the given number of seconds. If the limit is exceeded, anSQLException
is thrown.HSQLDB-Specific Information:
Including 1.7.2, calls to this method are ignored; HSQLDB waits an unlimited amount of time for statement execution requests to return.
- Specified by:
setQueryTimeout
in 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 or the condition seconds >= 0 is not satisfied- See Also:
getQueryTimeout()
-
cancel
public void cancel() throws java.sql.SQLException
Cancels thisStatement
object 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:
Including 1.7.2, HSQLDB does not support aborting a SQL statement; calls to this method are ignored.
- Specified by:
cancel
in interfacejava.sql.Statement
- Throws:
java.sql.SQLException
- if a database access error occurs
-
getWarnings
public java.sql.SQLWarning getWarnings() throws java.sql.SQLException
Retrieves the first warning reported by calls on thisStatement
object. SubsequentStatement
object warnings will be chained to thisSQLWarning
object.The warning chain is automatically cleared each time a statement is (re)executed. This method may not be called on a closed
Statement
object; doing so will cause anSQLException
to be thrown.Note: If you are processing a
ResultSet
object, any warnings associated with reads on thatResultSet
object will be chained on it rather than on theStatement
object that produced it.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB never produces Statement warnings; this method always returns null.
- Specified by:
getWarnings
in interfacejava.sql.Statement
- Returns:
- the first
SQLWarning
object ornull
if there are no warnings - Throws:
java.sql.SQLException
- if a database access error occurs or this method is called on a closed statement
-
clearWarnings
public void clearWarnings() throws java.sql.SQLException
Clears all the warnings reported on thisStatement
object. After a call to this method, the methodgetWarnings
will returnnull
until a new warning is reported for thisStatement
object.HSQLDB-Specific Information:
Including HSQLDB 1.7.2,
SQLWarning
objects are never produced for Statement Objects; calls to this method are ignored.- Specified by:
clearWarnings
in interfacejava.sql.Statement
- Throws:
java.sql.SQLException
- if a database access error occurs
-
setCursorName
public void setCursorName(java.lang.String name) throws java.sql.SQLException
Sets the SQL cursor name to the givenString
, which will be used by subsequentStatement
objectexecute
methods. This name can then be used in SQL positioned update or delete statements to identify the current row in theResultSet
object 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'sSELECT
statement should have the formSELECT FOR UPDATE
. IfFOR UPDATE
is not present, positioned updates may fail.Note: By definition, the execution of positioned updates and deletes must be done by a different
Statement
object than the one that generated theResultSet
object being used for positioning. Also, cursor names must be unique within a connection.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB does not support named cursors, updateable results or table locking via
SELECT FOR UPDATE
; calls to this method are ignored.- Specified by:
setCursorName
in 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
-
execute
public boolean execute(java.lang.String sql) throws java.sql.SQLException
Executes 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
execute
method executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).- Specified by:
execute
in interfacejava.sql.Statement
- Parameters:
sql
- any SQL statement- Returns:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
java.sql.SQLException
- if a database access error occurs- See Also:
getResultSet()
,getUpdateCount()
,getMoreResults()
-
getResultSet
public java.sql.ResultSet getResultSet() throws java.sql.SQLException
Retrieves the current result as aResultSet
object. This method should be called only once per result.HSQLDB-Specific Information:
Without an interceding call to executeXXX, each invocation of this method will produce a new, initialized ResultSet instance referring to the current result, if any.
- Specified by:
getResultSet
in interfacejava.sql.Statement
- Returns:
- the current result as a
ResultSet
object ornull
if the result is an update count or there are no more results - Throws:
java.sql.SQLException
- if a database access error occurs- See Also:
execute(java.lang.String)
-
getUpdateCount
public int getUpdateCount() throws java.sql.SQLException
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned. This method should be called only once per result.- Specified by:
getUpdateCount
in interfacejava.sql.Statement
- Returns:
- the current result as an update count; -1 if the current result is a
ResultSet
object or there are no more results - Throws:
java.sql.SQLException
- if a database access error occurs- See Also:
execute(java.lang.String)
-
getMoreResults
public boolean getMoreResults() throws java.sql.SQLException
Moves to thisStatement
object's next result, returnstrue
if it is aResultSet
object, and implicitly closes any currentResultSet
object(s) obtained with the methodgetResultSet
.There are no more results when the following is true:
(!getMoreResults() && (getUpdateCount() == -1)
- Specified by:
getMoreResults
in interfacejava.sql.Statement
- Returns:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
java.sql.SQLException
- if a database access error occurs- See Also:
execute(java.lang.String)
-
setFetchDirection
public void setFetchDirection(int direction) throws java.sql.SQLException
Gives the driver a hint as to the direction in which rows will be processed inResultSet
objects created using thisStatement
object. The default value isResultSet.FETCH_FORWARD
.Note that this method sets the default fetch direction for result sets generated by this
Statement
object. Each result set has its own methods for getting and setting its own fetch direction.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB supports only
FETCH_FORWARD
.Setting any other value will throw an
SQLException
stating that the operation is not supported.- Specified by:
setFetchDirection
in interfacejava.sql.Statement
- Parameters:
direction
- the initial direction for processing rows- Throws:
java.sql.SQLException
- if a database access error occurs or the given direction is not one ofResultSet.FETCH_FORWARD
,ResultSet.FETCH_REVERSE
, orResultSet.FETCH_UNKNOWN
HSQLDB throws for all values except
FETCH_FORWARD
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
- See Also:
getFetchDirection()
-
getFetchDirection
public int getFetchDirection() throws java.sql.SQLException
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatement
object. If thisStatement
object has not set a fetch direction by calling the methodsetFetchDirection
, the return value is implementation-specific.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB always returns FETCH_FORWARD.
- Specified by:
getFetchDirection
in interfacejava.sql.Statement
- Returns:
- the default fetch direction for result sets generated
from this
Statement
object - Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
- See Also:
setFetchDirection(int)
-
setFetchSize
public void setFetchSize(int rows) throws java.sql.SQLException
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. The number of rows specified affects only result sets created using this statement. If the value specified is zero, then the hint is ignored. The default value is zero.HSQLDB-Specific Information:
Including 1.7.2, calls to this method are ignored; HSQLDB fetches each result completely as part of executing its statement.
- Specified by:
setFetchSize
in interfacejava.sql.Statement
- Parameters:
rows
- the number of rows to fetch- Throws:
java.sql.SQLException
- if a database access error occurs, or the condition 0 <=rows
<=this.getMaxRows()
is not satisfied.HSQLDB never throws an exception, since calls to this method are always ignored.
- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
- See Also:
getFetchSize()
-
getFetchSize
public int getFetchSize() throws java.sql.SQLException
Retrieves the number of result set rows that is the default fetch size forResultSet
objects generated from thisStatement
object. If thisStatement
object has not set a fetch size by calling the methodsetFetchSize
, the return value is implementation-specific.HSQLDB-Specific InformationIncluding 1.7.2, this method always returns 0. HSQLDB fetches each result completely as part of executing its statement
- Specified by:
getFetchSize
in interfacejava.sql.Statement
- Returns:
- the default fetch size for result sets generated
from this
Statement
object - Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
- See Also:
setFetchSize(int)
-
getResultSetConcurrency
public int getResultSetConcurrency() throws java.sql.SQLException
Retrieves the result set concurrency forResultSet
objects generated by thisStatement
object.HSQLDB-Specific Information:
Including 1.7.2, HSQLDB supports only
CONCUR_READ_ONLY
concurrency.- Specified by:
getResultSetConcurrency
in interfacejava.sql.Statement
- Returns:
- either
ResultSet.CONCUR_READ_ONLY
orResultSet.CONCUR_UPDATABLE
(not supported) - Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
-
getResultSetType
public int getResultSetType() throws java.sql.SQLException
Retrieves the result set type forResultSet
objects generated by thisStatement
object.HSQLDB-Specific Information:
HSQLDB 1.7.0 and later versions support
TYPE_FORWARD_ONLY
andTYPE_SCROLL_INSENSITIVE
.- Specified by:
getResultSetType
in interfacejava.sql.Statement
- Returns:
- one of
ResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
(not supported)Note: Up to and including 1.7.1, HSQLDB never returns
TYPE_SCROLL_SENSITIVE
- Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
-
addBatch
public void addBatch(java.lang.String sql) throws java.sql.SQLException
Adds the given SQL command to the current list of commmands for thisStatement
object. The commands in this list can be executed as a batch by calling the methodexecuteBatch
.NOTE: This method is optional.
HSQLDB-Specific Information:
Starting with 1.7.2, this feature is supported.
- Specified by:
addBatch
in interfacejava.sql.Statement
- Parameters:
sql
- typically this is a static SQLINSERT
orUPDATE
statement- Throws:
java.sql.SQLException
- if a database access error occurs, or the driver does not support batch updates- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
- See Also:
executeBatch()
-
clearBatch
public void clearBatch() throws java.sql.SQLException
Empties thisStatement
object's current list of SQL commands.NOTE: This method is optional.
HSQLDB-Specific Information:
Starting with HSQLDB 1.7.2, this feature is supported.
- Specified by:
clearBatch
in interfacejava.sql.Statement
- Throws:
java.sql.SQLException
- if a database access error occurs or the driver does not support batch updates- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
- See Also:
addBatch(java.lang.String)
-
executeBatch
public int[] executeBatch() throws java.sql.SQLException
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Theint
elements 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 methodexecuteBatch
may 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.getUpdateCounts
will 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
A driver is not required to implement this method. The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to proccess commands in a batch update after a
BatchUpdateException
obejct 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.
When the product is built under the JAVA1 target, an exception is never thrown and it is the responsibility of the client software to check the size of the returned update count array to determine if any batch items failed. To build and run under the JAVA2 target, JDK/JRE 1.3 or higher must be used.
- Specified by:
executeBatch
in 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 or the driver does not support batch statements. ThrowsBatchUpdateException
(a subclass ofjava.sql.SQLException
) if one of the commands sent to the database fails to execute properly or attempts to return a result set.- Since:
- JDK 1.3 (JDK 1.1.x developers: read the new overview for jdbcStatement)
-
getConnection
public java.sql.Connection getConnection() throws java.sql.SQLException
Retrieves theConnection
object that produced thisStatement
object.- Specified by:
getConnection
in interfacejava.sql.Statement
- Returns:
- the connection that produced this statement
- Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.2 (JDK 1.1.x developers: read the new overview for jdbcStatement)
-
getMoreResults
public boolean getMoreResults(int current) throws java.sql.SQLException
Moves to thisStatement
object's next result, deals with any currentResultSet
object(s) according to the instructions specified by the given flag, and returnstrue
if the next result is aResultSet
object.There are no more results when the following is true:
(!getMoreResults() && (getUpdateCount() == -1)
HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException
, stating that the function is not supported.- Specified by:
getMoreResults
in interfacejava.sql.Statement
- Parameters:
current
- one of the followingStatement
constants indicating what should happen to currentResultSet
objects obtained using the methodgetResultSetCLOSE_CURRENT_RESULT
,KEEP_CURRENT_RESULT
, orCLOSE_ALL_RESULTS
- Returns:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.4, HSQLDB 1.7
- See Also:
execute(java.lang.String)
-
getGeneratedKeys
public java.sql.ResultSet getGeneratedKeys() throws java.sql.SQLException
Retrieves any auto-generated keys created as a result of executing thisStatement
object. If thisStatement
object did not generate any keys, an emptyResultSet
object is returned.HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException
, stating that the function is not supported.- Specified by:
getGeneratedKeys
in interfacejava.sql.Statement
- Returns:
- a
ResultSet
object containing the auto-generated key(s) generated by the execution of thisStatement
object - Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.4, HSQLDB 1.7
-
executeUpdate
public int executeUpdate(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLException
Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatement
object should be made available for retrieval.HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException
, stating that the function is not supported.- Specified by:
executeUpdate
in interfacejava.sql.Statement
- Parameters:
sql
- must be an SQLINSERT
,UPDATE
orDELETE
statement or an SQL statement that returns nothingautoGeneratedKeys
- 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:
- either the row count for
INSERT
,UPDATE
orDELETE
statements, or0
for SQL statements that return nothing - Throws:
java.sql.SQLException
- if a database access error occurs, the given SQL statement returns aResultSet
object, or the given constant is not one of those allowed- Since:
- JDK 1.4, HSQLDB 1.7
-
executeUpdate
public int executeUpdate(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLException
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. The driver will ignore the array if the SQL statement is not anINSERT
statement.HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException
, stating that the function is not supported.- Specified by:
executeUpdate
in interfacejava.sql.Statement
- Parameters:
sql
- an SQLINSERT
,UPDATE
orDELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statementcolumnIndexes
- an array of column indexes indicating the columns that should be returned from the inserted row- Returns:
- either the row count for
INSERT
,UPDATE
, orDELETE
statements, or 0 for SQL statements that return nothing - Throws:
java.sql.SQLException
- if a database access error occurs or the SQL statement returns aResultSet
object- Since:
- JDK 1.4, HSQLDB 1.7
-
executeUpdate
public int executeUpdate(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLException
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. The driver will ignore the array if the SQL statement is not anINSERT
statement.HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException
, stating that the function is not supported.- Specified by:
executeUpdate
in interfacejava.sql.Statement
- Parameters:
sql
- an SQLINSERT
,UPDATE
orDELETE
statement or an SQL statement that returns nothingcolumnNames
- an array of the names of the columns that should be returned from the inserted row- Returns:
- either the row count for
INSERT
,UPDATE
, orDELETE
statements, or 0 for SQL statements that return nothing - Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.4, HSQLDB 1.7
-
execute
public boolean execute(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLException
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 anINSERT
statement.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
execute
method executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException
, stating that the function is not supported.- Specified by:
execute
in 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_KEYS
orStatement.NO_GENERATED_KEYS
- Returns:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
java.sql.SQLException
- if a database access error occurs- 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.SQLException
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 given SQL statement is not anINSERT
statement.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
execute
method executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException
, stating that the function is not supported.- Specified by:
execute
in 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:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
java.sql.SQLException
- if a database access error occurs- 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.SQLException
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 given SQL statement is not anINSERT
statement.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
execute
method executes an SQL statement and indicates the form of the first result. You must then use the methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).HSQLDB-Specific Information:
HSQLDB 1.7.2 does not support this feature.
Calling this method always throws an
SQLException
, stating that the function is not supported.- Specified by:
execute
in 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:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.4, HSQLDB 1.7
- See Also:
getResultSet()
,getUpdateCount()
,getMoreResults()
,getGeneratedKeys()
-
getResultSetHoldability
public int getResultSetHoldability() throws java.sql.SQLException
Retrieves the result set holdability forResultSet
objects generated by thisStatement
object.HSQLDB-Specific Information:
Starting with 1.7.2, this method returns HOLD_CURSORS_OVER_COMMIT
- Specified by:
getResultSetHoldability
in interfacejava.sql.Statement
- Returns:
- either
ResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
- Throws:
java.sql.SQLException
- if a database access error occurs- Since:
- JDK 1.4, HSQLDB 1.7
-
isClosed
public boolean isClosed()
Retrieves whether this statement is closed.- Specified by:
isClosed
in interfacejava.sql.Statement
-
setPoolable
public void setPoolable(boolean poolable) throws java.sql.SQLException
- Specified by:
setPoolable
in interfacejava.sql.Statement
- Throws:
java.sql.SQLException
-
isPoolable
public boolean isPoolable() throws java.sql.SQLException
- Specified by:
isPoolable
in interfacejava.sql.Statement
- Throws:
java.sql.SQLException
-
unwrap
public <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLException
- Specified by:
unwrap
in interfacejava.sql.Wrapper
- Throws:
java.sql.SQLException
-
isWrapperFor
public boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLException
- Specified by:
isWrapperFor
in interfacejava.sql.Wrapper
- Throws:
java.sql.SQLException
-
isCloseOnCompletion
public boolean isCloseOnCompletion() throws java.sql.SQLException
- Specified by:
isCloseOnCompletion
in interfacejava.sql.Statement
- Throws:
java.sql.SQLException
-
closeOnCompletion
public void closeOnCompletion() throws java.sql.SQLException
- Specified by:
closeOnCompletion
in interfacejava.sql.Statement
- Throws:
java.sql.SQLException
-
-