Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

java.sql
Interface Statement  view Statement download Statement.java

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(java.lang.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(java.lang.String sql)
          This method executes an arbitrary SQL statement of any time.
 boolean execute(java.lang.String sql, int autoGeneratedKeys)
           
 boolean execute(java.lang.String sql, int[] columnIndexes)
           
 boolean execute(java.lang.String sql, java.lang.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(java.lang.String sql)
          This method executes the specified SQL SELECT statement and returns a (possibly empty) ResultSet with the results of the query.
 int executeUpdate(java.lang.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(java.lang.String sql, int autoGeneratedKeys)
           
 int executeUpdate(java.lang.String sql, int[] columnIndexes)
           
 int executeUpdate(java.lang.String sql, java.lang.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(java.lang.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

public static final int CLOSE_CURRENT_RESULT
See Also:
Constant Field Values

KEEP_CURRENT_RESULT

public static final int KEEP_CURRENT_RESULT
See Also:
Constant Field Values

CLOSE_ALL_RESULTS

public static final int CLOSE_ALL_RESULTS
See Also:
Constant Field Values

SUCCESS_NO_INFO

public static final int SUCCESS_NO_INFO
See Also:
Constant Field Values

EXECUTE_FAILED

public static final int EXECUTE_FAILED
See Also:
Constant Field Values

RETURN_GENERATED_KEYS

public static final int RETURN_GENERATED_KEYS
See Also:
Constant Field Values

NO_GENERATED_KEYS

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

executeQuery

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


executeUpdate

public int executeUpdate(java.lang.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.


close

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


getMaxFieldSize

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


setMaxFieldSize

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


getMaxRows

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


setMaxRows

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


setEscapeProcessing

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


getQueryTimeout

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


setQueryTimeout

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


cancel

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


getWarnings

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


clearWarnings

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


setCursorName

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


execute

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


getResultSet

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


getUpdateCount

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


getMoreResults

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


setFetchDirection

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


getFetchDirection

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


setFetchSize

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


getFetchSize

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


getResultSetConcurrency

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


getResultSetType

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


addBatch

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


clearBatch

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


executeBatch

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


getConnection

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


getMoreResults

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

getGeneratedKeys

public ResultSet getGeneratedKeys()
                           throws SQLException
Since:
1.4

executeUpdate

public int executeUpdate(java.lang.String sql,
                         int autoGeneratedKeys)
                  throws SQLException
Since:
1.4

executeUpdate

public int executeUpdate(java.lang.String sql,
                         int[] columnIndexes)
                  throws SQLException
Since:
1.4

executeUpdate

public int executeUpdate(java.lang.String sql,
                         java.lang.String[] columnNames)
                  throws SQLException
Since:
1.4

execute

public boolean execute(java.lang.String sql,
                       int autoGeneratedKeys)
                throws SQLException
Since:
1.4

execute

public boolean execute(java.lang.String sql,
                       int[] columnIndexes)
                throws SQLException
Since:
1.4

execute

public boolean execute(java.lang.String sql,
                       java.lang.String[] columnNames)
                throws SQLException
Since:
1.4

getResultSetHoldability

public int getResultSetHoldability()
                            throws SQLException
Since:
1.4