public class JDBCStatement
extends java.lang.Object
implements java.sql.Statement, java.sql.Wrapper
The object used for executing a static SQL statement and returning the results it produces.
By default, only one ResultSet
object per Statement
object can be open at the same time. Therefore, if the reading of one
ResultSet
object is interleaved
with the reading of another, each must have been generated by
different Statement
objects. All execution methods in the
Statement
interface implicitly close a statement's current
ResultSet
object if an open one exists.
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 when the HSQLDB jar is compiled with JDK 8.
(fredt@users)
(campbell-burnet@users)
JDBCConnection.createStatement()
,
JDBCResultSet
Modifier and Type | Method and Description |
---|---|
void |
addBatch(java.lang.String sql)
Adds the given SQL command to the current list of commands for this
Statement object. |
void |
cancel()
Cancels this
Statement object if both the DBMS and
driver support aborting an SQL statement. |
void |
clearBatch()
Empties this
Statement object's current list of
SQL commands. |
void |
clearWarnings()
Clears all the warnings reported on this
Statement
object. |
void |
close()
Releases this
Statement object's database
and JDBC resources immediately instead of waiting for
this to happen when it is automatically closed. |
void |
closeOnCompletion()
Specifies that this
Statement will be closed when all its
dependent result sets are closed. |
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 single
ResultSet object. |
int |
executeUpdate(java.lang.String sql)
Executes the given SQL statement, which may be an
INSERT ,
UPDATE , or DELETE statement or an
SQL statement that returns nothing, such as an SQL DDL statement. |
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 this
Statement 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 the
Connection object
that produced this Statement object. |
int |
getFetchDirection()
Retrieves the direction for fetching rows from
database tables that is the default for result sets
generated from this
Statement object. |
int |
getFetchSize()
Retrieves the number of result set rows that is the default
fetch size for
ResultSet objects
generated from this Statement object. |
java.sql.ResultSet |
getGeneratedKeys()
Retrieves any auto-generated keys created as a result of executing this
Statement object. |
int |
getMaxFieldSize()
Retrieves the maximum number of bytes that can be
returned for character and binary column values in a
ResultSet
object produced by this Statement object. |
int |
getMaxRows()
Retrieves the maximum number of rows that a
ResultSet object produced by this
Statement object can contain. |
boolean |
getMoreResults()
Moves to this
Statement object's next result, returns
true if it is a ResultSet object, and
implicitly closes any current ResultSet
object(s) obtained with the method getResultSet . |
boolean |
getMoreResults(int current)
Moves to this
Statement object's next result, deals with
any current ResultSet object(s) according to the instructions
specified by the given flag, and returns
true if the next result is a ResultSet object. |
int |
getQueryTimeout()
Retrieves the number of seconds the driver will
wait for a
Statement object to execute. |
java.sql.ResultSet |
getResultSet()
Retrieves the current result as a
ResultSet object. |
int |
getResultSetConcurrency()
Retrieves the result set concurrency for
ResultSet objects
generated by this Statement object. |
int |
getResultSetHoldability()
Retrieves the result set holdability for
ResultSet objects
generated by this Statement object. |
int |
getResultSetType()
Retrieves the result set type for
ResultSet objects
generated by this Statement object. |
int |
getUpdateCount()
Retrieves the current result as an update count;
if the result is a
ResultSet object or there are no more results, -1
is returned. |
java.sql.SQLWarning |
getWarnings()
Retrieves the first warning reported by calls on this
Statement object. |
boolean |
isClosed()
Retrieves whether this
Statement object has been closed. |
boolean |
isCloseOnCompletion()
Returns a value indicating whether this
Statement will be
closed when all its dependent result sets are closed. |
boolean |
isPoolable()
Returns a value indicating whether the
Statement
is poolable or not. |
boolean |
isWrapperFor(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.
|
void |
setCursorName(java.lang.String name)
Sets the SQL cursor name to the given
String , which
will be used by subsequent Statement object
execute 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 in
ResultSet
objects created using this Statement object. |
void |
setFetchSize(int rows)
(JDBC4 clarification:)
Gives the JDBC driver a hint as to the number of rows that should
be fetched from the database when more rows are needed for
ResultSet objects generated by this Statement . |
void |
setMaxFieldSize(int max)
(JDBC4 clarification:) Sets the limit for the maximum number of bytes in a
ResultSet
Sets the limit for the maximum number of bytes that can be returned for
character and binary column values in a ResultSet
object produced by this Statement object. |
void |
setMaxRows(int max)
(JDBC4 clarification:)
Sets the limit for the maximum number of rows that any
ResultSet object generated by this Statement
object can contain to the given number. |
void |
setPoolable(boolean poolable)
Requests that a
Statement be pooled or not pooled. |
void |
setQueryTimeout(int seconds)
Sets the number of seconds the driver will wait for a
Statement object to execute to the given number of seconds. |
<T> T |
unwrap(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.
|
public java.sql.ResultSet executeQuery(java.lang.String sql) throws java.sql.SQLException
ResultSet
object.
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.
executeQuery
in interface java.sql.Statement
sql
- an SQL statement to be sent to the database, typically a
static SQL SELECT
statementResultSet
object that contains the data produced
by the given query; never null
java.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the given
SQL statement produces anything other than a single
ResultSet
objectpublic int executeUpdate(java.lang.String sql) throws java.sql.SQLException
INSERT
,
UPDATE
, or DELETE
statement or an
SQL statement that returns nothing, such as an SQL DDL statement.
executeUpdate
in interface java.sql.Statement
sql
- (JDBC4 clarification:) an SQL Data Manipulation Language (DML) statement, such as INSERT
, UPDATE
or
DELETE
; or an SQL statement that returns nothing,
such as a DDL statement.java.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the given
SQL statement produces a ResultSet
objectpublic void close() throws java.sql.SQLException
Statement
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 a Statement
object that is already closed has no effect.
Note:When a Statement
object is
closed, its current ResultSet
object, if one exists, is
also closed.
(JDBC4 deleted:) [A Statement
object is
automatically closed when it is garbage collected.]
close
in interface java.lang.AutoCloseable
close
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurspublic int getMaxFieldSize() throws java.sql.SQLException
ResultSet
object produced by this Statement
object.
This limit applies only to BINARY
, VARBINARY
,
LONGVARBINARY
, CHAR
, VARCHAR
,
(JDBC4 new:) NCHAR
, NVARCHAR
, LONGNVARCHAR
and LONGVARCHAR
columns. If the limit is exceeded, the
excess data is silently discarded.
Including 1.7.2, HSQLDB always returns zero, meaning there is no limit.
getMaxFieldSize
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
setMaxFieldSize(int)
public void setMaxFieldSize(int max) throws java.sql.SQLException
ResultSet
Sets the limit for the maximum number of bytes that can be returned for
character and binary column values in a ResultSet
object produced by this Statement
object.
This limit applies
only to BINARY
, VARBINARY
,
LONGVARBINARY
, CHAR
, VARCHAR
,
(JDBC4 new:) NCHAR
, NVARCHAR
, LONGNVARCHAR
and
LONGVARCHAR
fields. If the limit is exceeded, the excess data
is silently discarded. For maximum portability, use values
greater than 256.
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.
setMaxFieldSize
in interface java.sql.Statement
max
- the new column size limit in bytes; zero means there is no limitjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the condition max >= 0
is not satisfiedgetMaxFieldSize()
public int getMaxRows() throws java.sql.SQLException
ResultSet
object produced by this
Statement
object can contain. If this limit is exceeded,
the excess rows are silently dropped.
getMaxRows
in interface java.sql.Statement
ResultSet
object produced by this Statement
object;
zero means there is no limitjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
setMaxRows(int)
public void setMaxRows(int max) throws java.sql.SQLException
ResultSet
object generated by this Statement
object can contain to the given number.
If the limit is exceeded, the excess
rows are silently dropped.
setMaxRows
in interface java.sql.Statement
max
- the new max rows limit; zero means there is no limitjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the condition max >= 0
is not satisfiedgetMaxRows()
public void setEscapeProcessing(boolean enable) throws java.sql.SQLException
PreparedStatements
objects will have no effect.
setEscapeProcessing
in interface java.sql.Statement
enable
- true
to enable escape processing;
false
to disable itjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
public int getQueryTimeout() throws java.sql.SQLException
Statement
object to execute.
If the limit is exceeded, a
SQLException
is thrown.
To present, HSQLDB always returns zero, meaning there is no limit.
getQueryTimeout
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
setQueryTimeout(int)
public void setQueryTimeout(int seconds) throws java.sql.SQLException
Statement
object to execute to the given number of seconds.
If the limit is exceeded, an SQLException
is thrown. A JDBC
(JDBC4 clarification:)
driver must apply this limit to the execute
,
executeQuery
and executeUpdate
methods. JDBC driver
implementations may also apply this limit to ResultSet
methods
(consult your driver vendor documentation for details).
The maximum number of seconds to wait is 32767.
setQueryTimeout
in interface java.sql.Statement
seconds
- the new query timeout limit in seconds; zero means
there is no limitjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the condition seconds >= 0
is not satisfiedgetQueryTimeout()
public void cancel() throws java.sql.SQLException
Statement
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 version 2.3.4 and later supports aborting an SQL query or data update statement.
cancel
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.sql.SQLWarning getWarnings() throws java.sql.SQLException
Statement
object.
Subsequent Statement
object warnings will be chained to this
SQLWarning
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 an SQLException
to be thrown.
Note: If you are processing a ResultSet
object, any
warnings associated with reads on that ResultSet
object
will be chained on it rather than on the Statement
object that produced it.
In 2.0, HSQLDB may produces Statement warnings; this method always returns null.
getWarnings
in interface java.sql.Statement
SQLWarning
object or null
if there are no warningsjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
public void clearWarnings() throws java.sql.SQLException
Statement
object. After a call to this method,
the method getWarnings
will return
null
until a new warning is reported for this
Statement
object.
In HSQLDB 2.0, SQLWarning
objects may
be produced for Statement Objects; calls to this method clear the warnings.
clearWarnings
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
public void setCursorName(java.lang.String name) throws java.sql.SQLException
String
, which
will be used by subsequent Statement
object
execute
methods. This name can then be
used in SQL positioned update or delete statements to identify the
current row in the ResultSet
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's SELECT
statement
should have the form SELECT FOR UPDATE
. If
FOR 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 the ResultSet
object being used for
positioning. Also, cursor names must be unique within a connection.
Including 2.0, HSQLDB does not support named cursors; calls to this method are ignored.
setCursorName
in interface java.sql.Statement
name
- the new cursor name, which must be unique within
a connectionjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic boolean execute(java.lang.String sql) throws java.sql.SQLException
The execute
method executes an SQL statement and indicates the
form of the first result. You must then use the methods
getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to
move to any subsequent result(s).
execute
in interface java.sql.Statement
sql
- any SQL statementtrue
if the first result is a ResultSet
object; false
if it is an update count or there are
no resultsjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
getResultSet()
,
getUpdateCount()
,
getMoreResults()
public java.sql.ResultSet getResultSet() throws java.sql.SQLException
ResultSet
object.
This method should be called only once per result.
getResultSet
in interface java.sql.Statement
ResultSet
object or
null
if the result is an update count or there are no more resultsjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
execute(java.lang.String)
public int getUpdateCount() throws java.sql.SQLException
ResultSet
object or there are no more results, -1
is returned. This method should be called only once per result.
getUpdateCount
in interface java.sql.Statement
ResultSet
object or there are no more resultsjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
execute(java.lang.String)
public boolean getMoreResults() throws java.sql.SQLException
Statement
object's next result, returns
true
if it is a ResultSet
object, and
implicitly closes any current ResultSet
object(s) obtained with the method getResultSet
.
There are no more results when the following is true:
// stmt is a Statement object
((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
getMoreResults
in interface java.sql.Statement
true
if the next result is a ResultSet
object; false
if it is an update count or there are
no more resultsjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
execute(java.lang.String)
public void setFetchDirection(int direction) throws java.sql.SQLException
ResultSet
objects created using this Statement
object. The
default value is ResultSet.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 accepts all valid parameters.
setFetchDirection
in interface java.sql.Statement
direction
- the initial direction for processing rowsjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the given direction
is not one of ResultSet.FETCH_FORWARD
,
ResultSet.FETCH_REVERSE
, or ResultSet.FETCH_UNKNOWN
getFetchDirection()
public int getFetchDirection() throws java.sql.SQLException
Statement
object.
If this Statement
object has not set
a fetch direction by calling the method setFetchDirection
,
the return value is implementation-specific.
HSQLDB returns the fetch direction.
getFetchDirection
in interface java.sql.Statement
Statement
objectjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
setFetchDirection(int)
public void setFetchSize(int rows) throws java.sql.SQLException
ResultSet
objects generated by this Statement
.
If the value specified is zero, then the hint is ignored.
The default value is zero.
HSQLDB uses the specified value as a hint, but may process more or fewer rows than specified.
setFetchSize
in interface java.sql.Statement
rows
- the number of rows to fetchjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the
(JDBC4 modified:)
condition rows >= 0
is not satisfied.getFetchSize()
public int getFetchSize() throws java.sql.SQLException
ResultSet
objects
generated from this Statement
object.
If this Statement
object has not set
a fetch size by calling the method setFetchSize
,
the return value is implementation-specific.
HSQLDB returns 0 by default, or the fetch size specified by setFetchSize
getFetchSize
in interface java.sql.Statement
Statement
objectjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
setFetchSize(int)
public int getResultSetConcurrency() throws java.sql.SQLException
ResultSet
objects
generated by this Statement
object.
HSQLDB supports CONCUR_READ_ONLY
and
CONCUR_UPDATABLE
concurrency.
getResultSetConcurrency
in interface java.sql.Statement
ResultSet.CONCUR_READ_ONLY
or
ResultSet.CONCUR_UPDATABLE
java.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
public int getResultSetType() throws java.sql.SQLException
ResultSet
objects
generated by this Statement
object.
HSQLDB 1.7.0 and later versions support TYPE_FORWARD_ONLY
and TYPE_SCROLL_INSENSITIVE
.
getResultSetType
in interface java.sql.Statement
ResultSet.TYPE_FORWARD_ONLY
,
ResultSet.TYPE_SCROLL_INSENSITIVE
, or
ResultSet.TYPE_SCROLL_SENSITIVE
java.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
public void addBatch(java.lang.String sql) throws java.sql.SQLException
Statement
object. The commands in this list can be
executed as a batch by calling the method executeBatch
.
(JDBC4 clarification:)
NOTE: Support of an ability to batch updates is optional.
Starting with 1.7.2, this feature is supported.
addBatch
in interface java.sql.Statement
sql
- typically this is a SQL INSERT
or
UPDATE
statement
(:JDBC4 modified)java.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the
driver does not support batch updatesexecuteBatch()
public void clearBatch() throws java.sql.SQLException
Statement
object's current list of
SQL commands.
(JDBC4 clarification:)
NOTE: Support of an ability to batch updates is optional.
Starting with HSQLDB 1.7.2, this feature is supported.
clearBatch
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the
driver does not support batch updatesaddBatch(java.lang.String)
public int[] executeBatch() throws java.sql.SQLException
int
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 method executeBatch
may be one of the following:
SUCCESS_NO_INFO
-- indicates that the command was
processed successfully but that the number of rows affected is
unknown
If 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 method
BatchUpdateException.getUpdateCounts
will contain as many elements as there are commands in the batch, and
at least one of the elements will be the following:
EXECUTE_FAILED
-- indicates that the command failed
to execute successfully and occurs only if a driver continues to
process commands after a command fails
(JDBC4 clarification:)
NOTE: Support of an ability to batch updates is optional.
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 BatchUpdateException
object has been thrown.
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.
executeBatch
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the
driver does not support batch statements. Throws BatchUpdateException
(a subclass of SQLException
) if one of the commands sent to the
database fails to execute properly or attempts to return a result set.addBatch(java.lang.String)
,
DatabaseMetaData.supportsBatchUpdates()
public java.sql.Connection getConnection() throws java.sql.SQLException
Connection
object
that produced this Statement
object.
getConnection
in interface java.sql.Statement
java.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
public boolean getMoreResults(int current) throws java.sql.SQLException
Statement
object's next result, deals with
any current ResultSet
object(s) according to the instructions
specified by the given flag, and returns
true
if the next result is a ResultSet
object.
There are no more results when the following is true:
// stmt is a Statement object
((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
HSQLDB moves to the next ResultSet and returns the correct result.
getMoreResults
in interface java.sql.Statement
current
- one of the following Statement
constants indicating what should happen to current
ResultSet
objects obtained using the method
getResultSet
:
Statement.CLOSE_CURRENT_RESULT
,
Statement.KEEP_CURRENT_RESULT
, or
Statement.CLOSE_ALL_RESULTS
true
if the next result is a ResultSet
object; false
if it is an update count or there are no
more resultsjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the argument
supplied is not one of the following:
Statement.CLOSE_CURRENT_RESULT
,
Statement.KEEP_CURRENT_RESULT
, or
Statement.CLOSE_ALL_RESULTS
execute(java.lang.String)
public java.sql.ResultSet getGeneratedKeys() throws java.sql.SQLException
Statement
object. If this Statement
object did
not generate any keys, an empty ResultSet
object is returned.
(JDBC4 clarification:)
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.
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.
getGeneratedKeys
in interface java.sql.Statement
ResultSet
object containing the auto-generated key(s)
generated by the execution of this Statement
objectjava.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic int executeUpdate(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLException
Statement
object
should be made available for retrieval. The driver will ignore the
flag if the SQL statement
is not an INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
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().
executeUpdate
in interface java.sql.Statement
sql
- an SQL Data Manipulation Language (DML) statement, such as INSERT
, UPDATE
or
DELETE
; or an SQL statement that returns nothing,
such as a DDL statement.
(:JDBC4 clarification)autoGeneratedKeys
- 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
java.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
, the given
SQL statement returns a ResultSet
object, or
the given constant is not one of those allowedjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYSpublic int executeUpdate(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLException
INSERT
statement, or an SQL statement able to return
(JDBC 4 clarification)
auto-generated keys (the list of such statements is vendor-specific).
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.
executeUpdate
in interface java.sql.Statement
sql
- an SQL Data Manipulation Language (DML) statement, such as INSERT
, UPDATE
or
DELETE
; or an SQL statement that returns nothing,
such as a DDL statement.
(:JDBC4 clarification)columnIndexes
- an array of column indexes indicating the columns
that should be returned from the inserted rowjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
, the SQL
statement returns a ResultSet
object, or the
second argument supplied to this method is not an int
array
whose elements are valid column indexesjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic int executeUpdate(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLException
INSERT
statement, or an SQL statement able to return
auto-generated keys (the list of such statements is vendor-specific).
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.
executeUpdate
in interface java.sql.Statement
sql
- an SQL Data Manipulation Language (DML) statement, such as INSERT
, UPDATE
or
DELETE
; or an SQL statement that returns nothing,
such as a DDL statement.
(:JDBC4 clarification)columnNames
- an array of the names of the columns that should be
returned from the inserted rowINSERT
, UPDATE
,
or DELETE
statements, or 0 for SQL statements
that return nothingjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
, the SQL
statement returns a ResultSet
object, or the
second argument supplied to this method is not a String
array
whose elements are valid column namesjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodpublic boolean execute(java.lang.String sql, int autoGeneratedKeys) throws java.sql.SQLException
INSERT
statement, or an SQL statement able to return
(JDBC4 clarification)
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 execute
method executes an SQL statement and indicates the
form of the first result. You must then use the methods
getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to
move to any subsequent result(s).
Starting with 2.0, HSQLDB supports this feature.
execute
in interface java.sql.Statement
sql
- any SQL statementautoGeneratedKeys
- a constant indicating whether auto-generated
keys should be made available for retrieval using the method
getGeneratedKeys
; one of the following constants:
Statement.RETURN_GENERATED_KEYS
or
Statement.NO_GENERATED_KEYS
true
if the first result is a ResultSet
object; false
if it is an update count or there are
no resultsjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the second
parameter supplied to this method is not
Statement.RETURN_GENERATED_KEYS
or
Statement.NO_GENERATED_KEYS
.java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYSgetResultSet()
,
getUpdateCount()
,
getMoreResults()
,
getGeneratedKeys()
public boolean execute(java.lang.String sql, int[] columnIndexes) throws java.sql.SQLException
INSERT
statement, 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 execute
method executes an SQL statement and indicates the
form of the first result. You must then use the methods
getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to
move to any subsequent result(s).
Starting with 2.0, HSQLDB supports this feature.
execute
in interface java.sql.Statement
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 method getGeneratedKeys
true
if the first result is a ResultSet
object; false
if it is an update count or there
are no resultsjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the
elements in the int
array passed to this method
are not valid column indexesjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodgetResultSet()
,
getUpdateCount()
,
getMoreResults()
public boolean execute(java.lang.String sql, java.lang.String[] columnNames) throws java.sql.SQLException
INSERT
statement, 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 execute
method executes an SQL statement and indicates the
form of the first result. You must then use the methods
getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to
move to any subsequent result(s).
Starting with 2.0, HSQLDB supports this feature.
execute
in interface java.sql.Statement
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
method getGeneratedKeys
true
if the next result is a ResultSet
object; false
if it is an update count or there
are no more resultsjava.sql.SQLException
- if a database access error occurs,
this method is called on a closed Statement
or the
elements of the String
array passed to this
method are not valid column namesjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodgetResultSet()
,
getUpdateCount()
,
getMoreResults()
,
getGeneratedKeys()
public int getResultSetHoldability() throws java.sql.SQLException
ResultSet
objects
generated by this Statement
object.
getResultSetHoldability
in interface java.sql.Statement
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
java.sql.SQLException
- if a database access error occurs or
this method is called on a closed Statement
public boolean isClosed() throws java.sql.SQLException
Statement
object has been closed. A Statement
is closed if the
method close has been called on it, or if it is automatically closed.isClosed
in interface java.sql.Statement
Statement
object is closed; false if it is still openjava.sql.SQLException
- if a database access error occurspublic void setPoolable(boolean poolable) throws java.sql.SQLException
Statement
be 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 Statement
is not poolable when created, and
a PreparedStatement
and CallableStatement
are poolable when created.
setPoolable
in interface java.sql.Statement
poolable
- requests that the statement be pooled if true and
that the statement not be pooled if false
java.sql.SQLException
- if this method is called on a closed
Statement
public boolean isPoolable() throws java.sql.SQLException
Statement
is poolable or not.
isPoolable
in interface java.sql.Statement
true
if the Statement
is poolable; false
otherwisejava.sql.SQLException
- if this method is called on a closed
Statement
setPoolable(boolean)
public <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLException
unwrap
recursively on the wrapped object
or a proxy for that result. If the receiver is not a
wrapper and does not implement the interface, then an SQLException
is thrown.unwrap
in interface java.sql.Wrapper
iface
- A Class defining an interface that the result must implement.java.sql.SQLException
- If no object found that implements the interfacepublic boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLException
isWrapperFor
on 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 to unwrap
so that
callers can use this method to avoid expensive unwrap
calls that may fail. If this method
returns true then calling unwrap
with the same argument should succeed.isWrapperFor
in interface java.sql.Wrapper
iface
- a Class defining an interface.java.sql.SQLException
- if an error occurs while determining whether this is a wrapper
for an object with the given interface.public void closeOnCompletion() throws java.sql.SQLException
Statement
will be closed when all its
dependent result sets are closed. If execution of the Statement
does not produce any result sets, this method has no effect.
Note: Multiple calls to closeOnCompletion
do
not toggle the effect on this Statement
. However, a call to
closeOnCompletion
does effect both the subsequent execution of
statements, and statements that currently have open, dependent,
result sets.
java.sql.SQLException
- if this method is called on a closed
Statement
public boolean isCloseOnCompletion() throws java.sql.SQLException
Statement
will be
closed when all its dependent result sets are closed.true
if the Statement
will be closed when all
of its dependent result sets are closed; false
otherwisejava.sql.SQLException
- if this method is called on a closed
Statement
Copyright © 2001 - 2017 HSQL Development Group.