java.sql

Interface Connection

All Superinterfaces:

AutoCloseable

public interface Connection
extends AutoCloseable

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

Field Summary

Fields

Modifier and Type	Field and Description
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

Methods

Modifier and Type	Method and Description
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.
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 autoGeneratedKeys)
PreparedStatement	prepareStatement(String sql, int[] columnIndexes)
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, 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<String,Class<?>> map) This method sets the mapping table for SQL types to Java classes.

Field Detail

TRANSACTION_NONE

static final int TRANSACTION_NONE

This transaction isolation level indicates that transactions are not supported.

See Also:

Constant Field Values

TRANSACTION_READ_UNCOMMITTED

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.

See Also:

Constant Field Values

TRANSACTION_READ_COMMITTED

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.

See Also:

Constant Field Values

TRANSACTION_REPEATABLE_READ

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.

See Also:

Constant Field Values

TRANSACTION_SERIALIZABLE

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.

See Also:

Constant Field Values

Method Detail

createStatement

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

prepareStatement

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.

See Also:

PreparedStatement

prepareCall

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.

See Also:

CallableStatement

nativeSQL

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.

setAutoCommit

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.

See Also:

commit(), rollback()

getAutoCommit

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.

See Also:

commit(), rollback()

commit

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.

rollback

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.

close

void close()
           throws SQLException

This method immediately closes this database connection.

Specified by:

close in interface AutoCloseable

Throws:

SQLException - If an error occurs.

isClosed

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.

getMetaData

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.

See Also:

DatabaseMetaData

setReadOnly

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.

isReadOnly

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.

setCatalog

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.

getCatalog

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.

setTransactionIsolation

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.

getTransactionIsolation

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

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.

clearWarnings

void clearWarnings()
                   throws SQLException

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

Throws:

SQLException - If an error occurs.

createStatement

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.

See Also:

Statement, ResultSet

prepareStatement

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.

See Also:

PreparedStatement, ResultSet

prepareCall

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.

See Also:

CallableStatement, ResultSet

getTypeMap

Map<String,Class<?>> 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.

setTypeMap

void setTypeMap(Map<String,Class<?>> 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.

setHoldability

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

getHoldability

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

setSavepoint

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

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

rollback

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

releaseSavepoint

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

createStatement

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

prepareStatement

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

See Also:

PreparedStatement, ResultSet

prepareCall

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

See Also:

CallableStatement, ResultSet

prepareStatement

PreparedStatement prepareStatement(String sql,
                                 int autoGeneratedKeys)
                                   throws SQLException

Throws:

SQLException

Since:

1.4

prepareStatement

PreparedStatement prepareStatement(String sql,
                                 int[] columnIndexes)
                                   throws SQLException

Throws:

SQLException

Since:

1.4

prepareStatement

PreparedStatement prepareStatement(String sql,
                                 String[] columnNames)
                                   throws SQLException

Throws:

SQLException

Since:

1.4