is new.
All Superinterfaces:
Wrapper
public interface Statement
extends
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 statment's current ResultSet object if an open one exists.
| Field Summary | |
|---|---|
| static int |
CLOSE_ALL_RESULTS
The constant indicating that all ResultSet objects that have previously been kept open should be closed when calling getMoreResults. |
| static int |
CLOSE_CURRENT_RESULT
The constant indicating that the current ResultSet object should be closed when calling getMoreResults. |
| static int |
EXECUTE_FAILED
The constant indicating that an error occured while executing a batch statement. |
| static int |
KEEP_CURRENT_RESULT
The constant indicating that the current ResultSet object should not be closed when calling getMoreResults. |
| static int |
NO_GENERATED_KEYS
The constant indicating that generated keys should not be made available for retrieval. |
| static int |
RETURN_GENERATED_KEYS
The constant indicating that generated keys should be made available for retrieval. |
| static int |
SUCCESS_NO_INFO
The constant indicating that a batch statement executed successfully but that no count of the number of rows it affected is available. |
| 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. |
| 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.
|
| 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) 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) Sets the limit for the maximum number of bytes
that can be returned for
and
column
values
in a ResultSet object produced by this Statement object.
|
| void |
setMaxRows
(int max) 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 |
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 interface java.sql.
Wrapper
|
|---|
isWrapperFor
,
unwrap
|
| Field Detail |
|---|
static final int CLOSE_CURRENT_RESULT
static final int KEEP_CURRENT_RESULT
static final int CLOSE_ALL_RESULTS
static final int SUCCESS_NO_INFO
static final int EXECUTE_FAILED
static final int RETURN_GENERATED_KEYS
static final int NO_GENERATED_KEYS
| Method Detail |
|---|
ResultSet executeQuery(String sql)
throws SQLException
int executeUpdate(String sql)
throws SQLException
Data Manipulation Language (DML) statement, such as
INSERT, UPDATE or
DELETE;
nothing, such as a DDL statement.
(1)
the row count for
SQL Data Manipulation Language (DML) statements
(2)
void close()
throws SQLException
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.
int getMaxFieldSize()
throws SQLException
NCHAR, NVARCHAR, LONGNVARCHAR
and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.
void setMaxFieldSize(int max)
throws SQLException
that can be returned for
and
column
values
in a ResultSet object produced by this Statement object.
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.
int getMaxRows()
throws SQLException
void setMaxRows(int max)
throws SQLException
generated by this Statement object
can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.
void setEscapeProcessing(boolean enable)
throws SQLException
int getQueryTimeout()
throws SQLException
void setQueryTimeout(int seconds)
throws SQLException
A JDBC 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).
void cancel()
throws SQLException
SQLWarning getWarnings()
throws SQLException
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.
void clearWarnings()
throws SQLException
void setCursorName(String name)
throws SQLException
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.
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).
ResultSet getResultSet()
throws SQLException
int getUpdateCount()
throws SQLException
boolean getMoreResults()
throws SQLException
There are no more results when the following is true:
// stmt is a Statement object
((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
void setFetchDirection(int direction)
throws SQLException
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.
int getFetchDirection()
throws SQLException
void setFetchSize(int rows)
throws SQLException
needed for ResultSet objects genrated by
Statement.
rows >=
0
is not satisfied.
int getFetchSize()
throws SQLException
int getResultSetConcurrency()
throws SQLException
int getResultSetType()
throws SQLException
void addBatch(String sql)
throws SQLException
NOTE:
Support of an ability to batch updates is optional.
This method is optional.
,
DatabaseMetaData.supportsBatchUpdates()
void clearBatch()
throws SQLException
NOTE:
Support of an ability to batch updates is optional.
This method is optional.
,
DatabaseMetaData.supportsBatchUpdates()
int[] executeBatch()
throws SQLException
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:
NOTE:
Support of an ability to batch updates is optional.
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.
See Also:
addBatch(java.lang.String)
,
DatabaseMetaData.supportsBatchUpdates()
Connection getConnection()
throws SQLException
boolean getMoreResults(int current)
throws SQLException
There are no more results when the following is true:
// stmt is a Statement object((stmt.getMoreResults(current)
((stmt.getMoreResults()== false) && (stmt.getUpdateCount() == -1))
ResultSet getGeneratedKeys()
throws SQLException
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.
int executeUpdate(String sql,
int autoGeneratedKeys)
throws SQLException
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).
Data Manipulation Language (DML) statement, such as
INSERT, UPDATE or
DELETE;
nothing, such as a DDL statement.
(1)
the row count for
SQL Data Manipulation Language (DML) statements
(2)
int executeUpdate(String sql,
int[] columnIndexes)
throws SQLException
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).
Data Manipulation Language (DML) statement, such as
INSERT, UPDATE or
DELETE;
a
statement.
(1)
the row count for
SQL Data Manipulation Language (DML) statements
(2)
int executeUpdate(String sql,
String[] columnNames)
throws SQLException
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).
Data Manipulation Language (DML) statement, such as
INSERT, UPDATE or
DELETE;
nothing, such as a DDL statement.
boolean execute(String sql,
int autoGeneratedKeys)
throws SQLException
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).
boolean execute(String sql,
int[] columnIndexes)
throws SQLException
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).
boolean execute(String sql,
String[] columnNames)
throws SQLException
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).
int getResultSetHoldability()
throws SQLException
isClosed
boolean
isClosed
() throws
SQLException
Retrieves whether this Statement object has been closed. A Statement is closed if the method close has been called on it, or if it is automatically closed.
Returns:
true if this Statement object is closed; false if it is still open
Throws:
SQLException
- if a database access error occurs
Since:
1.6