Home » openjdk-7 » java » sql » [javadoc | source]
java.sql
public interface: Statement [javadoc | source]

All Implemented Interfaces:
    Wrapper, AutoCloseable

All Known Implementing Classes:
    CallableStatement, PreparedStatement

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
 int CLOSE_CURRENT_RESULT    The constant indicating that the current ResultSet object should be closed when calling getMoreResults.
    since: 1.4 -
 
 int KEEP_CURRENT_RESULT    The constant indicating that the current ResultSet object should not be closed when calling getMoreResults.
    since: 1.4 -
 
 int CLOSE_ALL_RESULTS    The constant indicating that all ResultSet objects that have previously been kept open should be closed when calling getMoreResults.
    since: 1.4 -
 
 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.
    since: 1.4 -
 
 int EXECUTE_FAILED    The constant indicating that an error occured while executing a batch statement.
    since: 1.4 -
 
 int RETURN_GENERATED_KEYS    The constant indicating that generated keys should be made available for retrieval.
    since: 1.4 -
 
 int NO_GENERATED_KEYS    The constant indicating that generated keys should not be made available for retrieval.
    since: 1.4 -
 
Method from java.sql.Statement Summary:
addBatch,   cancel,   clearBatch,   clearWarnings,   close,   closeOnCompletion,   execute,   execute,   execute,   execute,   executeBatch,   executeQuery,   executeUpdate,   executeUpdate,   executeUpdate,   executeUpdate,   getConnection,   getFetchDirection,   getFetchSize,   getGeneratedKeys,   getMaxFieldSize,   getMaxRows,   getMoreResults,   getMoreResults,   getQueryTimeout,   getResultSet,   getResultSetConcurrency,   getResultSetHoldability,   getResultSetType,   getUpdateCount,   getWarnings,   isCloseOnCompletion,   isClosed,   isPoolable,   setCursorName,   setEscapeProcessing,   setFetchDirection,   setFetchSize,   setMaxFieldSize,   setMaxRows,   setPoolable,   setQueryTimeout
Method from java.sql.Statement Detail:
 public  void addBatch(String sql) throws SQLException
    Adds the given SQL command to the current list of commmands for this
Statement object. The commands in this list can be
executed as a batch by calling the method executeBatch.

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public  void cancel() throws SQLException
    Cancels this 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.
 public  void clearBatch() throws SQLException
    Empties this Statement object's current list of
SQL commands.

 public  void clearWarnings() throws SQLException
    Clears all the warnings reported on this Statement
object. After a call to this method,
the method getWarnings will return
null until a new warning is reported for this
Statement object.
 public  void close() throws SQLException
    Releases this 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.
 public  void closeOnCompletion() throws SQLException
    Specifies that this {@code Statement} will be closed when all its
dependent result sets are closed. If execution of the {@code Statement}
does not produce any result sets, this method has no effect.

    
Note: Multiple calls to {@code closeOnCompletion} do
not toggle the effect on this {@code Statement}. However, a call to
{@code closeOnCompletion} does effect both the subsequent execution of
statements, and statements that currently have open, dependent,
result sets.
 public boolean execute(String sql) throws SQLException
    Executes the given SQL statement, which may return multiple results.
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).

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public boolean execute(String sql,
    int autoGeneratedKeys) throws SQLException
    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.  The driver will ignore this signal 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).

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

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public boolean execute(String sql,
    int[] columnIndexes) throws SQLException
    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.  This array contains the indexes of the columns in the
target table that contain the auto-generated keys that should be made
available.  The driver will ignore the array 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).

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

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public boolean execute(String sql,
    String[] columnNames) throws SQLException
    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. This array contains the names of the columns in the
target table that contain the auto-generated keys that should be made
available.  The driver will ignore the array 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).

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

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public int[] executeBatch() throws SQLException
    Submits a batch of commands to the database for execution and
if all commands execute successfully, returns an array of update counts.
The 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:

      

    1. A number greater than or equal to zero -- indicates that the
command was processed successfully and is an update count giving the
number of rows in the database that were affected by the command's
execution

    2. A value of 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:

      

    3. A value of EXECUTE_FAILED -- indicates that the command failed
to execute successfully and occurs only if a driver continues to
process commands after a command fails

    

    
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.
 public ResultSet executeQuery(String sql) throws SQLException
    Executes the given SQL statement, which returns a single
ResultSet object.

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public int executeUpdate(String sql) throws SQLException
    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.

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public int executeUpdate(String sql,
    int autoGeneratedKeys) throws SQLException
    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.  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).

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public int executeUpdate(String sql,
    int[] columnIndexes) throws SQLException
    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.   This array contains the indexes of the columns in the
target table that contain the auto-generated keys that should be made
available. The driver will ignore the array 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).

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public int executeUpdate(String sql,
    String[] columnNames) throws SQLException
    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.   This array contains the names of the columns in the
target table that contain the auto-generated keys that should be made
available. The driver will ignore the array 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).

    
Note:This method cannot be called on a
PreparedStatement or CallableStatement.
 public Connection getConnection() throws SQLException
    Retrieves the Connection object
that produced this Statement object.
 public int getFetchDirection() throws SQLException
    Retrieves the direction for fetching rows from
database tables that is the default for result sets
generated from this Statement object.
If this Statement object has not set
a fetch direction by calling the method setFetchDirection,
the return value is implementation-specific.
 public int getFetchSize() throws SQLException
    Retrieves the number of result set rows that is the default
fetch size for 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.
 public ResultSet getGeneratedKeys() throws SQLException
    Retrieves any auto-generated keys created as a result of executing this
Statement object. If this Statement object did
not generate any keys, an empty ResultSet
object is returned.


    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.
 public int getMaxFieldSize() throws SQLException
    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.
This limit applies only to  BINARY, VARBINARY,
LONGVARBINARY, CHAR, VARCHAR,
NCHAR, NVARCHAR, LONGNVARCHAR
and LONGVARCHAR columns.  If the limit is exceeded, the
excess data is silently discarded.
 public int getMaxRows() throws SQLException
    Retrieves the maximum number of rows that a
ResultSet object produced by this
Statement object can contain.  If this limit is exceeded,
the excess rows are silently dropped.
 public boolean getMoreResults() throws SQLException
    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.


    There are no more results when the following is true:

        // stmt is a Statement object
    ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))

 public boolean getMoreResults(int current) throws SQLException
    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.


    There are no more results when the following is true:

        // stmt is a Statement object
    ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))

 public int getQueryTimeout() throws SQLException
    Retrieves the number of seconds the driver will
wait for a Statement object to execute.
If the limit is exceeded, a
SQLException is thrown.
 public ResultSet getResultSet() throws SQLException
    Retrieves the current result as a ResultSet object.
 This method should be called only once per result.
 public int getResultSetConcurrency() throws SQLException
    Retrieves the result set concurrency for ResultSet objects
generated by this Statement object.
 public int getResultSetHoldability() throws SQLException
    Retrieves the result set holdability for ResultSet objects
generated by this Statement object.
 public int getResultSetType() throws SQLException
    Retrieves the result set type for ResultSet objects
generated by this Statement object.
 public int getUpdateCount() throws SQLException
    Retrieves the current result as an update count;
 if the result is a ResultSet object or there are no more results, -1
 is returned. This method should be called only once per result.
 public SQLWarning getWarnings() throws SQLException
    Retrieves the first warning reported by calls on this 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.
 public boolean isCloseOnCompletion() throws SQLException
    Returns a value indicating whether this {@code Statement} will be
closed when all its dependent result sets are closed.
 public 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.
 public boolean isPoolable() throws SQLException
    Returns a  value indicating whether the Statement
is poolable or not.

 public  void setCursorName(String name) throws SQLException
    Sets the SQL cursor name to the given 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.
 public  void setEscapeProcessing(boolean enable) throws SQLException
    Sets escape processing on or off.
If escape scanning is on (the default), the driver will do
escape substitution before sending the SQL statement to the database.

Note: Since prepared statements have usually been parsed prior
to making this call, disabling escape processing for
PreparedStatements objects will have no effect.
 public  void setFetchDirection(int direction) throws SQLException
    Gives the driver a hint as to the direction in which
rows will be processed in 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.
 public  void setFetchSize(int rows) throws SQLException
    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.
If the value specified is zero, then the hint is ignored.
The default value is zero.
 public  void setMaxFieldSize(int max) throws SQLException
    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,
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.
 public  void setMaxRows(int max) throws SQLException
    Sets the limit for the maximum number of rows that any
ResultSet object  generated by this Statement
object can contain to the given number.
If the limit is exceeded, the excess
rows are silently dropped.
 public  void setPoolable(boolean poolable) throws SQLException
    Requests that a 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.

 public  void setQueryTimeout(int seconds) throws SQLException
    Sets the number of seconds the driver will wait for a
Statement object to execute to the given number of seconds.
By default there is no limit on the amount of time allowed for a running
statement to complete. If the limit is exceeded, an
SQLTimeoutException is thrown.
A JDBC driver must apply this limit to the execute,
executeQuery and executeUpdate methods.

    
Note: JDBC driver implementations may also apply this
limit to {@code ResultSet} methods
(consult your driver vendor documentation for details).

    
Note: In the case of {@code Statement} batching, it is
implementation defined as to whether the time-out is applied to
individual SQL commands added via the {@code addBatch} method or to
the entire batch of SQL commands invoked by the {@code executeBatch}
method (consult your driver vendor documentation for details).