Movatterモバイル変換

Java™ Platform
Standard Ed. 6

Interface Connection

All Superinterfaces:: Wrapper

public interfaceConnection extendsWrapper
extendsWrapper

A connection (session) with a specific database. SQL statements are executed and results are returned within the context of a connection.

AConnection object's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is obtained with thegetMetaData method.

Note: When configuring aConnection, JDBC applications should use the appropritateConnection method such assetAutoCommit orsetTransactionIsolation. Applications should not invoke SQL commands directly to change the connection's configuration when there is a JDBC method available. By default aConnection object is in auto-commit mode, which means that it automatically commits changes after executing each statement. If auto-commit mode has been disabled, the methodcommit must be called explicitly in order to commit changes; otherwise, database changes will not be saved.

A newConnection object created using the JDBC 2.1 core API has an initially empty type map associated with it. A user may enter a custom mapping for a UDT in this type map. When a UDT is retrieved from a data source with the methodResultSet.getObject, thegetObject method will check the connection's type map to see if there is an entry for that UDT. If so, thegetObject method will map the UDT to the class indicated. If there is no entry, the UDT will be mapped using the standard mapping.

A user may create a new type map, which is ajava.util.Map object, make an entry in it, and pass it to thejava.sql methods that can perform custom mapping. In this case, the method will use the given type map instead of the one associated with the connection.

For example, the following code fragment specifies that the SQL typeATHLETES will be mapped to the classAthletes in the Java programming language. The code fragment retrieves the type map for theConnection objectcon, inserts the entry into it, and then sets the type map with the new entry as the connection's type map.

      java.util.Map map = con.getTypeMap();      map.put("mySchemaName.ATHLETES", Class.forName("Athletes"));      con.setTypeMap(map);

See Also:: DriverManager.getConnection(java.lang.String, java.util.Properties),Statement,ResultSet,DatabaseMetaData


	`TRANSACTION_NONE` A constant indicating that transactions are not supported.
	`TRANSACTION_READ_COMMITTED` A constant indicating that dirty reads are prevented; non-repeatable reads and phantom reads can occur.
	`TRANSACTION_READ_UNCOMMITTED` A constant indicating that dirty reads, non-repeatable reads and phantom reads can occur.
	`TRANSACTION_REPEATABLE_READ` A constant indicating that dirty reads and non-repeatable reads are prevented; phantom reads can occur.
	`TRANSACTION_SERIALIZABLE` A constant indicating that dirty reads, non-repeatable reads and phantom reads are prevented.


	`clearWarnings()` Clears all warnings reported for this`Connection` object.
	`close()` Releases this`Connection` object's database and JDBC resources immediately instead of waiting for them to be automatically released.
	`commit()` Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this`Connection` object.
	`createArrayOf(String typeName,Object[] elements)` Factory method for creating Array objects.
	`createBlob()` Constructs an object that implements the`Blob` interface.
	`createClob()` Constructs an object that implements the`Clob` interface.
	`createNClob()` Constructs an object that implements the`NClob` interface.
	`createSQLXML()` Constructs an object that implements the`SQLXML` interface.
	`createStatement()` Creates a`Statement` object for sending SQL statements to the database.
	`createStatement(int resultSetType, int resultSetConcurrency)` Creates a`Statement` object that will generate`ResultSet` objects with the given type and concurrency.
	`createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Creates a`Statement` object that will generate`ResultSet` objects with the given type, concurrency, and holdability.
	`createStruct(String typeName,Object[] attributes)` Factory method for creating Struct objects.
	`getAutoCommit()` Retrieves the current auto-commit mode for this`Connection` object.
	`getCatalog()` Retrieves this`Connection` object's current catalog name.
	`getClientInfo()` Returns a list containing the name and current value of each client info property supported by the driver.
	`getClientInfo(String name)` Returns the value of the client info property specified by name.
	`getHoldability()` Retrieves the current holdability of`ResultSet` objects created using this`Connection` object.
	`getMetaData()` Retrieves a`DatabaseMetaData` object that contains metadata about the database to which this`Connection` object represents a connection.
	`getTransactionIsolation()` Retrieves this`Connection` object's current transaction isolation level.
	`getTypeMap()` Retrieves the`Map` object associated with this`Connection` object.
	`getWarnings()` Retrieves the first warning reported by calls on this`Connection` object.
	`isClosed()` Retrieves whether this`Connection` object has been closed.
	`isReadOnly()` Retrieves whether this`Connection` object is in read-only mode.
	`isValid(int timeout)` Returns true if the connection has not been closed and is still valid.
	`nativeSQL(String sql)` Converts the given SQL statement into the system's native SQL grammar.
	`prepareCall(String sql)` Creates a`CallableStatement` object for calling database stored procedures.
	`prepareCall(String sql, int resultSetType, int resultSetConcurrency)` Creates a`CallableStatement` object that will generate`ResultSet` objects with the given type and concurrency.
	`prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Creates a`CallableStatement` object that will generate`ResultSet` objects with the given type and concurrency.
	`prepareStatement(String sql)` Creates a`PreparedStatement` object for sending parameterized SQL statements to the database.
	`prepareStatement(String sql, int autoGeneratedKeys)` Creates a default`PreparedStatement` object that has the capability to retrieve auto-generated keys.
	`prepareStatement(String sql, int[] columnIndexes)` Creates a default`PreparedStatement` object capable of returning the auto-generated keys designated by the given array.
	`prepareStatement(String sql, int resultSetType, int resultSetConcurrency)` Creates a`PreparedStatement` object that will generate`ResultSet` objects with the given type and concurrency.
	`prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)` Creates a`PreparedStatement` object that will generate`ResultSet` objects with the given type, concurrency, and holdability.
	`prepareStatement(String sql,String[] columnNames)` Creates a default`PreparedStatement` object capable of returning the auto-generated keys designated by the given array.
	`releaseSavepoint(Savepoint savepoint)` Removes the specified`Savepoint` and subsequent`Savepoint` objects from the current transaction.
	`rollback()` Undoes all changes made in the current transaction and releases any database locks currently held by this`Connection` object.
	`rollback(Savepoint savepoint)` Undoes all changes made after the given`Savepoint` object was set.
	`setAutoCommit(boolean autoCommit)` Sets this connection's auto-commit mode to the given state.
	`setCatalog(String catalog)` Sets the given catalog name in order to select a subspace of this`Connection` object's database in which to work.
	`setClientInfo(Properties properties)` Sets the value of the connection's client info properties.
	`setClientInfo(String name,String value)` Sets the value of the client info property specified by name to the value specified by value.
	`setHoldability(int holdability)` Changes the default holdability of`ResultSet` objects created using this`Connection` object to the given holdability.
	`setReadOnly(boolean readOnly)` Puts this connection in read-only mode as a hint to the driver to enable database optimizations.
	`setSavepoint()` Creates an unnamed savepoint in the current transaction and returns the new`Savepoint` object that represents it.
	`setSavepoint(String name)` Creates a savepoint with the given name in the current transaction and returns the new`Savepoint` object that represents it.
	`setTransactionIsolation(int level)` Attempts to change the transaction isolation level for this`Connection` object to the one given.
	`setTypeMap(Map<String,Class<?>> map)` Installs the given`TypeMap` object as the type map for this`Connection` object.

Methods inherited from interface java.sql.Wrapper
`isWrapperFor,unwrap`

TRANSACTION_NONE

static final intTRANSACTION_NONE

A constant indicating that transactions are not supported.

See Also:: Constant Field Values

TRANSACTION_READ_UNCOMMITTED

static final intTRANSACTION_READ_UNCOMMITTED

A constant indicating that dirty reads, non-repeatable reads and phantom reads can occur. This level allows a row changed by one transaction to be read by another transaction before any changes in that row have been committed (a "dirty read"). If any of the changes are rolled back, the second transaction will have retrieved an invalid row.

See Also:: Constant Field Values

TRANSACTION_READ_COMMITTED

static final intTRANSACTION_READ_COMMITTED

A constant indicating that dirty reads are prevented; non-repeatable reads and phantom reads can occur. This level only prohibits a transaction from reading a row with uncommitted changes in it.

See Also:: Constant Field Values

TRANSACTION_REPEATABLE_READ

static final intTRANSACTION_REPEATABLE_READ

A constant indicating that dirty reads and non-repeatable reads are prevented; phantom reads can occur. This level prohibits a transaction from reading a row with uncommitted changes in it, and it also prohibits the situation where one transaction reads a row, a second transaction alters the row, and the first transaction rereads the row, getting different values the second time (a "non-repeatable read").

See Also:: Constant Field Values

TRANSACTION_SERIALIZABLE

static final intTRANSACTION_SERIALIZABLE

A constant indicating that dirty reads, non-repeatable reads and phantom reads are prevented. This level includes the prohibitions inTRANSACTION_REPEATABLE_READ and further prohibits the situation where one transaction reads all rows that satisfy aWHERE condition, a second transaction inserts a row that satisfies thatWHERE condition, and the first transaction rereads for the same condition, retrieving the additional "phantom" row in the second read.

See Also:: Constant Field Values

createStatement

StatementcreateStatement()                          throwsSQLException

Creates aStatement object for sending SQL statements to the database. SQL statements without parameters are normally executed usingStatement objects. If the same SQL statement is executed many times, it may be more efficient to use aPreparedStatement object.

Result sets created using the returnedStatement object will by default be typeTYPE_FORWARD_ONLY and have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().

Returns:: a new defaultStatement object
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection

prepareStatement

PreparedStatementprepareStatement(String sql)                                   throwsSQLException

Creates aPreparedStatement object for sending parameterized SQL statements to the database.

A SQL statement with or without IN parameters can be pre-compiled and stored in aPreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the methodprepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until thePreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certainSQLException objects.

Result sets created using the returnedPreparedStatement object will by default be typeTYPE_FORWARD_ONLY and have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().

Parameters:: sql - an SQL statement that may contain one or more '?' IN parameter placeholders
Returns:: a new defaultPreparedStatement object containing the pre-compiled SQL statement
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection

prepareCall

CallableStatementprepareCall(String sql)                              throwsSQLException

Creates aCallableStatement object for calling database stored procedures. TheCallableStatement object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

Note: This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the methodprepareCall is done; others may wait until theCallableStatement object is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.

Result sets created using the returnedCallableStatement object will by default be typeTYPE_FORWARD_ONLY and have a concurrency level ofCONCUR_READ_ONLY. The holdability of the created result sets can be determined by callinggetHoldability().

Parameters:: sql - an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is specified using JDBC call escape syntax.
Returns:: a new defaultCallableStatement object containing the pre-compiled SQL statement
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection

nativeSQL

StringnativeSQL(String sql)                 throwsSQLException

Converts the given SQL statement into the system's native SQL grammar. A driver may convert the JDBC SQL grammar into its system's native SQL grammar prior to sending it. This method returns the native form of the statement that the driver would have sent.

Parameters:: sql - an SQL statement that may contain one or more '?' parameter placeholders
Returns:: the native form of this statement
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection

setAutoCommit

voidsetAutoCommit(boolean autoCommit)                   throwsSQLException

Sets this connection's auto-commit mode to the given state. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the methodcommit or the methodrollback. By default, new connections are in auto-commit mode.

The commit occurs when the statement completes. The time when the statement completes depends on the type of SQL Statement:

For DML statements, such as Insert, Update or Delete, and DDL statements, the statement is complete as soon as it has finished executing.
For Select statements, the statement is complete when the associated result set is closed.
ForCallableStatement objects or for statements that return multiple results, the statement is complete when all of the associated result sets have been closed, and all update counts and output parameters have been retrieved.

NOTE: If this method is called during a transaction and the auto-commit mode is changed, the transaction is committed. IfsetAutoCommit is called and the auto-commit mode is not changed, the call is a no-op.

Parameters:: autoCommit -true to enable auto-commit mode;false to disable it
Throws:: SQLException - if a database access error occurs, setAutoCommit(true) is called while participating in a distributed transaction, or this method is called on a closed connection
See Also:: getAutoCommit()

getAutoCommit

booleangetAutoCommit()                      throwsSQLException

Retrieves the current auto-commit mode for thisConnection object.

Returns:: the current state of thisConnection object's auto-commit mode
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection
See Also:: setAutoCommit(boolean)

commit

voidcommit()            throwsSQLException

Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by thisConnection object. This method should be used only when auto-commit mode has been disabled.

Throws:: SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, if this method is called on a closed conection or thisConnection object is in auto-commit mode
See Also:: setAutoCommit(boolean)

rollback

voidrollback()              throwsSQLException

Undoes all changes made in the current transaction and releases any database locks currently held by thisConnection object. This method should be used only when auto-commit mode has been disabled.

Throws:: SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or thisConnection object is in auto-commit mode
See Also:: setAutoCommit(boolean)

close

voidclose()           throwsSQLException

Releases thisConnection object's database and JDBC resources immediately instead of waiting for them to be automatically released.

Calling the methodclose on aConnection object that is already closed is a no-op.

It isstrongly recommended that an application explicitly commits or rolls back an active transaction prior to calling theclose method. If theclose method is called and there is an active transaction, the results are implementation-defined.

Throws:: SQLException - SQLException if a database access error occurs

isClosed

booleanisClosed()                 throwsSQLException

Retrieves whether thisConnection object has been closed. A connection is closed if the methodclose has been called on it or if certain fatal errors have occurred. This method is guaranteed to returntrue only when it is called after the methodConnection.close has been called.

This method generally cannot be called to determine whether a connection to a database is valid or invalid. A typical client can determine that a connection is invalid by catching any exceptions that might be thrown when an operation is attempted.

Returns:: true if thisConnection object is closed;false if it is still open
Throws:: SQLException - if a database access error occurs

getMetaData

DatabaseMetaDatagetMetaData()                             throwsSQLException

Retrieves aDatabaseMetaData object that contains metadata about the database to which thisConnection object represents a connection. The metadata includes information about the database's tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on.

Returns:: aDatabaseMetaData object for thisConnection object
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection

setReadOnly

voidsetReadOnly(boolean readOnly)                 throwsSQLException

Puts this connection in read-only mode as a hint to the driver to enable database optimizations.

Note: This method cannot be called during a transaction.

Parameters:: readOnly -true enables read-only mode;false disables it
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or this method is called during a transaction

isReadOnly

booleanisReadOnly()                   throwsSQLException

Retrieves whether thisConnection object is in read-only mode.

Returns:: true if thisConnection object is read-only;false otherwise
Throws:: SQLException - SQLException if a database access error occurs or this method is called on a closed connection

setCatalog

voidsetCatalog(String catalog)                throwsSQLException

Sets the given catalog name in order to select a subspace of thisConnection object's database in which to work.

If the driver does not support catalogs, it will silently ignore this request.

Parameters:: catalog - the name of a catalog (subspace in thisConnection object's database) in which to work
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection
See Also:: getCatalog()

getCatalog

StringgetCatalog()                  throwsSQLException

Retrieves thisConnection object's current catalog name.

Returns:: the current catalog name ornull if there is none
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection
See Also:: setCatalog(java.lang.String)

setTransactionIsolation

voidsetTransactionIsolation(int level)                             throwsSQLException

Attempts to change the transaction isolation level for thisConnection object to the one given. The constants defined in the interfaceConnection are the possible transaction isolation levels.

Note: If this method is called during a transaction, the result is implementation-defined.

Parameters:: level - one of the followingConnection constants:Connection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_REPEATABLE_READ, orConnection.TRANSACTION_SERIALIZABLE. (Note thatConnection.TRANSACTION_NONE cannot be used because it specifies that transactions are not supported.)
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not one of theConnection constants
See Also:: DatabaseMetaData.supportsTransactionIsolationLevel(int),getTransactionIsolation()

getTransactionIsolation

intgetTransactionIsolation()                            throwsSQLException

Retrieves thisConnection object's current transaction isolation level.

Returns:: the current transaction isolation level, which will be one of the following constants:Connection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_REPEATABLE_READ,Connection.TRANSACTION_SERIALIZABLE, orConnection.TRANSACTION_NONE.
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection
See Also:: setTransactionIsolation(int)

getWarnings

SQLWarninggetWarnings()                       throwsSQLException

Retrieves the first warning reported by calls on thisConnection object. If there is more than one warning, subsequent warnings will be chained to the first one and can be retrieved by calling the methodSQLWarning.getNextWarning on the warning that was retrieved previously.

This method may not be called on a closed connection; doing so will cause anSQLException to be thrown.

Note: Subsequent warnings will be chained to this SQLWarning.

Returns:: the firstSQLWarning object ornull if there are none
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection
See Also:: SQLWarning

clearWarnings

voidclearWarnings()                   throwsSQLException

Clears all warnings reported for thisConnection object. After a call to this method, the methodgetWarnings returnsnull until a new warning is reported for thisConnection object.

Throws:: SQLException - SQLException if a database access error occurs or this method is called on a closed connection

createStatement

StatementcreateStatement(int resultSetType,                          int resultSetConcurrency)                          throwsSQLException

Creates aStatement object that will generateResultSet objects with the given type and concurrency. This method is the same as thecreateStatement method above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by callinggetHoldability().

Parameters:: resultSetType - a result set type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE; resultSetConcurrency - a concurrency type; one ofResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE
Returns:: a newStatement object that will generateResultSet objects with the given type and concurrency
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSet constants indicating type and concurrency; SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.
Since:: 1.2

prepareStatement

PreparedStatementprepareStatement(String sql,                                   int resultSetType,                                   int resultSetConcurrency)                                   throwsSQLException

Creates aPreparedStatement object that will generateResultSet objects with the given type and concurrency. This method is the same as theprepareStatement method above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by callinggetHoldability().

Parameters:: sql - aString object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters; resultSetType - a result set type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE; resultSetConcurrency - a concurrency type; one ofResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE
Returns:: a new PreparedStatement object containing the pre-compiled SQL statement that will produceResultSet objects with the given type and concurrency
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSet constants indicating type and concurrency; SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.
Since:: 1.2

prepareCall

CallableStatementprepareCall(String sql,                              int resultSetType,                              int resultSetConcurrency)                              throwsSQLException

Creates aCallableStatement object that will generateResultSet objects with the given type and concurrency. This method is the same as theprepareCall method above, but it allows the default result set type and concurrency to be overridden. The holdability of the created result sets can be determined by callinggetHoldability().

Parameters:: sql - aString object that is the SQL statement to be sent to the database; may contain on or more '?' parameters; resultSetType - a result set type; one ofResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE; resultSetConcurrency - a concurrency type; one ofResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE
Returns:: a newCallableStatement object containing the pre-compiled SQL statement that will produceResultSet objects with the given type and concurrency
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSet constants indicating type and concurrency; SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type and result set concurrency.
Since:: 1.2

getTypeMap

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

Retrieves theMap object associated with thisConnection object. Unless the application has added an entry, the type map returned will be empty.

Returns:: thejava.util.Map object associated with thisConnection object
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection; SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:: 1.2
See Also:: setTypeMap(java.util.Map>)

setTypeMap

voidsetTypeMap(Map<String,Class<?>> map)                throwsSQLException

Installs the givenTypeMap object as the type map for thisConnection object. The type map will be used for the custom mapping of SQL structured types and distinct types.

Parameters:: map - thejava.util.Map object to install as the replacement for thisConnection object's default type map
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not ajava.util.Map object; SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:: 1.2
See Also:: getTypeMap()

setHoldability

voidsetHoldability(int holdability)                    throwsSQLException

Changes the default holdability ofResultSet objects created using thisConnection object to the given holdability. The default holdability ofResultSet objects can be be determined by invokingDatabaseMetaData.getResultSetHoldability().

Parameters:: holdability - aResultSet holdability constant; one ofResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:: SQLException - if a database access occurs, this method is called on a closed connection, or the given parameter is not aResultSet constant indicating holdability; SQLFeatureNotSupportedException - if the given holdability is not supported
Since:: 1.4
See Also:: getHoldability(),DatabaseMetaData.getResultSetHoldability(),ResultSet

getHoldability

intgetHoldability()                   throwsSQLException

Retrieves the current holdability ofResultSet objects created using thisConnection object.

Returns:: the holdability, one ofResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection
Since:: 1.4
See Also:: setHoldability(int),DatabaseMetaData.getResultSetHoldability(),ResultSet

setSavepoint

SavepointsetSavepoint()                       throwsSQLException

Creates an unnamed savepoint in the current transaction and returns the newSavepoint object that represents it.

if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.

Returns:: the newSavepoint object
Throws:: SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or thisConnection object is currently in auto-commit mode; SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:: 1.4
See Also:: Savepoint

setSavepoint

SavepointsetSavepoint(String name)                       throwsSQLException

Creates a savepoint with the given name in the current transaction and returns the newSavepoint object that represents it.

if setSavepoint is invoked outside of an active transaction, a transaction will be started at this newly created savepoint.

Parameters:: name - aString containing the name of the savepoint
Returns:: the newSavepoint object
Throws:: SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection or thisConnection object is currently in auto-commit mode; SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:: 1.4
See Also:: Savepoint

rollback

voidrollback(Savepoint savepoint)              throwsSQLException

Undoes all changes made after the givenSavepoint object was set.

This method should be used only when auto-commit has been disabled.

Parameters:: savepoint - theSavepoint object to roll back to
Throws:: SQLException - if a database access error occurs, this method is called while participating in a distributed transaction, this method is called on a closed connection, theSavepoint object is no longer valid, or thisConnection object is currently in auto-commit mode; SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:: 1.4
See Also:: Savepoint,rollback()

releaseSavepoint

voidreleaseSavepoint(Savepoint savepoint)                      throwsSQLException

Removes the specifiedSavepoint and subsequentSavepoint objects from the current transaction. Any reference to the savepoint after it have been removed will cause anSQLException to be thrown.

Parameters:: savepoint - theSavepoint object to be removed
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the givenSavepoint object is not a valid savepoint in the current transaction; SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:: 1.4

createStatement

StatementcreateStatement(int resultSetType,                          int resultSetConcurrency,                          int resultSetHoldability)                          throwsSQLException

Creates aStatement object that will generateResultSet objects with the given type, concurrency, and holdability. This method is the same as thecreateStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Parameters:: resultSetType - one of the followingResultSet constants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE; resultSetConcurrency - one of the followingResultSet constants:ResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE; resultSetHoldability - one of the followingResultSet constants:ResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:: a newStatement object that will generateResultSet objects with the given type, concurrency, and holdability
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSet constants indicating type, concurrency, and holdability; SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.
Since:: 1.4
See Also:: ResultSet

prepareStatement

PreparedStatementprepareStatement(String sql,                                   int resultSetType,                                   int resultSetConcurrency,                                   int resultSetHoldability)                                   throwsSQLException

Creates aPreparedStatement object that will generateResultSet objects with the given type, concurrency, and holdability.

This method is the same as theprepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Parameters:: sql - aString object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters; resultSetType - one of the followingResultSet constants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE; resultSetConcurrency - one of the followingResultSet constants:ResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE; resultSetHoldability - one of the followingResultSet constants:ResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:: a newPreparedStatement object, containing the pre-compiled SQL statement, that will generateResultSet objects with the given type, concurrency, and holdability
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSet constants indicating type, concurrency, and holdability; SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.
Since:: 1.4
See Also:: ResultSet

prepareCall

CallableStatementprepareCall(String sql,                              int resultSetType,                              int resultSetConcurrency,                              int resultSetHoldability)                              throwsSQLException

Creates aCallableStatement object that will generateResultSet objects with the given type and concurrency. This method is the same as theprepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Parameters:: sql - aString object that is the SQL statement to be sent to the database; may contain on or more '?' parameters; resultSetType - one of the followingResultSet constants:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE; resultSetConcurrency - one of the followingResultSet constants:ResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE; resultSetHoldability - one of the followingResultSet constants:ResultSet.HOLD_CURSORS_OVER_COMMIT orResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:: a newCallableStatement object, containing the pre-compiled SQL statement, that will generateResultSet objects with the given type, concurrency, and holdability
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are notResultSet constants indicating type, concurrency, and holdability; SQLFeatureNotSupportedException - if the JDBC driver does not support this method or this method is not supported for the specified result set type, result set holdability and result set concurrency.
Since:: 1.4
See Also:: ResultSet

prepareStatement

PreparedStatementprepareStatement(String sql,                                   int autoGeneratedKeys)                                   throwsSQLException

Creates a defaultPreparedStatement object that has the capability to retrieve auto-generated keys. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not anINSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

Parameters:: sql - an SQL statement that may contain one or more '?' IN parameter placeholders; autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one ofStatement.RETURN_GENERATED_KEYS orStatement.NO_GENERATED_KEYS
Returns:: a newPreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys
Throws:: SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not aStatement constant indicating whether auto-generated keys should be returned; SQLFeatureNotSupportedException - if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS
Since:: 1.4

prepareStatement

PreparedStatementprepareStatement(String sql,                                   int[] columnIndexes)                                   throwsSQLException

Creates a defaultPreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not anINSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

An SQL statement with or without IN parameters can be pre-compiled and stored in aPreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Parameters:: sql - an SQL statement that may contain one or more '?' IN parameter placeholders; columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows
Returns:: a newPreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection; SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:: 1.4

prepareStatement

PreparedStatementprepareStatement(String sql,String[] columnNames)                                   throwsSQLException

Creates a defaultPreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. The driver will ignore the array if the SQL statement is not anINSERT statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).

An SQL statement with or without IN parameters can be pre-compiled and stored in aPreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Parameters:: sql - an SQL statement that may contain one or more '?' IN parameter placeholders; columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows
Returns:: a newPreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names
Throws:: SQLException - if a database access error occurs or this method is called on a closed connection; SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:: 1.4

createClob

ClobcreateClob()                throwsSQLException

Constructs an object that implements theClob interface. The object returned initially contains no data. ThesetAsciiStream,setCharacterStream andsetString methods of theClob interface may be used to add data to theClob.

Returns:: An object that implements theClob interface
Throws:: SQLException - if an object that implements theClob interface can not be constructed, this method is called on a closed connection or a database access error occurs.; SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:: 1.6

createBlob

BlobcreateBlob()                throwsSQLException

Constructs an object that implements theBlob interface. The object returned initially contains no data. ThesetBinaryStream andsetBytes methods of theBlob interface may be used to add data to theBlob.

Returns:: An object that implements theBlob interface
Throws:: SQLException - if an object that implements theBlob interface can not be constructed, this method is called on a closed connection or a database access error occurs.; SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:: 1.6

createNClob

NClobcreateNClob()                  throwsSQLException

Constructs an object that implements theNClob interface. The object returned initially contains no data. ThesetAsciiStream,setCharacterStream andsetString methods of theNClob interface may be used to add data to theNClob.

Returns:: An object that implements theNClob interface
Throws:: SQLException - if an object that implements theNClob interface can not be constructed, this method is called on a closed connection or a database access error occurs.; SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:: 1.6

createSQLXML

SQLXMLcreateSQLXML()                    throwsSQLException

Constructs an object that implements theSQLXML interface. The object returned initially contains no data. ThecreateXmlStreamWriter object andsetString method of theSQLXML interface may be used to add data to theSQLXML object.

Returns:: An object that implements theSQLXML interface
Throws:: SQLException - if an object that implements theSQLXML interface can not be constructed, this method is called on a closed connection or a database access error occurs.; SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:: 1.6

isValid

booleanisValid(int timeout)                throwsSQLException

Returns true if the connection has not been closed and is still valid. The driver shall submit a query on the connection or use some other mechanism that positively verifies the connection is still valid when this method is called.

The query submitted by the driver to validate the connection shall be executed in the context of the current transaction.

Parameters:: timeout - - The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.
Returns:: true if the connection is valid, false otherwise
Throws:: SQLException - if the value supplied fortimeout is less then 0
Since:: 1.6
See Also:: DatabaseMetaData.getClientInfoProperties()

setClientInfo

voidsetClientInfo(String name,String value)                   throwsSQLClientInfoException

Sets the value of the client info property specified by name to the value specified by value.

Applications may use theDatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver and the maximum length that may be specified for each property.

The driver stores the value specified in a suitable location in the database. For example in a special register, session parameter, or system table column. For efficiency the driver may defer setting the value in the database until the next time a statement is executed or prepared. Other than storing the client information in the appropriate place in the database, these methods shall not alter the behavior of the connection in anyway. The values supplied to these methods are used for accounting, diagnostics and debugging purposes only.

The driver shall generate a warning if the client info name specified is not recognized by the driver.

If the value specified to this method is greater than the maximum length for the property the driver may either truncate the value and generate a warning or generate aSQLClientInfoException. If the driver generates aSQLClientInfoException, the value specified was not set on the connection.

The following are standard client info properties. Drivers are not required to support these properties however if the driver supports a client info property that can be described by one of the standard properties, the standard property name should be used.

ApplicationName - The name of the application currently utilizing the connection
ClientUser - The name of the user that the application using the connection is performing work for. This may not be the same as the user name that was used in establishing the connection.
ClientHostname - The hostname of the computer the application using the connection is running on.

Parameters:: name - The name of the client info property to set; value - The value to set the client info property to. If the value is null, the current value of the specified property is cleared.
Throws:: SQLClientInfoException - if the database server returns an error while setting the client info value on the database server or this method is called on a closed connection
Since:: 1.6

setClientInfo

voidsetClientInfo(Properties properties)                   throwsSQLClientInfoException

Sets the value of the connection's client info properties. TheProperties object contains the names and values of the client info properties to be set. The set of client info properties contained in the properties list replaces the current set of client info properties on the connection. If a property that is currently set on the connection is not present in the properties list, that property is cleared. Specifying an empty properties list will clear all of the properties on the connection. SeesetClientInfo (String, String) for more information.

If an error occurs in setting any of the client info properties, aSQLClientInfoException is thrown. TheSQLClientInfoException contains information indicating which client info properties were not set. The state of the client information is unknown because some databases do not allow multiple client info properties to be set atomically. For those databases, one or more properties may have been set before the error occurred.

Parameters:: properties - the list of client info properties to set
Throws:: SQLClientInfoException - if the database server returns an error while setting the clientInfo values on the database server or this method is called on a closed connection
Since:: 1.6
See Also:: setClientInfo(String, String)

getClientInfo

StringgetClientInfo(String name)                     throwsSQLException

Returns the value of the client info property specified by name. This method may return null if the specified client info property has not been set and does not have a default value. This method will also return null if the specified client info property name is not supported by the driver.

Applications may use theDatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver.

Parameters:: name - The name of the client info property to retrieve
Returns:: The value of the client info property specified
Throws:: SQLException - if the database server returns an error when fetching the client info value from the database or this method is called on a closed connection
Since:: 1.6
See Also:: DatabaseMetaData.getClientInfoProperties()

getClientInfo

PropertiesgetClientInfo()                         throwsSQLException

Returns a list containing the name and current value of each client info property supported by the driver. The value of a client info property may be null if the property has not been set and does not have a default value.

Returns:: AProperties object that contains the name and current value of each of the client info properties supported by the driver.
Throws:: SQLException - if the database server returns an error when fetching the client info values from the database or this method is called on a closed connection
Since:: 1.6

createArrayOf

ArraycreateArrayOf(String typeName,Object[] elements)                    throwsSQLException

Factory method for creating Array objects.

Note:WhencreateArrayOf is used to create an array object that maps to a primitive data type, then it is implementation-defined whether theArray object is an array of that primitive data type or an array ofObject.

Note:The JDBC driver is responsible for mapping the elementsObject array to the default JDBC SQL type defined in java.sql.Types for the given class ofObject. The default mapping is specified in Appendix B of the JDBC specification. If the resulting JDBC type is not the appropriate type for the given typeName then it is implementation defined whether anSQLException is thrown or the driver supports the resulting conversion.

Parameters:: typeName - the SQL name of the type the elements of the array map to. The typeName is a database-specific name which may be the name of a built-in type, a user-defined type or a standard SQL type supported by this database. This is the value returned byArray.getBaseTypeName; elements - the elements that populate the returned object
Returns:: an Array object whose elements map to the specified SQL type
Throws:: SQLException - if a database error occurs, the JDBC type is not appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connection; SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:: 1.6

createStruct

StructcreateStruct(String typeName,Object[] attributes)                    throwsSQLException

Factory method for creating Struct objects.

Parameters:: typeName - the SQL type name of the SQL structured type that thisStruct object maps to. The typeName is the name of a user-defined type that has been defined for this database. It is the value returned byStruct.getSQLTypeName.; attributes - the attributes that populate the returned object
Returns:: a Struct object that maps to the given SQL type and is populated with the given attributes
Throws:: SQLException - if a database error occurs, the typeName is null or this method is called on a closed connection; SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:: 1.6

Java™ Platform
Standard Ed. 6

[8]ページ先頭