java.sql

Interface Connection

public interface Connection

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

Field Summary
int	TRANSACTION_NONE This transaction isolation level indicates that transactions are not supported.
int	TRANSACTION_READ_COMMITTED This transaction isolation level indicates that only committed data from other transactions will be read.
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.
int	TRANSACTION_REPEATABLE_READ This transaction isolation level indicates that only committed data from other transactions will be read.
int	TRANSACTION_SERIALIZABLE This transaction isolation level indicates that only committed data from other transactions will be read.

Method Summary
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 `ResultSet`S that are created from `Statement`S 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.
Map<String,Class<?>>	getTypeMap() This method returns the mapping of SQL types to Java classes currently in use by this connection.
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 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 autoGeneratedKeys)
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 `ResultSet`S that are created from `Statement`S 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<String,Class<?>> map) This method sets the mapping table for SQL types to Java classes.

Field Detail

TRANSACTION_NONE

public int TRANSACTION_NONE

This transaction isolation level indicates that transactions are not supported.

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.

TRANSACTION_READ_UNCOMMITTED

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

TRANSACTION_REPEATABLE_READ

public int TRANSACTION_REPEATABLE_READ

TRANSACTION_SERIALIZABLE

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

Method Detail

clearWarnings

public void clearWarnings()

This method clears all warnings that have occurred on this connection.

Throws: SQLException If an error occurs.

close

public void close()

This method immediately closes this database connection.

Throws: SQLException If an error occurs.

commit

public void commit()

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()

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.

createStatement

public Statement createStatement(int resultSetType, int resultSetConcurrency)

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)

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

getAutoCommit

public boolean getAutoCommit()

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()

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()

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

getMetaData

public DatabaseMetaData getMetaData()

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()

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.

getTypeMap

public Map<String,Class<?>> getTypeMap()

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.

getWarnings

public SQLWarning getWarnings()

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()

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()

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)

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)

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)

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)

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.

Returns: A new CallableStatement.

Throws: SQLException If an error occurs.

Since: 1.4

prepareStatement

public PreparedStatement prepareStatement(String sql)

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 resultSetType, int resultSetConcurrency)

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.

Returns: A new PreparedStatement.

Throws: SQLException If an error occurs.

prepareStatement

public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)

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.

Returns: A new PreparedStatement.

Throws: SQLException If an error occurs.

Since: 1.4

prepareStatement

public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys)

Since: 1.4

prepareStatement

public PreparedStatement prepareStatement(String sql, int[] columnIndexes)

Since: 1.4

prepareStatement

public PreparedStatement prepareStatement(String sql, String[] columnNames)

Since: 1.4

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)

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()

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)

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)

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)

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)

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