This interface provides methods for managing a connection to a database.
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.
- The SQL type to Java class mapping.
clearWarnings
public void clearWarnings()
throws SQLException
This method clears all warnings that have occurred on this connection.
close
public void close()
throws SQLException
This method immediately closes this database connection.
commit
public void commit()
throws SQLException
This method commits any SQL statements executed on this connection since
the last commit or rollback.
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.
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.
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.
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.
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.
true
if auto commit mode is enabled,
false
otherwise.
getCatalog
public String getCatalog()
throws SQLException
This method returns the name of the catalog in use by this connection,
if any.
- The name of the catalog, or
null
if none
exists or catalogs are not supported by this database.
getHoldability
public int getHoldability()
throws SQLException
Gets the default holdability of ResultSet
S that are created
from Statement
S using this Connection
.
- The current default holdability value, this must be one of
ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
.
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.
- The transaction isolation level.
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.
- The first
SQLWarning
that occurred, or
null
if there have been no warnings.
isClosed
public boolean isClosed()
throws SQLException
This method tests whether or not this connection has been closed.
true
if the connection is closed, false
otherwise.
isReadOnly
public boolean isReadOnly()
throws SQLException
This method tests whether or not this connection is in read only mode.
true
if the connection is read only false
otherwise.
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.
sql
- The JDBC generic SQL statement.
- The native SQL statement.
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.
sql
- The SQL statement to use in creating this
CallableStatement
.
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.
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.
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.
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.
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.
sql
- The SQL statement to use in creating this
PreparedStatement
.
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.
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.
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.
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.
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.
savepoint
- The savepoint to release.
rollback
public void rollback()
throws SQLException
This method rolls back any SQL statements executed on this connection
since the last commit or rollback.
rollback
public void rollback(Savepoint savepoint)
throws SQLException
Undoes all changes made after the specified savepoint was set.
savepoint
- The safepoint to roll back to.
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.
autoCommit
- true
to enable auto commit mode,
false
to disable it.
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.
catalog
- The name of the catalog to use for this connection.
setHoldability
public void setHoldability(int holdability)
throws SQLException
Sets the default holdability of ResultSet
S that are created
from Statement
S using this Connection
.
holdability
- The default holdability value to set, this must be one
of ResultSet.HOLD_CURSORS_OVER_COMMIT
or
ResultSet.CLOSE_CURSORS_AT_COMMIT
.
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.
readOnly
- true
if this connection is read only,
false
otherwise.
setSavepoint
public Savepoint setSavepoint(String name)
throws SQLException
Creates a new savepoint with the specifiend name for this
Connection
.
name
- The name of the savepoint.
- The
Savepoint
object representing the savepoint.
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.
level
- The transaction isolation level.
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.
map
- The new SQL mapping table.
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.