|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--org.hsqldb.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.
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, it is possible to build the product so that
all JDBC 2 methods can be called while executing under the version 1.1.x
Java Runtime EnvironmentTM.
However, some of these method calls require
In a JRE 1.1.x environment, calling JDBC 2 methods that take or return the
JDBC2-only
However, please note that code written in such a manner will not be
compatible for use with other JDBC 2 drivers, since they expect and use
(fredt@users)
int values that
are defined only in the JDBC 2 or greater version of
ResultSet interface. For this reason, when the
product is compiled under JDK 1.1.x, these values are defined in
jdbcResultSet.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
ResultSet, rather than jdbcResultSet. Also
note, 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.
(boucherb@users)
jdbcConnection.createStatement(),
jdbcResultSet| Method Summary | |
void |
addBatch(java.lang.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. |
boolean |
execute(java.lang.String sql)
Executes the given SQL statement, which may return multiple results. |
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. |
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. |
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. |
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 |
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. |
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)
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 a ResultSet
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 any ResultSet object can contain to the given number. |
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. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
public java.sql.ResultSet executeQuery(java.lang.String sql)
throws java.sql.SQLException
ResultSet object.
executeQuery in interface java.sql.Statementsql - 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 nulljava.sql.SQLException - if a database access error occurs or the given
SQL statement produces anything other than a single
ResultSet object
public 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.Statementsql - an SQL INSERT, UPDATE or
DELETE statement or an SQL statement that returns nothingINSERT, UPDATE
or DELETE statements, or 0 for SQL statements
that return nothingjava.sql.SQLException - if a database access error occurs or the given
SQL statement produces a ResultSet object
public 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: A Statement object is automatically closed
when it is garbage collected. When a Statement object is
closed, its current ResultSet object, if one exists, is
also closed.
close in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs
public int getMaxFieldSize()
throws java.sql.SQLException
ResultSet
object produced by this Statement object.
This limit applies only to BINARY,
VARBINARY, LONGVARBINARY, CHAR,
VARCHAR, and LONGVARCHAR
columns. If the limit is exceeded, the excess data is silently
discarded.
HSQLDB-Specific Information:
Up to and including 1.7.1, HSQLDB always returns zero, meaning there
is no limit.
getMaxFieldSize in interface java.sql.Statementjava.sql.SQLException - if a database access error occurssetMaxFieldSize(int)
public void setMaxFieldSize(int max)
throws java.sql.SQLException
ResultSet
column storing character or binary values to
the given number of bytes. This limit applies
only to BINARY, VARBINARY,
LONGVARBINARY, CHAR, VARCHAR, and
LONGVARCHAR fields. If the limit is exceeded, the excess data
is silently discarded. For maximum portability, use values
greater than 256.
HSQLDB-Specific Information:
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)
setMaxFieldSize in interface java.sql.Statementmax - the new column size limit in bytes; zero means there is no limitjava.sql.SQLException - if a database access error occurs
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.StatementResultSet
object produced by this Statement object;
zero means there is no limitjava.sql.SQLException - if a database access error occurssetMaxRows(int)
public void setMaxRows(int max)
throws java.sql.SQLException
ResultSet object can contain to the given number.
If the limit is exceeded, the excess
rows are silently dropped.
setMaxRows in interface java.sql.Statementmax - the new max rows limit; zero means there is no limitjava.sql.SQLException - if a database access error occurs
or the condition max >= 0 is not satisfiedgetMaxRows()
public void setEscapeProcessing(boolean enable)
throws java.sql.SQLException
PreparedStatements objects will have no effect.
HSQLDB-Specific Information:
Up to HSQLDB 1.6.1, disabling escape processing for
HSQLDB 1.7.0 follows the standard behaviour.
PreparedStatements objects does have an effect.
setEscapeProcessing in interface java.sql.Statementenable - true to enable escape processing;
false to disable itjava.sql.SQLException - if a database access error occurs
public int getQueryTimeout()
throws java.sql.SQLException
Statement object to execute. If the
limit is exceeded, a SQLException is thrown.
HSQLDB-Specific Information:
Up to and including 1.7.1, HSQLDB always returns zero, meaning there
is no limit.
getQueryTimeout in interface java.sql.Statementjava.sql.SQLException - if a database access error occurssetQueryTimeout(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.
HSQLDB-Specific Information:
Calls to this method are simply ignored; up to and including 1.7.1,
HSQLDB waits an unlimited amount of time for statement execution
requests to return.
setQueryTimeout in interface java.sql.Statementseconds - the new query timeout limit in seconds; zero means
there is no limitjava.sql.SQLException - if a database access error occurs
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-Specific Information:
Up to and including HSQLDB 1.7.0, aborting a SQL statement is
not supported, and calls to this method are simply ignored.
cancel in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs
public 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.
HSQLDB-Specific Information:
Up to and including 1.7.1, HSQLDB never produces warnings and
always returns null.
getWarnings in interface java.sql.StatementSQLWarning 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.
HSQLDB-Specific Information:
Up to and including HSQLDB 1.7.0,
SQLWarning objects are
never produced, and calls to this method are simply ignored.
clearWarnings in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs
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.
HSQLDB-Specific Information:
Up to and including 1.7.1, HSQLDB does not support named cursors,
updateable results or table locking via
SELECT FOR UPDATE, so calls to this method are
simply ignored.
setCursorName in interface java.sql.Statementname - the new cursor name, which must be unique within
a connectionjava.sql.SQLException - if a database access error occurs
public 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.Statementsql - 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 occursgetResultSet(),
getUpdateCount(),
getMoreResults()
public java.sql.ResultSet getResultSet()
throws java.sql.SQLException
ResultSet object.
This method should be called only once per result.
HSQLDB-Specific Information:
Calling this method multiple times returns multiple references
to the same result, if any.
getResultSet in interface java.sql.StatementResultSet object or
null if the result is an update count or there are no more resultsjava.sql.SQLException - if a database access error occursexecute(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.StatementResultSet object or there are no more resultsjava.sql.SQLException - if a database access error occursexecute(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:
(!getMoreResults() && (getUpdateCount() == -1)
HSQLDB-Specific Information:
Up to and including 1.7.1, HSQLDB does not support multiple results.
Calling this method closes the current result (if any) and always
returns false.
getMoreResults in interface java.sql.Statementtrue 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 occursexecute(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-Specific Information:
Up to and including 1.7.1, HSQLDB supports only
Setting any other value will throw a FETCH_FORWARD. SQLException,
stating the the function is not supported.
setFetchDirection in interface java.sql.Statementdirection - the initial direction for processing rowsjava.sql.SQLException - if a database access error occurs
or the given direction
is not one of ResultSet.FETCH_FORWARD,
ResultSet.FETCH_REVERSE, or
ResultSet.FETCH_UNKNOWN
HSQLDB throws for all values except FETCH_FORWARD
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-Specific Information:
Up to and including 1.7.1, HSQLDB always returns FETCH_FORWARD.
getFetchDirection in interface java.sql.StatementStatement objectjava.sql.SQLException - if a database access error occurssetFetchDirection(int)
public void setFetchSize(int rows)
throws java.sql.SQLException
HSQLDB-Specific Information:
Up to and including HSQLDB 1.7.0, calls to this method are simply
ignored; HSQLDB always fetches a result completely as part of e
xecuting its statement.
setFetchSize in interface java.sql.Statementrows - the number of rows to fetchjava.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.
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-Specific Information
Up to and including 1.7.1, this method always returns 0.
That is, HSQLDB always decides the fetch size, that being all the
rows of a result.
getFetchSize in interface java.sql.StatementStatement objectjava.sql.SQLException - if a database access error occurssetFetchSize(int)
public int getResultSetConcurrency()
throws java.sql.SQLException
ResultSet objects
generated by this Statement object.
HSQLDB-Specific Information:
Up to and including 1.7.1, HSQLDB supports only
CONCUR_READ_ONLY concurrency.
getResultSetConcurrency in interface java.sql.StatementResultSet.CONCUR_READ_ONLY or
ResultSet.CONCUR_UPDATABLE (not supported)java.sql.SQLException - if a database access error occurs
public int getResultSetType()
throws java.sql.SQLException
ResultSet objects
generated by this Statement object.
HSQLDB-Specific Information:
Up to 1.6.1, HSQLDB supported
Starting with 1.7.0, HSQLDB also supports
TYPE_FORWARD_ONLY -
CONCUR_READ_ONLY results only, so ResultSet
objects created using the returned Statement
object would always be type TYPE_FORWARD_ONLY
with CONCUR_READ_ONLY concurrency. TYPE_SCROLL_INSENSITIVE results.
getResultSetType in interface java.sql.StatementResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE (not supported)
Note: Up to and including 1.7.1, HSQLDB never returns
TYPE_SCROLL_SENSITIVE
java.sql.SQLException - if a database access error occurs
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.
NOTE: This method is optional.
HSQLDB-Specific Information:
HSQLDB 1.7.1 does not support this feature.
Calling this method always throws a
SQLException,
stating that the function is not supported.
addBatch in interface java.sql.Statementsql - typically this is a static SQL INSERT or
UPDATE statementjava.sql.SQLException - if a database access error occurs, or the
driver does not support batch updatesexecuteBatch()
public void clearBatch()
throws java.sql.SQLException
Statement object's current list of
SQL commands.
NOTE: This method is optional.
HSQLDB-Specific Information:
HSQLDB 1.7.1 does not support this feature.
Calling this method always throws a
SQLException,
stating that the function is not supported.
clearBatch in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs 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
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:
HSQLDB 1.7.1 does not support this feature.
Calling this method always throws a
SQLException,
stating that the function is not supported.
executeBatch in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs or the
driver does not support batch statements. Throws
java.sql.BatchUpdateException
(a subclass of java.sql.SQLException) if one of the commands
sent to the database fails to execute properly or attempts to return a
result set.
public java.sql.Connection getConnection()
throws java.sql.SQLException
Connection object
that produced this Statement object.
getConnection in interface java.sql.Statementjava.sql.SQLException - if a database access error occurs
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||