java.sql

Interface Statement

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 Details

CLOSE_ALL_RESULTS

public static final int CLOSE_ALL_RESULTS
Field Value:
3

CLOSE_CURRENT_RESULT

public static final int CLOSE_CURRENT_RESULT
Field Value:
1

EXECUTE_FAILED

public static final int EXECUTE_FAILED
Field Value:
-3

KEEP_CURRENT_RESULT

public static final int KEEP_CURRENT_RESULT
Field Value:
2

NO_GENERATED_KEYS

public static final int NO_GENERATED_KEYS
Field Value:
2

RETURN_GENERATED_KEYS

public static final int RETURN_GENERATED_KEYS
Field Value:
1

SUCCESS_NO_INFO

public static final int SUCCESS_NO_INFO
Field Value:
-2

Method Details

addBatch

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

cancel

public void cancel()
            throws SQLException
This method cancels an outstanding statement, if the database supports that operation.
Throws:
SQLException - If an error occurs.

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.
Throws:
SQLException - If an error occurs.

clearWarnings

public void clearWarnings()
            throws SQLException
This method clears any SQL warnings that have been attached to this statement.
Throws:
SQLException - If an error occurs.

close

public void close()
            throws SQLException
This method closes the statement and frees any associated resources.
Throws:
SQLException - If an error occurs.

execute

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

execute

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

execute

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

execute

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

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.
Returns:
An array of update counts for this batch.
Throws:
SQLException - If an error occurs.

executeQuery

public 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

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

executeUpdate

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

executeUpdate

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

executeUpdate

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

getConnection

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

getFetchDirection

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

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.
Returns:
The number of rows that will be fetched from the database at a time.
Throws:
SQLException - If an error occurs.

getGeneratedKeys

public ResultSet getGeneratedKeys()
            throws SQLException
Since:
1.4

getMaxFieldSize

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

getMaxRows

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

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

getMoreResults

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

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.
Returns:
The SQL statement timeout in seconds.
Throws:
SQLException - If an error occurs.

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

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.
Returns:
The concurrency type of the result set for this statement.
Throws:
SQLException - If an error occurs.
See Also:
ResultSet

getResultSetHoldability

public int getResultSetHoldability()
            throws SQLException
Since:
1.4

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.
Returns:
The result set type for this statement.
Throws:
SQLException - If an error occurs.
See Also:
ResultSet

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

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.
Returns:
The first SQL warning for this statement.
Throws:
SQLException - If an error occurs.

setCursorName

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

setEscapeProcessing

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

setFetchDirection

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

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.
Parameters:
numRows - The number of rows the driver should fetch at a time to populate the result set.
Throws:
SQLException - If an error occurs.

setMaxFieldSize

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

setMaxRows

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

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.
Parameters:
seconds - The new SQL statement timeout value.
Throws:
SQLException - If an error occurs.

Statement.java -- Interface for executing SQL statements. Copyright (C) 1999, 2000, 2002, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.