java.sql

Interface Connection

public interface Connection

This interface provides methods for managing a connection to a database.

Field Summary

static int
TRANSACTION_NONE
This transaction isolation level indicates that transactions are not supported.
static int
TRANSACTION_READ_COMMITTED
This transaction isolation level indicates that only committed data from other transactions will be read.
static int
TRANSACTION_READ_UNCOMMITTED
This transaction isolation level indicates that one transaction can read modifications by other transactions before the other transactions have committed their changes.
static int
TRANSACTION_REPEATABLE_READ
This transaction isolation level indicates that only committed data from other transactions will be read.
static int
TRANSACTION_SERIALIZABLE
This transaction isolation level indicates that only committed data from other transactions will be read.

Method Summary

Map
Class> getTypeMap()
This method returns the mapping of SQL types to Java classes currently in use by this connection.
void
clearWarnings()
This method clears all warnings that have occurred on this connection.
void
close()
This method immediately closes this database connection.
void
commit()
This method commits any SQL statements executed on this connection since the last commit or rollback.
Statement
createStatement()
This method creates a new SQL statement.
Statement
createStatement(int resultSetType, int resultSetConcurrency)
This method creates a new SQL statement with the specified type and concurrency.
Statement
createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
This method creates a new SQL statement with the specified type, concurrency and holdability, instead of using the defaults.
boolean
getAutoCommit()
This method tests whether or not auto commit mode is currently enabled.
String
getCatalog()
This method returns the name of the catalog in use by this connection, if any.
int
getHoldability()
Gets the default holdability of ResultSetS that are created from StatementS using this Connection.
DatabaseMetaData
getMetaData()
This method returns the meta data for this database connection.
int
getTransactionIsolation()
This method returns the current transaction isolation mode.
SQLWarning
getWarnings()
This method returns the first warning that occurred on this connection, if any.
boolean
isClosed()
This method tests whether or not this connection has been closed.
boolean
isReadOnly()
This method tests whether or not this connection is in read only mode.
String
nativeSQL(String sql)
This method converts the specified generic SQL statement into the native grammer of the database this object is connected to.
CallableStatement
prepareCall(String sql)
This method creates a new CallableStatement for the specified SQL string.
CallableStatement
prepareCall(String sql, int resultSetType, int resultSetConcurrency)
This method creates a new CallableStatement for the specified SQL string.
CallableStatement
prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
This method creates a new CallableStatement for the specified SQL string.
PreparedStatement
prepareStatement(String sql)
This method creates a new PreparedStatement for the specified SQL string.
PreparedStatement
prepareStatement(String sql, int autoGeneratedKeys)
PreparedStatement
prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
This method creates a new PreparedStatement for the specified SQL string.
PreparedStatement
prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
This method creates a new PreparedStatement for the specified SQL string.
PreparedStatement
prepareStatement(String sql, int[] columnIndexes)
PreparedStatement
prepareStatement(String sql, String[] columnNames)
void
releaseSavepoint(Savepoint savepoint)
Removes the specified savepoint from this Connection.
void
rollback()
This method rolls back any SQL statements executed on this connection since the last commit or rollback.
void
rollback(Savepoint savepoint)
Undoes all changes made after the specified savepoint was set.
void
setAutoCommit(boolean autoCommit)
This method turns auto commit mode on or off.
void
setCatalog(String catalog)
This method sets the name of the catalog in use by this connection.
void
setHoldability(int holdability)
Sets the default holdability of ResultSetS that are created from StatementS using this Connection.
void
setReadOnly(boolean readOnly)
This method turns read only mode on or off.
Savepoint
setSavepoint()
Creates a new unnamed savepoint for this Connection
Savepoint
setSavepoint(String name)
Creates a new savepoint with the specifiend name for this Connection.
void
setTransactionIsolation(int level)
This method sets the current transaction isolation mode.
void
setTypeMap(Map> map)
This method sets the mapping table for SQL types to Java classes.

Field Details

TRANSACTION_NONE

public static final int TRANSACTION_NONE
This transaction isolation level indicates that transactions are not supported.
Field Value:
0

TRANSACTION_READ_COMMITTED

public static final int TRANSACTION_READ_COMMITTED
This transaction isolation level indicates that only committed data from other transactions will be read. If a transaction reads a row, then another transaction commits a change to that row, the first transaction would retrieve the changed row on subsequent reads of the same row.
Field Value:
2

TRANSACTION_READ_UNCOMMITTED

public static final int TRANSACTION_READ_UNCOMMITTED
This transaction isolation level indicates that one transaction can read modifications by other transactions before the other transactions have committed their changes. This could result in invalid reads.
Field Value:
1

TRANSACTION_REPEATABLE_READ

public static final int TRANSACTION_REPEATABLE_READ
This transaction isolation level indicates that only committed data from other transactions will be read. It also ensures that data read from a row will not be different on a subsequent read even if another transaction commits a change.
Field Value:
4

TRANSACTION_SERIALIZABLE

public static final int TRANSACTION_SERIALIZABLE
This transaction isolation level indicates that only committed data from other transactions will be read. It also ensures that data read from a row will not be different on a subsequent read even if another transaction commits a change. Additionally, rows modified by other transactions will not affect the result set returned during subsequent executions of the same WHERE clause in this transaction.
Field Value:
8

Method Details

Class> getTypeMap

public MapClass> getTypeMap()
            throws SQLException
This method returns the mapping of SQL types to Java classes currently in use by this connection. This mapping will have no entries unless they have been manually added.
Returns:
The SQL type to Java class mapping.
Throws:
SQLException - If an error occurs.

clearWarnings

public void clearWarnings()
            throws SQLException
This method clears all warnings that have occurred on this connection.
Throws:
SQLException - If an error occurs.

close

public void close()
            throws SQLException
This method immediately closes this database connection.
Throws:
SQLException - If an error occurs.

commit

public void commit()
            throws SQLException
This method commits any SQL statements executed on this connection since the last commit or rollback.
Throws:
SQLException - If an error occurs.

createStatement

public Statement createStatement()
            throws SQLException
This method creates a new SQL statement. The default result set type and concurrency will be used.
Returns:
A new Statement object.
Throws:
SQLException - If an error occurs.
See Also:
Statement

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency)
            throws SQLException
This method creates a new SQL statement with the specified type and concurrency. Valid values for these parameters are specified in the ResultSet class.
Parameters:
resultSetType - The type of result set to use for this statement.
resultSetConcurrency - The type of concurrency to be used in the result set for this statement.
Returns:
A new Statement object.
Throws:
SQLException - If an error occurs.

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency,
                                 int resultSetHoldability)
            throws SQLException
This method creates a new SQL statement with the specified type, concurrency and holdability, instead of using the defaults. Valid values for these parameters are specified in the ResultSet class.
Parameters:
resultSetType - The type of result set to use for this statement.
resultSetConcurrency - The type of concurrency to be used in the result set for this statement.
resultSetHoldability - The type of holdability to be usd in the result set for this statement.
Returns:
A new Statement
Throws:
SQLException - If an error occurs.
Since:
1.4
See Also:
ResultSet

getAutoCommit

public boolean getAutoCommit()
            throws SQLException
This method tests whether or not auto commit mode is currently enabled. In auto commit mode, every SQL statement is committed its own transaction. Otherwise a transaction must be explicitly committed or rolled back.
Returns:
true if auto commit mode is enabled, false otherwise.
Throws:
SQLException - If an error occurs.

getCatalog

public String getCatalog()
            throws SQLException
This method returns the name of the catalog in use by this connection, if any.
Returns:
The name of the catalog, or null if none exists or catalogs are not supported by this database.
Throws:
SQLException - If an error occurs.

getHoldability

public int getHoldability()
            throws SQLException
Gets the default holdability of ResultSetS that are created from StatementS using this Connection.
Returns:
The current default holdability value, this must be one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT.
Throws:
SQLException - If an error occurs.
Since:
1.4
See Also:
ResultSet

getMetaData

public DatabaseMetaData getMetaData()
            throws SQLException
This method returns the meta data for this database connection.
Returns:
The meta data for this database.
Throws:
SQLException - If an error occurs.

getTransactionIsolation

public int getTransactionIsolation()
            throws SQLException
This method returns the current transaction isolation mode. This will be one of the constants defined in this interface.
Returns:
The transaction isolation level.
Throws:
SQLException - If an error occurs.

getWarnings

public SQLWarning getWarnings()
            throws SQLException
This method returns the first warning that occurred on this connection, if any. If there were any subsequence warnings, they will be chained to the first one.
Returns:
The first SQLWarning that occurred, or null if there have been no warnings.
Throws:
SQLException - If an error occurs.

isClosed

public boolean isClosed()
            throws SQLException
This method tests whether or not this connection has been closed.
Returns:
true if the connection is closed, false otherwise.
Throws:
SQLException - If an error occurs.

isReadOnly

public boolean isReadOnly()
            throws SQLException
This method tests whether or not this connection is in read only mode.
Returns:
true if the connection is read only false otherwise.
Throws:
SQLException - If an error occurs.

nativeSQL

public String nativeSQL(String sql)
            throws SQLException
This method converts the specified generic SQL statement into the native grammer of the database this object is connected to.
Parameters:
sql - The JDBC generic SQL statement.
Returns:
The native SQL statement.
Throws:
SQLException - If an error occurs.

prepareCall

public CallableStatement prepareCall(String sql)
            throws SQLException
This method creates a new CallableStatement for the specified SQL string. Thie method is designed to be used with stored procedures. The default result set type and concurrency will be used.
Parameters:
sql - The SQL statement to use in creating this CallableStatement.
Returns:
A new CallableStatement.
Throws:
SQLException - If an error occurs.

prepareCall

public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency)
            throws SQLException
This method creates a new CallableStatement for the specified SQL string. Thie method is designed to be used with stored procedures. The specified result set type and concurrency will be used. Valid values for these parameters are specified in the ResultSet class.
Parameters:
sql - The SQL statement to use in creating this PreparedStatement.
resultSetType - The type of result set to use for this statement.
resultSetConcurrency - The type of concurrency to be used in the result set for this statement.
Returns:
A new CallableStatement.
Throws:
SQLException - If an error occurs.

prepareCall

public CallableStatement prepareCall(String sql,
                                     int resultSetType,
                                     int resultSetConcurrency,
                                     int resultSetHoldability)
            throws SQLException
This method creates a new CallableStatement for the specified SQL string. Thie method is designed to be used with stored procedures. The specified result set type, concurrency and holdability will be used. Valid values for these parameters are specified in the ResultSet class.
Parameters:
sql - The SQL statement to use in creating this PreparedStatement.
resultSetType - The type of result set to use for this statement.
resultSetConcurrency - The type of concurrency to be used in the result set for this statement.
resultSetHoldability - The type of holdability to be used in the result set for this statement.
Returns:
A new CallableStatement.
Throws:
SQLException - If an error occurs.
Since:
1.4

prepareStatement

public PreparedStatement prepareStatement(String sql)
            throws SQLException
This method creates a new PreparedStatement for the specified SQL string. This method is designed for use with parameterized statements. The default result set type and concurrency will be used.
Parameters:
sql - The SQL statement to use in creating this PreparedStatement.
Returns:
A new PreparedStatement.
Throws:
SQLException - If an error occurs.

prepareStatement

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

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency)
            throws SQLException
This method creates a new PreparedStatement for the specified SQL string. This method is designed for use with parameterized statements. The specified result set type and concurrency will be used. Valid values for these parameters are specified in the ResultSet class.
Parameters:
sql - The SQL statement to use in creating this PreparedStatement.
resultSetType - The type of result set to use for this statement.
resultSetConcurrency - The type of concurrency to be used in the result set for this statement.
Returns:
A new PreparedStatement.
Throws:
SQLException - If an error occurs.

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
            throws SQLException
This method creates a new PreparedStatement for the specified SQL string. This method is designed for use with parameterized statements. The specified result set type, concurrency and holdability will be used. Valid values for these parameters are specified in the ResultSet class.
Parameters:
sql - The SQL statement to use in creating this PreparedStatement.
resultSetType - The type of result set to use for this statement.
resultSetConcurrency - The type of concurrency to be used in the result set for this statement.
resultSetHoldability - The type of holdability to be usd in the result set for this statement.
Returns:
A new PreparedStatement.
Throws:
SQLException - If an error occurs.
Since:
1.4

prepareStatement

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

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          String[] columnNames)
            throws SQLException
Since:
1.4

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
            throws SQLException
Removes the specified savepoint from this Connection. Refering to a savepoint after it was removed is an error and will throw an SQLException.
Parameters:
savepoint - The savepoint to release.
Throws:
SQLException - If an error occurs.
Since:
1.4

rollback

public void rollback()
            throws SQLException
This method rolls back any SQL statements executed on this connection since the last commit or rollback.
Throws:
SQLException - If an error occurs.

rollback

public void rollback(Savepoint savepoint)
            throws SQLException
Undoes all changes made after the specified savepoint was set.
Parameters:
savepoint - The safepoint to roll back to.
Throws:
SQLException - If an error occurs.
Since:
1.4

setAutoCommit

public void setAutoCommit(boolean autoCommit)
            throws SQLException
This method turns auto commit mode on or off. In auto commit mode, every SQL statement is committed its own transaction. Otherwise a transaction must be explicitly committed or rolled back.
Parameters:
autoCommit - true to enable auto commit mode, false to disable it.
Throws:
SQLException - If an error occurs.

setCatalog

public void setCatalog(String catalog)
            throws SQLException
This method sets the name of the catalog in use by this connection. Note that this method does nothing if catalogs are not supported by this database.
Parameters:
catalog - The name of the catalog to use for this connection.
Throws:
SQLException - If an error occurs.

setHoldability

public void setHoldability(int holdability)
            throws SQLException
Sets the default holdability of ResultSetS that are created from StatementS using this Connection.
Parameters:
holdability - The default holdability value to set, this must be one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT.
Throws:
SQLException - If an error occurs.
Since:
1.4
See Also:
ResultSet

setReadOnly

public void setReadOnly(boolean readOnly)
            throws SQLException
This method turns read only mode on or off. It may not be called while a transaction is in progress.
Parameters:
readOnly - true if this connection is read only, false otherwise.
Throws:
SQLException - If an error occurs.

setSavepoint

public Savepoint setSavepoint()
            throws SQLException
Creates a new unnamed savepoint for this Connection
Returns:
The Savepoint object representing the savepoint.
Throws:
SQLException - If an error occurs.
Since:
1.4

setSavepoint

public Savepoint setSavepoint(String name)
            throws SQLException
Creates a new savepoint with the specifiend name for this Connection.
Parameters:
name - The name of the savepoint.
Returns:
The Savepoint object representing the savepoint.
Throws:
SQLException - If an error occurs.
Since:
1.4

setTransactionIsolation

public void setTransactionIsolation(int level)
            throws SQLException
This method sets the current transaction isolation mode. This must be one of the constants defined in this interface.
Parameters:
level - The transaction isolation level.
Throws:
SQLException - If an error occurs.

setTypeMap

public void setTypeMap(Map> map)
            throws SQLException
This method sets the mapping table for SQL types to Java classes. Any entries in this map override the defaults.
Parameters:
map - The new SQL mapping table.
Throws:
SQLException - If an error occurs.

Connection.java -- Manage a database connection. 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.