org.hsqldb.jdbc.JDBCStatement
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class JDBCStatement
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 statment's current
ResultSet object if an open one exists.
From version 2.0, the implementation meets the JDBC specification requirment that any existing ResultSet is closed when execute() or executeQuery() methods are called.
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.jdbc.* classes, some of these method calls require
int values that are defined only in the JDBC 2 or greater
version of the ResultSet interface. For this
reason these values are defined in JDBCResultSet.
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)
JDBCConnection.createStatement(),
JDBCResultSet| Field Summary |
|---|
| Fields inherited from interface java.sql.Statement |
|---|
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO |
| Method Summary | ||
|---|---|---|
void |
addBatch(String sql)
Adds the given SQL command to the current list of commmands 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(String sql)
Executes the given SQL statement, which may return multiple results. |
|
boolean |
execute(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(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(String sql,
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. |
|
ResultSet |
executeQuery(String sql)
Executes the given SQL statement, which returns a single ResultSet object. |
|
int |
executeUpdate(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(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(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(String sql,
String[] columnNames)
Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. |
|
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. |
|
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. |
|
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. |
|
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(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(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 genrated 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. |
|
|
unwrap(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. |
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public ResultSet executeQuery(String sql)
throws 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 Statementsql - an SQL statement to be sent to the database, typically a
static SQL SELECT statement
ResultSet object that contains the data produced
by the given query; never null
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 object
public int executeUpdate(String sql)
throws SQLException
INSERT,
UPDATE, or DELETE statement or an
SQL statement that returns nothing, such as an SQL DDL statement.
executeUpdate in interface Statementsql - (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.
SQLException - if a database access error occurs,
this method is called on a closed Statement or the given
SQL statement produces a ResultSet object
public void close()
throws 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 StatementSQLException - if a database access error occurs
public int getMaxFieldSize()
throws 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 StatementSQLException - if a database access error occurs or
this method is called on a closed StatementsetMaxFieldSize(int)
public void setMaxFieldSize(int max)
throws 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 Statementmax - the new column size limit in bytes; zero means there is no limit
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 SQLException
ResultSet object produced by this
Statement object can contain. If this limit is exceeded,
the excess rows are silently dropped.
getMaxRows in interface StatementResultSet
object produced by this Statement object;
zero means there is no limit
SQLException - if a database access error occurs or
this method is called on a closed StatementsetMaxRows(int)
public void setMaxRows(int max)
throws 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 Statementmax - the new max rows limit; zero means there is no limit
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 SQLException
PreparedStatements objects will have no effect.
setEscapeProcessing in interface Statementenable - true to enable escape processing;
false to disable it
SQLException - if a database access error occurs or
this method is called on a closed Statement
public int getQueryTimeout()
throws 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 StatementSQLException - if a database access error occurs or
this method is called on a closed StatementsetQueryTimeout(int)
public void setQueryTimeout(int seconds)
throws 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 value is Short.MAX_VALUE. The minimum is 0, indicating no limit. In version 2.0, calls to this method are ignored; HSQLDB waits an unlimited amount of time for statement execution requests to return.
setQueryTimeout in interface Statementseconds - the new query timeout limit in seconds; zero means
there is no limit
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 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.
Including 2.0, HSQLDB does not support aborting an SQL statement; calls to this method are ignored.
cancel in interface StatementSQLException - if a database access error occurs or
this method is called on a closed Statement
SQLFeatureNotSupportedException - if the JDBC driver does not support
this method
public SQLWarning getWarnings()
throws 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 StatementSQLWarning object or null
if there are no warnings
SQLException - if a database access error occurs or
this method is called on a closed Statement
public void clearWarnings()
throws 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 StatementSQLException - if a database access error occurs or
this method is called on a closed Statement
public void setCursorName(String name)
throws 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 Statementname - the new cursor name, which must be unique within
a connection
SQLException - if a database access error occurs or
this method is called on a closed Statement
SQLFeatureNotSupportedException - if the JDBC driver does not support this method
public boolean execute(String sql)
throws 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 Statementsql - any SQL statement
true if the first result is a ResultSet
object; false if it is an update count or there are
no results
SQLException - if a database access error occurs or
this method is called on a closed StatementgetResultSet(),
getUpdateCount(),
getMoreResults()
public ResultSet getResultSet()
throws SQLException
ResultSet object.
This method should be called only once per result.
getResultSet in interface StatementResultSet object or
null if the result is an update count or there are no more results
SQLException - if a database access error occurs or
this method is called on a closed Statementexecute(java.lang.String)
public int getUpdateCount()
throws SQLException
ResultSet object or there are no more results, -1
is returned. This method should be called only once per result.
getUpdateCount in interface StatementResultSet object or there are no more results
SQLException - if a database access error occurs or
this method is called on a closed Statementexecute(java.lang.String)
public boolean getMoreResults()
throws 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 Statementtrue if the next result is a ResultSet
object; false if it is an update count or there are
no more results
SQLException - if a database access error occurs or
this method is called on a closed Statementexecute(java.lang.String)
public void setFetchDirection(int direction)
throws 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 Statementdirection - the initial direction for processing rows
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_UNKNOWNgetFetchDirection()
public int getFetchDirection()
throws 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 StatementStatement object
SQLException - if a database access error occurs or
this method is called on a closed StatementsetFetchDirection(int)
public void setFetchSize(int rows)
throws SQLException
ResultSet objects genrated 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 Statementrows - the number of rows to fetch
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 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 StatementStatement object
SQLException - if a database access error occurs or
this method is called on a closed StatementsetFetchSize(int)
public int getResultSetConcurrency()
throws SQLException
ResultSet objects
generated by this Statement object.
HSQLDB supports CONCUR_READ_ONLY and
CONCUR_UPDATABLE concurrency.
getResultSetConcurrency in interface StatementResultSet.CONCUR_READ_ONLY or
ResultSet.CONCUR_UPDATABLE
SQLException - if a database access error occurs or
this method is called on a closed Statement
public int getResultSetType()
throws 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 StatementResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
SQLException - if a database access error occurs or
this method is called on a closed Statementpublic void addBatch(String sql) throws 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.
sql - typically this is a SQL INSERT or
UPDATE statement
(:JDBC4 modified)
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 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 StatementSQLException - 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 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 proccess commands in a batch
update after a BatchUpdateException obejct 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.
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.
executeBatch in interface StatementSQLException - 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 Connection getConnection() throws SQLException
Connection object
that produced this Statement object.
getConnection in interface StatementSQLException - if a database access error occurs or
this method is called on a closed Statement
public boolean getMoreResults(int current)
throws 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 Statementcurrent - 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 results
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_RESULTSexecute(java.lang.String)public ResultSet getGeneratedKeys() throws 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 executeUpaged 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 coloum count), an empty result is returned.
getGeneratedKeys in interface StatementResultSet object containing the auto-generated key(s)
generated by the execution of this Statement object
SQLException - if a database access error occurs or
this method is called on a closed Statement
SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic int executeUpdate(String sql, int autoGeneratedKeys) throws 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 Statementsql - 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
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 allowed
SQLFeatureNotSupportedException - if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYSpublic int executeUpdate(String sql, int[] columnIndexes) throws 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 Statementsql - 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 row
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 indexes
SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic int executeUpdate(String sql, String[] columnNames) throws 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 Statementsql - 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 row
INSERT, UPDATE,
or DELETE statements, or 0 for SQL statements
that return nothing
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 names
SQLFeatureNotSupportedException - if the JDBC driver does not support this methodpublic boolean execute(String sql, int autoGeneratedKeys) throws 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.
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 results
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.
SQLFeatureNotSupportedException - if the JDBC driver does not support
this method with a constant of Statement.RETURN_GENERATED_KEYSgetResultSet(),
getUpdateCount(),
getMoreResults(),
getGeneratedKeys()public boolean execute(String sql, int[] columnIndexes) throws 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.
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 results
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 indexes
SQLFeatureNotSupportedException - if the JDBC driver does not support this methodgetResultSet(),
getUpdateCount(),
getMoreResults()public boolean execute(String sql, String[] columnNames) throws 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.
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 results
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 names
SQLFeatureNotSupportedException - if the JDBC driver does not support this methodgetResultSet(),
getUpdateCount(),
getMoreResults(),
getGeneratedKeys()
public int getResultSetHoldability()
throws SQLException
ResultSet objects
generated by this Statement object.
Starting with 1.7.2, this method returns HOLD_CURSORS_OVER_COMMIT
getResultSetHoldability in interface StatementResultSet.HOLD_CURSORS_OVER_COMMIT or
ResultSet.CLOSE_CURSORS_AT_COMMIT
SQLException - if a database access error occurs or
this method is called on a closed Statement
public boolean isClosed()
throws 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.
Statement object is closed; false if it is still open
SQLException - if a database access error occurs
public void setPoolable(boolean poolable)
throws SQLException
Statement be pooled or not pooled. The value
specified is a hint to the statement pool implementation indicating
whether the applicaiton wants the statement to be pooled. It is up to
the statement pool manager as to whether the hint is used.
The poolable value of a statement is applicable to both internal statement caches implemented by the driver and external statement caches implemented by application servers and other applications.
By default, a Statement is not poolable when created, and
a PreparedStatement and CallableStatement
are poolable when created.
setPoolable in interface Statementpoolable - requests that the statement be pooled if true and
that the statement not be pooled if false
SQLException - if this method is called on a closed
Statement
public boolean isPoolable()
throws SQLException
Statement
is poolable or not.
isPoolable in interface Statementtrue if the Statement
is poolable; false otherwise
SQLException - if this method is called on a closed
Statement
setPoolable(boolean)public <T> T unwrap(Class<T> iface) throws 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.
iface - A Class defining an interface that the result must implement.
SQLException - If no object found that implements the interfacepublic boolean isWrapperFor(Class<?> iface) throws 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 Wrapperiface - a Class defining an interface.
SQLException - if an error occurs while determining whether this is a wrapper
for an object with the given interface.
public void closeOnCompletion()
throws 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.
SQLException - if this method is called on a closed
Statement
public boolean isCloseOnCompletion()
throws 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 otherwise
SQLException - if this method is called on a closed
Statement
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||