CARVIEW |
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.sql
Interface Statement
- All Superinterfaces:
- Wrapper
- All Known Subinterfaces:
- CallableStatement, PreparedStatement
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.
- See Also:
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(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. |
boolean |
isPoolable()
Returns a value indicating whether the Statement
is poolable or not. |
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 character and binary 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 |
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. |
Methods inherited from interface java.sql.Wrapper |
---|
isWrapperFor, unwrap |
Field Detail |
---|
CLOSE_CURRENT_RESULT
static final int CLOSE_CURRENT_RESULT
- The constant indicating that the current
ResultSet
object should be closed when callinggetMoreResults
.- Since:
- 1.4
- See Also:
- Constant Field Values
KEEP_CURRENT_RESULT
static final int KEEP_CURRENT_RESULT
- The constant indicating that the current
ResultSet
object should not be closed when callinggetMoreResults
.- Since:
- 1.4
- See Also:
- Constant Field Values
CLOSE_ALL_RESULTS
static final int CLOSE_ALL_RESULTS
- The constant indicating that all
ResultSet
objects that have previously been kept open should be closed when callinggetMoreResults
.- Since:
- 1.4
- See Also:
- Constant Field Values
SUCCESS_NO_INFO
static final 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
- See Also:
- Constant Field Values
EXECUTE_FAILED
static final int EXECUTE_FAILED
- The constant indicating that an error occured while executing a
batch statement.
- Since:
- 1.4
- See Also:
- Constant Field Values
RETURN_GENERATED_KEYS
static final int RETURN_GENERATED_KEYS
- The constant indicating that generated keys should be made
available for retrieval.
- Since:
- 1.4
- See Also:
- Constant Field Values
NO_GENERATED_KEYS
static final int NO_GENERATED_KEYS
- The constant indicating that generated keys should not be made
available for retrieval.
- Since:
- 1.4
- See Also:
- Constant Field Values
Method Detail |
---|
executeQuery
ResultSet executeQuery(String sql) throws SQLException
- Executes the given SQL statement, which returns a single
ResultSet
object.- Parameters:
sql
- an SQL statement to be sent to the database, typically a static SQLSELECT
statement- Returns:
- a
ResultSet
object that contains the data produced by the given query; nevernull
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the given SQL statement produces anything other than a singleResultSet
object
executeUpdate
int executeUpdate(String sql) throws SQLException
- Executes the given SQL statement, which may be an
INSERT
,UPDATE
, orDELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statement.- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the given SQL statement produces aResultSet
object
close
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 aStatement
object that is already closed has no effect.Note:When a
Statement
object is closed, its currentResultSet
object, if one exists, is also closed.- Throws:
SQLException
- if a database access error occurs
getMaxFieldSize
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 thisStatement
object. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARY
,CHAR
,VARCHAR
,NCHAR
,NVARCHAR
,LONGNVARCHAR
andLONGVARCHAR
columns. If the limit is exceeded, the excess data is silently discarded.- Returns:
- the current column size limit for columns storing character and binary values; zero means there is no limit
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
setMaxFieldSize(int)
setMaxFieldSize
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 thisStatement
object. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARY
,CHAR
,VARCHAR
,NCHAR
,NVARCHAR
,LONGNVARCHAR
andLONGVARCHAR
fields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.- Parameters:
max
- the new column size limit in bytes; zero means there is no limit- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the condition max >= 0 is not satisfied- See Also:
getMaxFieldSize()
getMaxRows
int getMaxRows() throws SQLException
- Retrieves the maximum number of rows that a
ResultSet
object produced by thisStatement
object can contain. If this limit is exceeded, the excess rows are silently dropped.- Returns:
- the current maximum number of rows for a
ResultSet
object produced by thisStatement
object; zero means there is no limit - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
setMaxRows(int)
setMaxRows
void setMaxRows(int max) throws SQLException
- Sets the limit for the maximum number of rows that any
ResultSet
object generated by thisStatement
object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.- Parameters:
max
- the new max rows limit; zero means there is no limit- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the condition max >= 0 is not satisfied- See Also:
getMaxRows()
setEscapeProcessing
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.- Parameters:
enable
-true
to enable escape processing;false
to disable it- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
getQueryTimeout
int getQueryTimeout() throws SQLException
- Retrieves the number of seconds the driver will
wait for a
Statement
object to execute. If the limit is exceeded, aSQLException
is thrown.- Returns:
- the current query timeout limit in seconds; zero means there is no limit
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
setQueryTimeout(int)
setQueryTimeout
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. If the limit is exceeded, anSQLException
is thrown. A JDBC driver must apply this limit to theexecute
,executeQuery
andexecuteUpdate
methods. JDBC driver implementations may also apply this limit toResultSet
methods (consult your driver vendor documentation for details).- Parameters:
seconds
- the new query timeout limit in seconds; zero means there is no limit- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the condition seconds >= 0 is not satisfied- See Also:
getQueryTimeout()
cancel
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.- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method
getWarnings
SQLWarning getWarnings() throws SQLException
- Retrieves the first warning reported by calls on this
Statement
object. SubsequentStatement
object warnings will be chained to thisSQLWarning
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 anSQLException
to be thrown.Note: If you are processing a
ResultSet
object, any warnings associated with reads on thatResultSet
object will be chained on it rather than on theStatement
object that produced it.- Returns:
- the first
SQLWarning
object ornull
if there are no warnings - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
clearWarnings
void clearWarnings() throws SQLException
- Clears all the warnings reported on this
Statement
object. After a call to this method, the methodgetWarnings
will returnnull
until a new warning is reported for thisStatement
object.- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
setCursorName
void setCursorName(String name) throws SQLException
- Sets the SQL cursor name to the given
String
, which will be used by subsequentStatement
objectexecute
methods. This name can then be used in SQL positioned update or delete statements to identify the current row in theResultSet
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'sSELECT
statement should have the formSELECT FOR UPDATE
. IfFOR 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 theResultSet
object being used for positioning. Also, cursor names must be unique within a connection.- Parameters:
name
- the new cursor name, which must be unique within a connection- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method
execute
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 methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).- Parameters:
sql
- any SQL statement- Returns:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
getResultSet()
,getUpdateCount()
,getMoreResults()
getResultSet
ResultSet getResultSet() throws SQLException
- Retrieves the current result as a
ResultSet
object. This method should be called only once per result.- Returns:
- the current result as a
ResultSet
object ornull
if the result is an update count or there are no more results - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
execute(java.lang.String)
getUpdateCount
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.- Returns:
- the current result as an update count; -1 if the current result is a
ResultSet
object or there are no more results - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
execute(java.lang.String)
getMoreResults
boolean getMoreResults() throws SQLException
- Moves to this
Statement
object's next result, returnstrue
if it is aResultSet
object, and implicitly closes any currentResultSet
object(s) obtained with the methodgetResultSet
.There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
- Returns:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
execute(java.lang.String)
setFetchDirection
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 thisStatement
object. The default value isResultSet.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.- Parameters:
direction
- the initial direction for processing rows- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the given direction is not one ofResultSet.FETCH_FORWARD
,ResultSet.FETCH_REVERSE
, orResultSet.FETCH_UNKNOWN
- Since:
- 1.2
- See Also:
getFetchDirection()
getFetchDirection
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 thisStatement
object has not set a fetch direction by calling the methodsetFetchDirection
, the return value is implementation-specific.- Returns:
- the default fetch direction for result sets generated
from this
Statement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
- See Also:
setFetchDirection(int)
setFetchSize
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 thisStatement
. If the value specified is zero, then the hint is ignored. The default value is zero.- Parameters:
rows
- the number of rows to fetch- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the conditionrows >= 0
is not satisfied.- Since:
- 1.2
- See Also:
getFetchSize()
getFetchSize
int getFetchSize() throws SQLException
- Retrieves the number of result set rows that is the default
fetch size for
ResultSet
objects generated from thisStatement
object. If thisStatement
object has not set a fetch size by calling the methodsetFetchSize
, the return value is implementation-specific.- Returns:
- the default fetch size for result sets generated
from this
Statement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
- See Also:
setFetchSize(int)
getResultSetConcurrency
int getResultSetConcurrency() throws SQLException
- Retrieves the result set concurrency for
ResultSet
objects generated by thisStatement
object.- Returns:
- either
ResultSet.CONCUR_READ_ONLY
orResultSet.CONCUR_UPDATABLE
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
getResultSetType
int getResultSetType() throws SQLException
- Retrieves the result set type for
ResultSet
objects generated by thisStatement
object.- Returns:
- one of
ResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
addBatch
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 methodexecuteBatch
.- Parameters:
sql
- typically this is a SQLINSERT
orUPDATE
statement- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch updates- Since:
- 1.2
- See Also:
executeBatch()
,DatabaseMetaData.supportsBatchUpdates()
clearBatch
void clearBatch() throws SQLException
- Empties this
Statement
object's current list of SQL commands.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch updates- Since:
- 1.2
- See Also:
addBatch(java.lang.String)
,DatabaseMetaData.supportsBatchUpdates()
executeBatch
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 methodexecuteBatch
may be one of the following:- 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
- A value of
SUCCESS_NO_INFO
-- indicates that the command was processed successfully but that the number of rows affected is unknownIf 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 methodBatchUpdateException.getUpdateCounts
will contain as many elements as there are commands in the batch, and at least one of the elements will be the following: - 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.- Returns:
- an array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which commands were added to the batch.
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch statements. ThrowsBatchUpdateException
(a subclass ofSQLException
) if one of the commands sent to the database fails to execute properly or attempts to return a result set.- Since:
- 1.3
- See Also:
addBatch(java.lang.String)
,DatabaseMetaData.supportsBatchUpdates()
getConnection
Connection getConnection() throws SQLException
- Retrieves the
Connection
object that produced thisStatement
object.- Returns:
- the connection that produced this statement
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
getMoreResults
boolean getMoreResults(int current) throws SQLException
- Moves to this
Statement
object's next result, deals with any currentResultSet
object(s) according to the instructions specified by the given flag, and returnstrue
if the next result is aResultSet
object.There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
- Parameters:
current
- one of the followingStatement
constants indicating what should happen to currentResultSet
objects obtained using the methodgetResultSet
:Statement.CLOSE_CURRENT_RESULT
,Statement.KEEP_CURRENT_RESULT
, orStatement.CLOSE_ALL_RESULTS
- Returns:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the argument supplied is not one of the following:Statement.CLOSE_CURRENT_RESULT
,Statement.KEEP_CURRENT_RESULT
orStatement.CLOSE_ALL_RESULTS
SQLFeatureNotSupportedException
- ifDatabaseMetaData.supportsMultipleOpenResults
returnsfalse
and eitherStatement.KEEP_CURRENT_RESULT
orStatement.CLOSE_ALL_RESULTS
are supplied as the argument.- Since:
- 1.4
- See Also:
execute(java.lang.String)
getGeneratedKeys
ResultSet getGeneratedKeys() throws SQLException
- Retrieves any auto-generated keys created as a result of executing this
Statement
object. If thisStatement
object did not generate any keys, an emptyResultSet
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.
- Returns:
- a
ResultSet
object containing the auto-generated key(s) generated by the execution of thisStatement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
executeUpdate
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 anINSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.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
- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the given SQL statement returns aResultSet
object, or the given constant is not one of those allowedSQLFeatureNotSupportedException
- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS- Since:
- 1.4
executeUpdate
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).- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.columnIndexes
- an array of column indexes indicating the columns that should be returned from the inserted row- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the SQL statement returns aResultSet
object, or the second argument supplied to this method is not anint
array whose elements are valid column indexesSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
executeUpdate
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).- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.columnNames
- an array of the names of the columns that should be returned from the inserted row- Returns:
- either the row count for
INSERT
,UPDATE
, orDELETE
statements, or 0 for SQL statements that return nothing - Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the SQL statement returns aResultSet
object, or the second argument supplied to this method is not aString
array whose elements are valid column namesSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
execute
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 methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).- Parameters:
sql
- any SQL statementautoGeneratedKeys
- a constant indicating whether auto-generated keys should be made available for retrieval using the methodgetGeneratedKeys
; one of the following constants:Statement.RETURN_GENERATED_KEYS
orStatement.NO_GENERATED_KEYS
- Returns:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the second parameter supplied to this method is notStatement.RETURN_GENERATED_KEYS
orStatement.NO_GENERATED_KEYS
.SQLFeatureNotSupportedException
- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS- Since:
- 1.4
- See Also:
getResultSet()
,getUpdateCount()
,getMoreResults()
,getGeneratedKeys()
execute
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 methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).- Parameters:
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 methodgetGeneratedKeys
- Returns:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the elements in theint
array passed to this method are not valid column indexesSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
getResultSet()
,getUpdateCount()
,getMoreResults()
execute
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 methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).- Parameters:
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 methodgetGeneratedKeys
- Returns:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the elements of theString
array passed to this method are not valid column namesSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
getResultSet()
,getUpdateCount()
,getMoreResults()
,getGeneratedKeys()
getResultSetHoldability
int getResultSetHoldability() throws SQLException
- Retrieves the result set holdability for
ResultSet
objects generated by thisStatement
object.- Returns:
- either
ResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.4
isClosed
boolean isClosed() throws SQLException
- Retrieves whether this
Statement
object has been closed. AStatement
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
setPoolable
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 aPreparedStatement
andCallableStatement
are poolable when created.- Parameters:
poolable
- requests that the statement be pooled if true and that the statement not be pooled if false- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- 1.6
isPoolable
boolean isPoolable() throws SQLException
- Returns a value indicating whether the
Statement
is poolable or not.- Returns:
true
if theStatement
is poolable;false
otherwise- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- 1.6
- See Also:
setPoolable(boolean)
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.