java.sql
Interface Statement

All Known Subinterfaces:
CallableStatement, PreparedStatement

public interface Statement

This interface provides a mechanism for executing SQL statements.


Field Summary
static int CLOSE_ALL_RESULTS
           
static int CLOSE_CURRENT_RESULT
           
static int EXECUTE_FAILED
           
static int KEEP_CURRENT_RESULT
           
static int NO_GENERATED_KEYS
           
static int RETURN_GENERATED_KEYS
           
static int SUCCESS_NO_INFO
           
 
Method Summary
 void addBatch(String sql)
          This method adds a SQL statement to a SQL batch.
 void cancel()
          This method cancels an outstanding statement, if the database supports that operation.
 void clearBatch()
          This method clears out any SQL statements that have been populated in the current batch.
 void clearWarnings()
          This method clears any SQL warnings that have been attached to this statement.
 void close()
          This method closes the statement and frees any associated resources.
 boolean execute(String sql)
          This method executes an arbitrary SQL statement of any time.
 boolean execute(String sql, int autoGeneratedKeys)
           
 boolean execute(String sql, int[] columnIndexes)
           
 boolean execute(String sql, String[] columnNames)
           
 int[] executeBatch()
          This method executes the SQL batch and returns an array of update counts - one for each SQL statement in the batch - ordered in the same order the statements were added to the batch.
 ResultSet executeQuery(String sql)
          This method executes the specified SQL SELECT statement and returns a (possibly empty) ResultSet with the results of the query.
 int executeUpdate(String sql)
          This method executes the specified SQL INSERT, UPDATE, or DELETE statement and returns the number of rows affected, which may be 0.
 int executeUpdate(String sql, int autoGeneratedKeys)
           
 int executeUpdate(String sql, int[] columnIndexes)
           
 int executeUpdate(String sql, String[] columnNames)
           
 Connection getConnection()
          This method returns the Connection instance that was used to create this object.
 int getFetchDirection()
          This method returns the current direction that the driver thinks the result set will be accessed int.
 int getFetchSize()
          This method returns the number of rows the driver believes should be fetched from the database at a time.
 ResultSet getGeneratedKeys()
           
 int getMaxFieldSize()
          This method returns the maximum length of any column value in bytes.
 int getMaxRows()
          This method returns the maximum possible number of rows in a result set.
 boolean getMoreResults()
          This method advances the result set pointer to the next result set, which can then be retrieved using getResultSet
 boolean getMoreResults(int current)
           
 int getQueryTimeout()
          The method returns the number of seconds a statement may be in process before timing out.
 ResultSet getResultSet()
          This method returns the result set of the SQL statement that was executed.
 int getResultSetConcurrency()
          This method returns the concurrency type of the result set for this statement.
 int getResultSetHoldability()
           
 int getResultSetType()
          This method returns the result set type for this statement.
 int getUpdateCount()
          This method returns the update count of the SQL statement that was executed.
 SQLWarning getWarnings()
          This method returns the first SQL warning attached to this statement.
 void setCursorName(String name)
          This method sets the cursor name that will be used by the result set.
 void setEscapeProcessing(boolean escape)
          This method sets the local escape processing mode on or off.
 void setFetchDirection(int direction)
          This method informs the driver which direction the result set will be accessed in.
 void setFetchSize(int numRows)
          This method informs the driver how many rows it should fetch from the database at a time.
 void setMaxFieldSize(int maxSize)
          This method sets the limit for the maximum length of any column in bytes.
 void setMaxRows(int maxRows)
          This method sets the maximum number of rows that can be present in a result set.
 void setQueryTimeout(int seconds)
          This method sets the number of seconds a statement may be in process before timing out.
 

Field Detail

CLOSE_CURRENT_RESULT

static final int CLOSE_CURRENT_RESULT
See Also:
Constant Field Values

KEEP_CURRENT_RESULT

static final int KEEP_CURRENT_RESULT
See Also:
Constant Field Values

CLOSE_ALL_RESULTS

static final int CLOSE_ALL_RESULTS
See Also:
Constant Field Values

SUCCESS_NO_INFO

static final int SUCCESS_NO_INFO
See Also:
Constant Field Values

EXECUTE_FAILED

static final int EXECUTE_FAILED
See Also:
Constant Field Values

RETURN_GENERATED_KEYS

static final int RETURN_GENERATED_KEYS
See Also:
Constant Field Values

NO_GENERATED_KEYS

static final int NO_GENERATED_KEYS
See Also:
Constant Field Values
Method Detail

executeQuery

ResultSet executeQuery(String sql)
                       throws SQLException
This method executes the specified SQL SELECT statement and returns a (possibly empty) ResultSet with the results of the query.

Parameters:
sql - The SQL statement to execute.
Returns:
The result set of the SQL statement.
Throws:
SQLException - If an error occurs.

executeUpdate

int executeUpdate(String sql)
                  throws SQLException
This method executes the specified SQL INSERT, UPDATE, or DELETE statement and returns the number of rows affected, which may be 0.

Parameters:
sql - The SQL statement to execute.
Returns:
The number of rows affected by the SQL statement.
Throws:
SQLException - If an error occurs.

close

void close()
           throws SQLException
This method closes the statement and frees any associated resources.

Throws:
SQLException - If an error occurs.

getMaxFieldSize

int getMaxFieldSize()
                    throws SQLException
This method returns the maximum length of any column value in bytes.

Returns:
The maximum length of any column value in bytes.
Throws:
SQLException - If an error occurs.

setMaxFieldSize

void setMaxFieldSize(int maxSize)
                     throws SQLException
This method sets the limit for the maximum length of any column in bytes.

Parameters:
maxSize - The new maximum length of any column in bytes.
Throws:
SQLException - If an error occurs.

getMaxRows

int getMaxRows()
               throws SQLException
This method returns the maximum possible number of rows in a result set.

Returns:
The maximum possible number of rows in a result set.
Throws:
SQLException - If an error occurs.

setMaxRows

void setMaxRows(int maxRows)
                throws SQLException
This method sets the maximum number of rows that can be present in a result set.

Parameters:
maxRows - The maximum possible number of rows in a result set.
Throws:
SQLException - If an error occurs.

setEscapeProcessing

void setEscapeProcessing(boolean escape)
                         throws SQLException
This method sets the local escape processing mode on or off. The default value is on.

Parameters:
escape - true to enable local escape processing, false to disable it.
Throws:
SQLException - If an error occurs.

getQueryTimeout

int getQueryTimeout()
                    throws SQLException
The method returns the number of seconds a statement may be in process before timing out. A value of 0 means there is no timeout.

Returns:
The SQL statement timeout in seconds.
Throws:
SQLException - If an error occurs.

setQueryTimeout

void setQueryTimeout(int seconds)
                     throws SQLException
This method sets the number of seconds a statement may be in process before timing out. A value of 0 means there is no timeout.

Parameters:
seconds - The new SQL statement timeout value.
Throws:
SQLException - If an error occurs.

cancel

void cancel()
            throws SQLException
This method cancels an outstanding statement, if the database supports that operation.

Throws:
SQLException - If an error occurs.

getWarnings

SQLWarning getWarnings()
                       throws SQLException
This method returns the first SQL warning attached to this statement. Subsequent warnings will be chained to this one.

Returns:
The first SQL warning for this statement.
Throws:
SQLException - If an error occurs.

clearWarnings

void clearWarnings()
                   throws SQLException
This method clears any SQL warnings that have been attached to this statement.

Throws:
SQLException - If an error occurs.

setCursorName

void setCursorName(String name)
                   throws SQLException
This method sets the cursor name that will be used by the result set.

Parameters:
name - The cursor name to use for this statement.
Throws:
SQLException - If an error occurs.

execute

boolean execute(String sql)
                throws SQLException
This method executes an arbitrary SQL statement of any time. The methods getResultSet, getMoreResults and getUpdateCount retrieve the results.

Returns:
true if a result set was returned, false if an update count was returned.
Throws:
SQLException - If an error occurs.

getResultSet

ResultSet getResultSet()
                       throws SQLException
This method returns the result set of the SQL statement that was executed. This should be called only once per result set returned.

Returns:
The result set of the query, or null if there was no result set (for example, if the statement was an UPDATE).
Throws:
SQLException - If an error occurs.
See Also:
execute(String), execute(String, int), execute(String, int[]), execute(String, String[])

getUpdateCount

int getUpdateCount()
                   throws SQLException
This method returns the update count of the SQL statement that was executed. This should be called only once per executed SQL statement.

Returns:
The update count of the query, or -1 if there was no update count (for example, if the statement was a SELECT).
Throws:
SQLException - If an error occurs.
See Also:
execute(String), execute(String, int), execute(String, int[]), execute(String, String[])

getMoreResults

boolean getMoreResults()
                       throws SQLException
This method advances the result set pointer to the next result set, which can then be retrieved using getResultSet

Returns:
true if there is another result set, false otherwise (for example, the next result is an update count).
Throws:
SQLException - If an error occurs.
See Also:
execute(String), execute(String, int), execute(String, int[]), execute(String, String[])

setFetchDirection

void setFetchDirection(int direction)
                       throws SQLException
This method informs the driver which direction the result set will be accessed in.

Parameters:
direction - The direction the result set will be accessed in (?????)
Throws:
SQLException - If an error occurs.

getFetchDirection

int getFetchDirection()
                      throws SQLException
This method returns the current direction that the driver thinks the result set will be accessed int.

Returns:
The direction the result set will be accessed in (????)
Throws:
SQLException - If an error occurs.

setFetchSize

void setFetchSize(int numRows)
                  throws SQLException
This method informs the driver how many rows it should fetch from the database at a time.

Parameters:
numRows - The number of rows the driver should fetch at a time to populate the result set.
Throws:
SQLException - If an error occurs.

getFetchSize

int getFetchSize()
                 throws SQLException
This method returns the number of rows the driver believes should be fetched from the database at a time.

Returns:
The number of rows that will be fetched from the database at a time.
Throws:
SQLException - If an error occurs.

getResultSetConcurrency

int getResultSetConcurrency()
                            throws SQLException
This method returns the concurrency type of the result set for this statement. This will be one of the concurrency types defined in ResultSet.

Returns:
The concurrency type of the result set for this statement.
Throws:
SQLException - If an error occurs.
See Also:
ResultSet

getResultSetType

int getResultSetType()
                     throws SQLException
This method returns the result set type for this statement. This will be one of the result set types defined in ResultSet.

Returns:
The result set type for this statement.
Throws:
SQLException - If an error occurs.
See Also:
ResultSet

addBatch

void addBatch(String sql)
              throws SQLException
This method adds a SQL statement to a SQL batch. A driver is not required to implement this method.

Parameters:
sql - The sql statement to add to the batch.
Throws:
SQLException - If an error occurs.

clearBatch

void clearBatch()
                throws SQLException
This method clears out any SQL statements that have been populated in the current batch. A driver is not required to implement this method.

Throws:
SQLException - If an error occurs.

executeBatch

int[] executeBatch()
                   throws SQLException
This method executes the SQL batch and returns an array of update counts - one for each SQL statement in the batch - ordered in the same order the statements were added to the batch. A driver is not required to implement this method.

Returns:
An array of update counts for this batch.
Throws:
SQLException - If an error occurs.

getConnection

Connection getConnection()
                         throws SQLException
This method returns the Connection instance that was used to create this object.

Returns:
The connection used to create this object.
Throws:
SQLException - If an error occurs.

getMoreResults

boolean getMoreResults(int current)
                       throws SQLException
Throws:
SQLException
Since:
1.4

getGeneratedKeys

ResultSet getGeneratedKeys()
                           throws SQLException
Throws:
SQLException
Since:
1.4

executeUpdate

int executeUpdate(String sql,
                  int autoGeneratedKeys)
                  throws SQLException
Throws:
SQLException
Since:
1.4

executeUpdate

int executeUpdate(String sql,
                  int[] columnIndexes)
                  throws SQLException
Throws:
SQLException
Since:
1.4

executeUpdate

int executeUpdate(String sql,
                  String[] columnNames)
                  throws SQLException
Throws:
SQLException
Since:
1.4

execute

boolean execute(String sql,
                int autoGeneratedKeys)
                throws SQLException
Throws:
SQLException
Since:
1.4

execute

boolean execute(String sql,
                int[] columnIndexes)
                throws SQLException
Throws:
SQLException
Since:
1.4

execute

boolean execute(String sql,
                String[] columnNames)
                throws SQLException
Throws:
SQLException
Since:
1.4

getResultSetHoldability

int getResultSetHoldability()
                            throws SQLException
Throws:
SQLException
Since:
1.4