Class CoreConnection
- java.lang.Object
-
- com.avoka.core.cayenne.CoreConnection
-
- All Implemented Interfaces:
AutoCloseable
,Connection
,Wrapper
public class CoreConnection extends Object implements Connection
Provides a core connection wrapper for JDBC Connection interface.- Since:
- 4.1.0
-
-
Field Summary
-
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
-
-
Constructor Summary
Constructors Constructor Description CoreConnection(Connection connection, Integer queryTimeout)
Create a monitored connection given a connection.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
abort(Executor executor)
void
clearWarnings()
Clear warnings.void
close()
Perform checking and logging before close the connection.static void
closeThreadLocalOpenConnections()
Close all thread local open connections.void
commit()
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object.Array
createArrayOf(String typeName, Object[] elements)
Creates the array of.Blob
createBlob()
Creates the blob.Clob
createClob()
Creates the clob.NClob
createNClob()
Creates the nclob.SQLXML
createSQLXML()
Creates the sqlxml.Statement
createStatement()
Creates aStatement
object for sending SQL statements to the database.Statement
createStatement(int resultSetType, int resultSetConcurrency)
Creates aStatement
object that will generateResultSet
objects with the given type and concurrency.Statement
createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
Creates aStatement
object that will generateResultSet
objects with the given type, concurrency, and holdability.Struct
createStruct(String typeName, Object[] attributes)
Creates the struct.boolean
getAutoCommit()
Retrieves the current auto-commit mode for thisConnection
object.String
getCatalog()
Retrieves thisConnection
object's current catalog name.Properties
getClientInfo()
Gets the client info.String
getClientInfo(String name)
Gets the client info.int
getHoldability()
Retrieves the current holdability ofResultSet
objects created using thisConnection
object.DatabaseMetaData
getMetaData()
Retrieves aDatabaseMetaData
object that contains metadata about the database to which thisConnection
object represents a connection.int
getNetworkTimeout()
Integer
getQueryTimeout()
Return the query timeout in seconds, using the threadlocal value if definedString
getSchema()
static Map<Integer,Connection>
getThreadLocalOpenConnections()
Return the thread local map of open connections, keyed on connection hashcode.int
getTransactionIsolation()
Retrieves thisConnection
object's current transaction isolation level.Map<String,Class<?>>
getTypeMap()
Retrieves theMap
object associated with thisConnection
object.SQLWarning
getWarnings()
Retrieves the first warning reported by calls on thisConnection
object.boolean
isClosed()
Retrieves whether thisConnection
object has been closed.boolean
isReadOnly()
Retrieves whether thisConnection
object is in read-only mode.boolean
isValid(int timeout)
Checks if is valid.boolean
isWrapperFor(Class<?> iface)
Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.String
nativeSQL(String sql)
Converts the given SQL statement into the system's native SQL grammar.CallableStatement
prepareCall(String sql)
Creates aCallableStatement
object for calling database stored procedures.CallableStatement
prepareCall(String sql, int resultSetType, int resultSetConcurrency)
Creates aCallableStatement
object that will generateResultSet
objects with the given type and concurrency.CallableStatement
prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
Creates aCallableStatement
object that will generateResultSet
objects with the given type and concurrency.PreparedStatement
prepareStatement(String sql)
Creates aPreparedStatement
object for sending parameterized SQL statements to the database.PreparedStatement
prepareStatement(String sql, int autoGeneratedKeys)
Creates a defaultPreparedStatement
object that has the capability to retrieve auto-generated keys.PreparedStatement
prepareStatement(String sql, int[] columnIndexes)
Creates a defaultPreparedStatement
object capable of returning the auto-generated keys designated by the given array.PreparedStatement
prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
Creates aPreparedStatement
object that will generateResultSet
objects with the given type and concurrency.PreparedStatement
prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
Creates aPreparedStatement
object that will generateResultSet
objects with the given type, concurrency, and holdability.PreparedStatement
prepareStatement(String sql, String[] columnNames)
Creates a defaultPreparedStatement
object capable of returning the auto-generated keys designated by the given array.void
releaseSavepoint(Savepoint savepoint)
Removes the givenSavepoint
object from the current transaction.void
rollback()
Undoes all changes made in the current transaction and releases any database locks currently held by thisConnection
object.void
rollback(Savepoint savepoint)
Undoes all changes made after the givenSavepoint
object was set.void
setAutoCommit(boolean autoCommit)
Sets this connection's auto-commit mode to the given state.void
setCatalog(String catalog)
Sets the given catalog name in order to select a subspace of thisConnection
object's database in which to work.void
setClientInfo(String name, String value)
Sets the client info.void
setClientInfo(Properties properties)
Sets the client info.void
setHoldability(int holdability)
Changes the holdability ofResultSet
objects created using thisConnection
object to the given holdability.void
setNetworkTimeout(Executor executor, int milliseconds)
void
setReadOnly(boolean readOnly)
Puts this connection in read-only mode as a hint to the driver to enable database optimizations.Savepoint
setSavepoint()
Creates an unnamed savepoint in the current transaction and returns the newSavepoint
object that represents it.Savepoint
setSavepoint(String name)
Creates a savepoint with the given name in the current transaction and returns the newSavepoint
object that represents it.void
setSchema(String schema)
static void
setThreadLocalQueryTimeout(Integer queryTimeout)
Set the thread local query timeout in seconds, which will override the default connection timeout if definedvoid
setTransactionIsolation(int level)
Attempts to change the transaction isolation level for thisConnection
object to the one given.void
setTypeMap(Map<String,Class<?>> map)
Installs the givenTypeMap
object as the type map for thisConnection
object.<T> T
unwrap(Class<T> iface)
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.sql.Connection
beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid
-
-
-
-
Constructor Detail
-
CoreConnection
public CoreConnection(Connection connection, Integer queryTimeout)
Create a monitored connection given a connection.- Parameters:
connection
- a connection to monitorqueryTimeout
- the JDBC Statement query timeout in seconds
-
-
Method Detail
-
setThreadLocalQueryTimeout
public static void setThreadLocalQueryTimeout(Integer queryTimeout)
Set the thread local query timeout in seconds, which will override the default connection timeout if defined- Parameters:
queryTimeout
- the query timeout in seconds
-
getThreadLocalOpenConnections
public static Map<Integer,Connection> getThreadLocalOpenConnections()
Return the thread local map of open connections, keyed on connection hashcode.- Returns:
- the thread local map of open connections, keyed on connection hashcode
-
closeThreadLocalOpenConnections
public static void closeThreadLocalOpenConnections()
Close all thread local open connections.
-
getQueryTimeout
public Integer getQueryTimeout()
Return the query timeout in seconds, using the threadlocal value if defined- Returns:
- the query timeout in seconds, using the threadlocal value if defined
-
clearWarnings
public void clearWarnings() throws SQLException
Clear warnings.- Specified by:
clearWarnings
in interfaceConnection
- Throws:
SQLException
- if a database access error occurs- See Also:
Connection.clearWarnings()
-
close
public void close() throws SQLException
Perform checking and logging before close the connection.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceConnection
- Throws:
SQLException
- - if a database access error occurs- See Also:
Connection.close()
-
commit
public void commit() throws SQLException
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by this Connection object. This method should be used only when auto-commit mode has been disabled.- Specified by:
commit
in interfaceConnection
- Throws:
SQLException
- if a database access error occurs or this Connection object is in auto-commit mode- See Also:
Connection.commit()
-
createStatement
public Statement createStatement() throws SQLException
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 returned
Statement
object will by default be typeTYPE_FORWARD_ONLY
and have a concurrency level ofCONCUR_READ_ONLY
.- Specified by:
createStatement
in interfaceConnection
- Returns:
- a new default
Statement
object - Throws:
SQLException
- if a database access error occurs
-
createStatement
public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
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.- Specified by:
createStatement
in interfaceConnection
- 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
Statement
object that will generateResultSet
objects with the given type and concurrency - Throws:
SQLException
- if a database access error occurs or the given parameters are notResultSet
constants indicating type and concurrency
-
createStatement
public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
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.- Specified by:
createStatement
in interfaceConnection
- 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 new
Statement
object that will generateResultSet
objects with the given type, concurrency, and holdability - Throws:
SQLException
- if a database access error occurs or the given parameters are notResultSet
constants indicating type, concurrency, and holdability- See Also:
ResultSet
-
getAutoCommit
public boolean getAutoCommit() throws SQLException
Retrieves the current auto-commit mode for thisConnection
object.- Specified by:
getAutoCommit
in interfaceConnection
- Returns:
- the current state of this
Connection
object's auto-commit mode - Throws:
SQLException
- if a database access error occurs- See Also:
setAutoCommit(boolean)
-
getCatalog
public String getCatalog() throws SQLException
Retrieves thisConnection
object's current catalog name.- Specified by:
getCatalog
in interfaceConnection
- Returns:
- the current catalog name or
null
if there is none - Throws:
SQLException
- if a database access error occurs- See Also:
setCatalog(java.lang.String)
-
getHoldability
public int getHoldability() throws SQLException
Retrieves the current holdability ofResultSet
objects created using thisConnection
object.- Specified by:
getHoldability
in interfaceConnection
- Returns:
- the holdability, one of
ResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
- Throws:
SQLException
- if a database access occurs- See Also:
setHoldability(int)
,ResultSet
-
getMetaData
public DatabaseMetaData getMetaData() throws SQLException
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.- Specified by:
getMetaData
in interfaceConnection
- Returns:
- a
DatabaseMetaData
object for thisConnection
object - Throws:
SQLException
- if a database access error occurs
-
getTransactionIsolation
public int getTransactionIsolation() throws SQLException
Retrieves thisConnection
object's current transaction isolation level.- Specified by:
getTransactionIsolation
in interfaceConnection
- 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- See Also:
setTransactionIsolation(int)
-
getTypeMap
public Map<String,Class<?>> getTypeMap() throws SQLException
Retrieves theMap
object associated with thisConnection
object. Unless the application has added an entry, the type map returned will be empty.- Specified by:
getTypeMap
in interfaceConnection
- Returns:
- the
java.util.Map
object associated with thisConnection
object - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
- See Also:
setTypeMap(java.util.Map<java.lang.String, java.lang.Class<?>>)
-
getWarnings
public SQLWarning getWarnings() throws SQLException
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 an
SQLException
to be thrown.Note: Subsequent warnings will be chained to this SQLWarning.
- Specified by:
getWarnings
in interfaceConnection
- Returns:
- the first
SQLWarning
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
-
isClosed
public boolean isClosed() throws SQLException
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.
- Specified by:
isClosed
in interfaceConnection
- Returns:
true
if thisConnection
object is closed;false
if it is still open- Throws:
SQLException
- if a database access error occurs
-
isReadOnly
public boolean isReadOnly() throws SQLException
Retrieves whether thisConnection
object is in read-only mode.- Specified by:
isReadOnly
in interfaceConnection
- Returns:
true
if thisConnection
object is read-only;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
nativeSQL
public String nativeSQL(String sql) throws SQLException
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.- Specified by:
nativeSQL
in interfaceConnection
- 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
-
prepareCall
public CallableStatement prepareCall(String sql) throws SQLException
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 method
prepareCall
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 returned
CallableStatement
object will by default be typeTYPE_FORWARD_ONLY
and have a concurrency level ofCONCUR_READ_ONLY
.- Specified by:
prepareCall
in interfaceConnection
- Parameters:
sql
- an SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.- Returns:
- a new default
CallableStatement
object containing the pre-compiled SQL statement - Throws:
SQLException
- if a database access error occurs
-
prepareCall
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
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.- Specified by:
prepareCall
in interfaceConnection
- Parameters:
sql
- aString
object that is the SQL statement to be sent to the database; may contain on or more ? parametersresultSetType
- 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
CallableStatement
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 or the given parameters are notResultSet
constants indicating type and concurrency
-
prepareCall
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
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.- Specified by:
prepareCall
in interfaceConnection
- Parameters:
sql
- aString
object that is the SQL statement to be sent to the database; may contain on or more ? parametersresultSetType
- 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 new
CallableStatement
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 or the given parameters are notResultSet
constants indicating type, concurrency, and holdability- See Also:
ResultSet
-
prepareStatement
public PreparedStatement prepareStatement(String sql) throws SQLException
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 a
PreparedStatement
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 method
prepareStatement
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 returned
PreparedStatement
object will by default be typeTYPE_FORWARD_ONLY
and have a concurrency level ofCONCUR_READ_ONLY
.- Specified by:
prepareStatement
in interfaceConnection
- Parameters:
sql
- an SQL statement that may contain one or more '?' IN parameter placeholders- Returns:
- a new default
PreparedStatement
object containing the pre-compiled SQL statement - Throws:
SQLException
- if a database access error occurs
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException
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.Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method
prepareStatement
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 certain SQLExceptions.Result sets created using the returned
PreparedStatement
object will by default be typeTYPE_FORWARD_ONLY
and have a concurrency level ofCONCUR_READ_ONLY
.- Specified by:
prepareStatement
in interfaceConnection
- Parameters:
sql
- an SQL statement that may contain one or more '?' IN parameter placeholdersautoGeneratedKeys
- a flag indicating whether auto-generated keys should be returned; one ofStatement.RETURN_GENERATED_KEYS
orStatement.NO_GENERATED_KEYS
- Returns:
- a new
PreparedStatement
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 or the given parameter is not aStatement
constant indicating whether auto-generated keys should be returned
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException
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. This array is ignored if the SQL statement is not anINSERT
statement.An SQL statement with or without IN parameters can be pre-compiled and stored in a
PreparedStatement
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 method
prepareStatement
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 certain SQLExceptions.Result sets created using the returned
PreparedStatement
object will by default be typeTYPE_FORWARD_ONLY
and have a concurrency level ofCONCUR_READ_ONLY
.- Specified by:
prepareStatement
in interfaceConnection
- Parameters:
sql
- an SQL statement that may contain one or more '?' IN parameter placeholderscolumnIndexes
- an array of column indexes indicating the columns that should be returned from the inserted row or rows- Returns:
- a new
PreparedStatement
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
-
prepareStatement
public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException
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. This array is ignored if the SQL statement is not anINSERT
statement.An SQL statement with or without IN parameters can be pre-compiled and stored in a
PreparedStatement
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 method
prepareStatement
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 certain SQLExceptions.Result sets created using the returned
PreparedStatement
object will by default be typeTYPE_FORWARD_ONLY
and have a concurrency level ofCONCUR_READ_ONLY
.- Specified by:
prepareStatement
in interfaceConnection
- Parameters:
sql
- an SQL statement that may contain one or more '?' IN parameter placeholderscolumnNames
- an array of column names indicating the columns that should be returned from the inserted row or rows- Returns:
- a new
PreparedStatement
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
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException
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.- Specified by:
prepareStatement
in interfaceConnection
- Parameters:
sql
- aString
object that is the SQL statement to be sent to the database; may contain one or more ? IN parametersresultSetType
- 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 produce
ResultSet
objects with the given type and concurrency - Throws:
SQLException
- if a database access error occurs or the given parameters are notResultSet
constants indicating type and concurrency- Since:
- 1.2
-
prepareStatement
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException
Creates aPreparedStatement
object that will generateResultSet
objects with the given type, concurrency, and holdability.This method is the same as the
prepareStatement
method above, but it allows the default result set type, concurrency, and holdability to be overridden.- Specified by:
prepareStatement
in interfaceConnection
- Parameters:
sql
- aString
object that is the SQL statement to be sent to the database; may contain one or more ? IN parametersresultSetType
- 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 new
PreparedStatement
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 or the given parameters are notResultSet
constants indicating type, concurrency, and holdability- See Also:
ResultSet
-
releaseSavepoint
public void releaseSavepoint(Savepoint savepoint) throws SQLException
Removes the givenSavepoint
object from the current transaction. Any reference to the savepoint after it have been removed will cause anSQLException
to be thrown.- Specified by:
releaseSavepoint
in interfaceConnection
- Parameters:
savepoint
- theSavepoint
object to be removed- Throws:
SQLException
- if a database access error occurs or the givenSavepoint
object is not a valid savepoint in the current transaction- Since:
- 1.4
-
rollback
public void rollback() throws SQLException
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.- Specified by:
rollback
in interfaceConnection
- Throws:
SQLException
- if a database access error occurs or thisConnection
object is in auto-commit mode- See Also:
setAutoCommit(boolean)
-
rollback
public void rollback(Savepoint savepoint) throws SQLException
Undoes all changes made after the givenSavepoint
object was set.This method should be used only when auto-commit has been disabled.
- Specified by:
rollback
in interfaceConnection
- Parameters:
savepoint
- theSavepoint
object to roll back to- Throws:
SQLException
- if a database access error occurs, theSavepoint
object is no longer valid, or thisConnection
object is currently in auto-commit mode- Since:
- 1.4
- See Also:
Savepoint
,rollback()
-
setAutoCommit
public void setAutoCommit(boolean autoCommit) throws SQLException
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 or the next execute occurs, whichever comes first. In the case of statements returning a
ResultSet
object, the statement completes when the last row of theResultSet
object has been retrieved or theResultSet
object has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. In these cases, the commit occurs when all results and output parameter values have been retrieved.NOTE: If this method is called during a transaction, the transaction is committed.
- Specified by:
setAutoCommit
in interfaceConnection
- Parameters:
autoCommit
-true
to enable auto-commit mode;false
to disable it- Throws:
SQLException
- if a database access error occurs- See Also:
getAutoCommit()
-
setCatalog
public void setCatalog(String catalog) throws SQLException
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.
- Specified by:
setCatalog
in interfaceConnection
- 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- See Also:
getCatalog()
-
setHoldability
public void setHoldability(int holdability) throws SQLException
Changes the holdability ofResultSet
objects created using thisConnection
object to the given holdability.- Specified by:
setHoldability
in interfaceConnection
- Parameters:
holdability
- aResultSet
holdability constant; one ofResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
- Throws:
SQLException
- if a database access occurs, the given parameter is not aResultSet
constant indicating holdability, or the given holdability is not supported- Since:
- 1.4
- See Also:
getHoldability()
,ResultSet
-
setReadOnly
public void setReadOnly(boolean readOnly) throws SQLException
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.
- Specified by:
setReadOnly
in interfaceConnection
- Parameters:
readOnly
-true
enables read-only mode;false
disables it- Throws:
SQLException
- if a database access error occurs or this method is called during a transaction
-
setSavepoint
public Savepoint setSavepoint() throws SQLException
Creates an unnamed savepoint in the current transaction and returns the newSavepoint
object that represents it.- Specified by:
setSavepoint
in interfaceConnection
- Returns:
- the new
Savepoint
object - Throws:
SQLException
- if a database access error occurs or thisConnection
object is currently in auto-commit mode- Since:
- 1.4
- See Also:
Savepoint
-
setSavepoint
public Savepoint setSavepoint(String name) throws SQLException
Creates a savepoint with the given name in the current transaction and returns the newSavepoint
object that represents it.- Specified by:
setSavepoint
in interfaceConnection
- Parameters:
name
- aString
containing the name of the savepoint- Returns:
- the new
Savepoint
object - Throws:
SQLException
- if a database access error occurs or thisConnection
object is currently in auto-commit mode- Since:
- 1.4
- See Also:
Savepoint
-
setTransactionIsolation
public void setTransactionIsolation(int level) throws SQLException
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.
- Specified by:
setTransactionIsolation
in interfaceConnection
- 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 or the given parameter is not one of theConnection
constants- See Also:
DatabaseMetaData.supportsTransactionIsolationLevel(int)
,getTransactionIsolation()
-
setTypeMap
public void setTypeMap(Map<String,Class<?>> map) throws SQLException
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.- Specified by:
setTypeMap
in interfaceConnection
- 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 or the given parameter is not ajava.util.Map
object- Since:
- 1.2
- See Also:
getTypeMap()
-
unwrap
public <T> T unwrap(Class<T> iface) throws SQLException
Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of callingunwrap
recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then anSQLException
is thrown.- Specified by:
unwrap
in interfaceWrapper
- Type Parameters:
T
- the generic type- Parameters:
iface
- A Class defining an interface that the result must implement.- Returns:
- an object that implements the interface. May be a proxy for the actual implementing object.
- Throws:
SQLException
- the SQL exception- Since:
- 1.6
-
isWrapperFor
public boolean isWrapperFor(Class<?> iface) throws SQLException
Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively callingisWrapperFor
on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared tounwrap
so that callers can use this method to avoid expensiveunwrap
calls that may fail. If this method returns true then callingunwrap
with the same argument should succeed.- Specified by:
isWrapperFor
in interfaceWrapper
- Parameters:
iface
- a Class defining an interface.- Returns:
- true if this implements the interface or directly or indirectly wraps an object that does.
- Throws:
SQLException
- the sQL exception- Since:
- 1.6
-
createClob
public Clob createClob() throws SQLException
Creates the clob.- Specified by:
createClob
in interfaceConnection
- Returns:
- the clob
- Throws:
SQLException
- the sQL exception- See Also:
Connection.createClob()
-
createBlob
public Blob createBlob() throws SQLException
Creates the blob.- Specified by:
createBlob
in interfaceConnection
- Returns:
- the blob
- Throws:
SQLException
- the sQL exception- See Also:
Connection.createBlob()
-
createNClob
public NClob createNClob() throws SQLException
Creates the nclob.- Specified by:
createNClob
in interfaceConnection
- Returns:
- the nclob
- Throws:
SQLException
- the sQL exception- See Also:
Connection.createNClob()
-
createSQLXML
public SQLXML createSQLXML() throws SQLException
Creates the sqlxml.- Specified by:
createSQLXML
in interfaceConnection
- Returns:
- the sQLXML
- Throws:
SQLException
- the sQL exception- See Also:
Connection.createSQLXML()
-
isValid
public boolean isValid(int timeout) throws SQLException
Checks if is valid.- Specified by:
isValid
in interfaceConnection
- Parameters:
timeout
- the timeout- Returns:
- true, if is valid
- Throws:
SQLException
- the sQL exception- See Also:
Connection.isValid(int)
-
setClientInfo
public void setClientInfo(String name, String value) throws SQLClientInfoException
Sets the client info.- Specified by:
setClientInfo
in interfaceConnection
- Parameters:
name
- the namevalue
- the value- Throws:
SQLClientInfoException
- the sQL client info exception- See Also:
Connection.setClientInfo(java.lang.String, java.lang.String)
-
setClientInfo
public void setClientInfo(Properties properties) throws SQLClientInfoException
Sets the client info.- Specified by:
setClientInfo
in interfaceConnection
- Parameters:
properties
- the new client info- Throws:
SQLClientInfoException
- the sQL client info exception- See Also:
Connection.setClientInfo(java.util.Properties)
-
getClientInfo
public String getClientInfo(String name) throws SQLException
Gets the client info.- Specified by:
getClientInfo
in interfaceConnection
- Parameters:
name
- the name- Returns:
- the client info
- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.getClientInfo(java.lang.String)
-
getClientInfo
public Properties getClientInfo() throws SQLException
Gets the client info.- Specified by:
getClientInfo
in interfaceConnection
- Returns:
- the client info
- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.getClientInfo()
-
createArrayOf
public Array createArrayOf(String typeName, Object[] elements) throws SQLException
Creates the array of.- Specified by:
createArrayOf
in interfaceConnection
- Parameters:
typeName
- the type nameelements
- the elements- Returns:
- the array
- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.createArrayOf(java.lang.String, java.lang.Object[])
-
createStruct
public Struct createStruct(String typeName, Object[] attributes) throws SQLException
Creates the struct.- Specified by:
createStruct
in interfaceConnection
- Parameters:
typeName
- the type nameattributes
- the attributes- Returns:
- the struct
- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.createStruct(java.lang.String, java.lang.Object[])
-
setSchema
public void setSchema(String schema) throws SQLException
- Specified by:
setSchema
in interfaceConnection
- Parameters:
schema
- the database schema- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.setSchema(String)
-
getSchema
public String getSchema() throws SQLException
- Specified by:
getSchema
in interfaceConnection
- Returns:
- the database schema
- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.getSchema()
-
abort
public void abort(Executor executor) throws SQLException
- Specified by:
abort
in interfaceConnection
- Parameters:
executor
- the abort event executor- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.abort(Executor)
-
setNetworkTimeout
public void setNetworkTimeout(Executor executor, int milliseconds) throws SQLException
- Specified by:
setNetworkTimeout
in interfaceConnection
- Parameters:
executor
- the timeout event executormilliseconds
- the timeout in milliseconds- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.setNetworkTimeout(Executor, int)
-
getNetworkTimeout
public int getNetworkTimeout() throws SQLException
- Specified by:
getNetworkTimeout
in interfaceConnection
- Returns:
- the network timeout value
- Throws:
SQLException
- if a SQL error occurs- See Also:
Connection.getNetworkTimeout()
-
-