|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
, PreparedStatement

public interface Statement
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.
Connection.createStatement()
,
ResultSet

| 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
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
Executes the given SQL statement, which may return multiple results. |
boolean |
execute
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
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
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
Executes the given SQL statement, which returns a single ResultSet object. |
int |
executeUpdate
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
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
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
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
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. |
void |
setCursorName
Sets the SQL cursor name to the given String, which
will be used by subsequent Statement object
execute methods. |
void |
setEscapeProcessing
Sets escape processing on or off. |
void |
setFetchDirection
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
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
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
Sets the limit for the maximum number of rows that any ResultSet object can contain to the given number. |
void |
setQueryTimeout
Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds. |
| Field Detail |
|---|

static final int CLOSE_CURRENT_RESULT
ResultSet object
should be closed when calling getMoreResults.

static final int KEEP_CURRENT_RESULT
ResultSet object
should not be closed when calling getMoreResults.

static final int CLOSE_ALL_RESULTS
ResultSet objects that
have previously been kept open should be closed when calling
getMoreResults.

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
![]()
![]()
ResultSet object.
sql - 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 or the given
SQL statement produces anything other than a single
ResultSet object

int executeUpdate(String![]()
![]()
sql) throws SQLException
![]()
![]()
INSERT,
UPDATE, or DELETE statement or an
SQL statement that returns nothing, such as an SQL DDL statement.
sql - an SQL INSERT, UPDATE or
DELETE statement or an SQL statement that returns nothing
INSERT, UPDATE
or DELETE statements, or 0 for SQL statements
that return nothing
SQLException

- if a database access error occurs or the given
SQL statement produces a ResultSet object

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: 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.
SQLException

- if a database access error occurs

int getMaxFieldSize()
throws 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.
SQLException

- if a database access error occurssetMaxFieldSize(int)


void setMaxFieldSize(int max)
throws 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.
max - the new column size limit in bytes; zero means there is no limit
SQLException

- if a database access error occurs
or the condition max >= 0 is not satisfiedgetMaxFieldSize()


int getMaxRows()
throws SQLException

ResultSet object produced by this
Statement object can contain. If this limit is exceeded,
the excess rows are silently dropped.
ResultSet
object produced by this Statement object;
zero means there is no limit
SQLException

- if a database access error occurssetMaxRows(int)


void setMaxRows(int max)
throws SQLException

ResultSet object can contain to the given number.
If the limit is exceeded, the excess
rows are silently dropped.
max - the new max rows limit; zero means there is no limit
SQLException

- if a database access error occurs
or the condition max >= 0 is not satisfiedgetMaxRows()


void setEscapeProcessing(boolean enable)
throws SQLException

PreparedStatements objects will have no effect.
enable - true to enable escape processing;
false to disable it
SQLException

- if a database access error occurs

int getQueryTimeout()
throws SQLException

Statement object to execute. If the limit is exceeded, a
SQLException is thrown.
SQLException

- if a database access error occurssetQueryTimeout(int)


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.
seconds - the new query timeout limit in seconds; zero means
there is no limit
SQLException

- if a database access error occurs
or the condition seconds >= 0 is not satisfiedgetQueryTimeout()


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.
SQLException

- if a database access error occurs

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.
SQLWarning object or null
if there are no warnings
SQLException

- if a database access error occurs or this
method is called on a closed statement

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.
SQLException

- if a database access error occurs

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.
name - the new cursor name, which must be unique within
a connection
SQLException

- if a database access error occurs

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).
sql - 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 occursgetResultSet()
,
getUpdateCount()
,
getMoreResults()


ResultSet![]()
![]()
getResultSet() throws SQLException
![]()
![]()
ResultSet object.
This method should be called only once per result.
ResultSet object or
null if the result is an update count or there are no more results
SQLException

- if a database access error occursexecute(java.lang.String)


int getUpdateCount()
throws SQLException

ResultSet object or there are no more results, -1
is returned. This method should be called only once per result.
ResultSet object or there are no more results
SQLException

- if a database access error occursexecute(java.lang.String)


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))
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 occursexecute(java.lang.String)


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.
direction - the initial direction for processing rows
SQLException

- if a database access error occurs
or the given direction
is not one of ResultSet.FETCH_FORWARD,
ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWNgetFetchDirection()
