Field Summary

Method Summary

Field Details

• TRANSACTION_NONE

  static final int TRANSACTION_NONE

  A constant indicating that transactions are not supported.

  See Also:

  • Constant Field Values

• TRANSACTION_READ_UNCOMMITTED

  static final int TRANSACTION_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 int TRANSACTION_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 int TRANSACTION_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 int TRANSACTION_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

Method Details

• createStatement

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

  PreparedStatement prepareStatement(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

  CallableStatement prepareCall(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

  String nativeSQL(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

  void setAutoCommit(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

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

  void commit() 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 connection or thisConnection object is in auto-commit mode

  See Also:

  • setAutoCommit(boolean)

• rollback

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

  void close() 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.

  Specified by:

  close in interface AutoCloseable

  Throws:

  SQLException - if a database access error occurs

• isClosed

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

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

  void setReadOnly(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

  boolean isReadOnly() throwsSQLException

  Retrieves whether thisConnection object is in read-only mode.

  Returns:

  true if thisConnection object is read-only;false otherwise

  Throws:

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

• setCatalog

  void setCatalog(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.

  CallingsetCatalog has no effect on previously created or preparedStatement objects. It is implementation defined whether a DBMS prepare operation takes place immediately when theConnection methodprepareStatement orprepareCall is invoked. For maximum portability,setCatalog should be called before aStatement is created or prepared.

  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

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

  void setTransactionIsolation(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

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

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

  void clearWarnings() 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 - if a database access error occurs or this method is called on a closed connection

• createStatement

  Statement createStatement(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

  PreparedStatement prepareStatement(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

  CallableStatement prepareCall(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.

  You must invokesetTypeMap after making changes to theMap object returned fromgetTypeMap as a JDBC driver may create an internal copy of theMap object passed tosetTypeMap:

        Map<String,Class<?>> myMap = con.getTypeMap();      myMap.put("mySchemaName.ATHLETES", Athletes.class);      con.setTypeMap(myMap);

  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<java.lang.String, java.lang.Class<?>>)

• setTypeMap

  void setTypeMap(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.

  You must set the values for theTypeMap prior to callingsetMap as a JDBC driver may create an internal copy of theTypeMap:

        Map myMap<String,Class<?>> = new HashMap<String,Class<?>>();      myMap.put("mySchemaName.ATHLETES", Athletes.class);      con.setTypeMap(myMap);

  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

  void setHoldability(int holdability) throwsSQLException

  Changes the default holdability ofResultSet objects created using thisConnection object to the given holdability. The default holdability ofResultSet objects can 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

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

  Savepoint setSavepoint() 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 createdsavepoint.

  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

  Savepoint setSavepoint(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 createdsavepoint.

  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

  void rollback(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

  void releaseSavepoint(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

  Statement createStatement(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

  PreparedStatement prepareStatement(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

  CallableStatement prepareCall(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

  PreparedStatement prepareStatement(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).

  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 certain SQLExceptions.

  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

  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

  PreparedStatement prepareStatement(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.

  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 certain SQLExceptions.

  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

  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

  PreparedStatement prepareStatement(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.

  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 certain SQLExceptions.

  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

  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

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

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

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

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

  boolean isValid(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 operationcompletes, 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 than 0

  Since:

  1.6

  See Also:

  • DatabaseMetaData.getClientInfoProperties()

• setClientInfo

  void setClientInfo(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

  void setClientInfo(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

  String getClientInfo(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

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

  Array createArrayOf(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

  Struct createStruct(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

• setSchema

  void setSchema(String schema) throwsSQLException

  Sets the given schema name to access.

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

  CallingsetSchema has no effect on previously created or preparedStatement objects. It is implementation defined whether a DBMS prepare operation takes place immediately when theConnection methodprepareStatement orprepareCall is invoked. For maximum portability,setSchema should be called before aStatement is created or prepared.

  Parameters:

  schema - the name of a schema in which to work

  Throws:

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

  Since:

  1.7

  See Also:

  • getSchema()

• getSchema

  String getSchema() throwsSQLException

  Retrieves thisConnection object's current schema name.

  Returns:

  the current schema name ornull if there is none

  Throws:

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

  Since:

  1.7

  See Also:

  • setSchema(java.lang.String)

• abort

  void abort(Executor executor) throwsSQLException

  Terminates an open connection. Callingabort results in:

  • The connection marked as closed
  • Closes any physical connection to the database
  • Releases resources used by the connection
  • Insures that any thread that is currently accessing the connection will either progress to completion or throw anSQLException.

  Callingabort marks the connection closed and releases any resources. Callingabort on a closed connection is a no-op.

  It is possible that the aborting and releasing of the resources that are held by the connection can take an extended period of time. When theabort method returns, the connection will have been marked as closed and theExecutor that was passed as a parameter to abort may still be executing tasks to release resources.

  This method checks to see that there is anSQLPermission object before allowing the method to proceed. If aSecurityManager exists and itscheckPermission method denies callingabort, this method throws ajava.lang.SecurityException.

  Parameters:

  executor - TheExecutor implementation which will be used byabort.

  Throws:

  SQLException - if a database access error occurs or theexecutor isnull,

  SecurityException - if a security manager exists and itscheckPermission method denies callingabort

  Since:

  1.7

  See Also:

  • SecurityManager.checkPermission(java.security.Permission)
  • Executor

• setNetworkTimeout

  void setNetworkTimeout(Executor executor, int milliseconds) throwsSQLException

  Sets the maximum period aConnection or objects created from theConnection will wait for the database to reply to any one request. If any request remains unanswered, the waiting method will return with aSQLException, and theConnection or objects created from theConnection will be marked as closed. Any subsequent use of the objects, with the exception of theclose,isClosed orConnection.isValid methods, will result in aSQLException.

  Note: This method is intended to address a rare but serious condition where network partitions can cause threads issuing JDBC calls to hang uninterruptedly in socket reads, until the OS TCP-TIMEOUT (typically 10 minutes). This method is related to theabort() method which provides an administrator thread a means to free any such threads in cases where the JDBC connection is accessible to the administrator thread. ThesetNetworkTimeout method will cover cases where there is no administrator thread, or it has no access to the connection. This method is severe in it's effects, and should be given a high enough value so it is never triggered before any more normal timeouts, such as transaction timeouts.

  JDBC driver implementations may also choose to support thesetNetworkTimeout method to impose a limit on database response time, in environments where no network is present.

  Drivers may internally implement some or all of their API calls with multiple internal driver-database transmissions, and it is left to the driver implementation to determine whether the limit will be applied always to the response to the API call, or to any single request made during the API call.

  This method can be invoked more than once, such as to set a limit for an area of JDBC code, and to reset to the default on exit from this area. Invocation of this method has no impact on already outstanding requests.

  TheStatement.setQueryTimeout() timeout value is independent of the timeout value specified insetNetworkTimeout. If the query timeout expires before the network timeout then the statement execution will be canceled. If the network is still active the result will be that both the statement and connection are still usable. However if the network timeout expires before the query timeout or if the statement timeout fails due to network problems, the connection will be marked as closed, any resources held by the connection will be released and both the connection and statement will be unusable.

  When the driver determines that thesetNetworkTimeout timeout value has expired, the JDBC driver marks the connection closed and releases any resources held by the connection.

  This method checks to see that there is anSQLPermission object before allowing the method to proceed. If aSecurityManager exists and itscheckPermission method denies callingsetNetworkTimeout, this method throws ajava.lang.SecurityException.

  Parameters:

  executor - TheExecutor implementation which will be used bysetNetworkTimeout.

  milliseconds - The time in milliseconds to wait for the database operation to complete. If the JDBC driver does not support milliseconds, the JDBC driver will round the value up to the nearest second. If the timeout period expires before the operation completes, a SQLException will be thrown. A value of 0 indicates that there is not timeout for database operations.

  Throws:

  SQLException - if a database access error occurs, this method is called on a closed connection, theexecutor isnull, or the value specified forseconds is less than 0.

  SecurityException - if a security manager exists and itscheckPermission method denies callingsetNetworkTimeout.

  SQLFeatureNotSupportedException - if the JDBC driver does not support this method

  Since:

  1.7

  See Also:

  • SecurityManager.checkPermission(java.security.Permission)
  • Statement.setQueryTimeout(int)
  • getNetworkTimeout()
  • abort(java.util.concurrent.Executor)
  • Executor

• getNetworkTimeout

  int getNetworkTimeout() throwsSQLException

  Retrieves the number of milliseconds the driver will wait for a database request to complete. If the limit is exceeded, aSQLException is thrown.

  Returns:

  the current timeout limit in milliseconds; zero means there is no limit

  Throws:

  SQLException - if a database access error occurs or this method is called on a closedConnection

  SQLFeatureNotSupportedException - if the JDBC driver does not support this method

  Since:

  1.7

  See Also:

  • setNetworkTimeout(java.util.concurrent.Executor, int)

• beginRequest

  default void beginRequest() throwsSQLException

  Hints to the driver that a request, an independent unit of work, is beginning on this connection. Each request is independent of all other requests with regard to state local to the connection either on the client or the server. Work done betweenbeginRequest,endRequest pairs does not depend on any other work done on the connection either as part of another request or outside of any request. A request may include multiple transactions. There may be dependencies on committed database state as that is not local to the connection.

  Local state is defined as any state associated with a Connection that is local to the current Connection either in the client or the database that is not transparently reproducible.

  Calls tobeginRequest andendRequest are not nested. Multiple calls tobeginRequest without an intervening call toendRequest is not an error. The firstbeginRequest call marks the start of the request and subsequent calls are treated as a no-op

  Use ofbeginRequest andendRequest is optional, vendor specific and should largely be transparent. In particular implementations may detect conditions that indicate dependence on other work such as an open transaction. It is recommended though not required that implementations throw aSQLException if there is an active transaction andbeginRequest is called. Using these methods may improve performance or provide other benefits. Consult your vendors documentation for additional information.

  It is recommended to enclose each unit of work inbeginRequest,endRequest pairs such that there is no open transaction at the beginning or end of the request and no dependency on local state that crosses request boundaries. Committed database state is not local.

  API Note:

  This method is to be used by Connection pooling managers.

  The pooling manager should callbeginRequest on the underlying connection prior to returning a connection to the caller.

  The pooling manager does not need to callbeginRequest if:

  • The connection pool cachesPooledConnection objects
  • Returns a logical connection handle whengetConnection is called by the application
  • The logicalConnection is closed by callingConnection.close prior to returning thePooledConnection to the cache.

  Implementation Requirements:

  The default implementation is a no-op.

  Throws:

  SQLException - if an error occurs

  Since:

  9

  See Also:

  • endRequest()
  • PooledConnection

• endRequest

  default void endRequest() throwsSQLException

  Hints to the driver that a request, an independent unit of work, has completed. Calls tobeginRequest andendRequest are not nested. Multiple calls toendRequest without an intervening call tobeginRequest is not an error. The firstendRequest call marks the request completed and subsequent calls are treated as a no-op. IfendRequest is called without an initial call tobeginRequest is a no-op.

  The exact behavior of this method is vendor specific. In particular implementations may detect conditions that indicate dependence on other work such as an open transaction. It is recommended though not required that implementations throw aSQLException if there is an active transaction andendRequest is called.

  API Note:

  This method is to be used by Connection pooling managers.

  The pooling manager should callendRequest on the underlying connection when the applications returns the connection back to the connection pool.

  The pooling manager does not need to callendRequest if:

  • The connection pool cachesPooledConnection objects
  • Returns a logical connection handle whengetConnection is called by the application
  • The logicalConnection is closed by callingConnection.close prior to returning thePooledConnection to the cache.

  Implementation Requirements:

  The default implementation is a no-op.

  Throws:

  SQLException - if an error occurs

  Since:

  9

  See Also:

  • beginRequest()
  • PooledConnection

• setShardingKeyIfValid

  default boolean setShardingKeyIfValid(ShardingKey shardingKey,ShardingKey superShardingKey, int timeout) throwsSQLException

  Sets and validates the sharding keys for this connection. Anull value may be specified for the sharding Key. The validity of anull sharding key is vendor-specific. Consult your vendor's documentation for additional information.

  API Note:

  This method validates that the sharding keys are valid for theConnection. The timeout value indicates how long the driver should wait for theConnection to verify that the sharding key is valid beforesetShardingKeyIfValid returns false.

  Implementation Requirements:

  The default implementation will throw aSQLFeatureNotSupportedException.

  Parameters:

  shardingKey - the sharding key to be validated against this connection. The sharding key may benull

  superShardingKey - the super sharding key to be validated against this connection. The super sharding key may benull.

  timeout - time in seconds before which the validation process is expected to be completed, otherwise the validation process is aborted. A value of 0 indicates the validation process will not time out.

  Returns:

  true if the connection is valid and the sharding keys are valid and set on this connection; false if the sharding keys are not valid or the timeout period expires before the operation completes.

  Throws:

  SQLException - if an error occurs while performing this validation; asuperShardingKey is specified without ashardingKey; this method is called on a closedconnection; or thetimeout value is negative.

  SQLFeatureNotSupportedException - if the driver does not support sharding

  Since:

  9

  See Also:

  • ShardingKey
  • ShardingKeyBuilder

• setShardingKeyIfValid

  default boolean setShardingKeyIfValid(ShardingKey shardingKey, int timeout) throwsSQLException

  Sets and validates the sharding key for this connection. Anull value may be specified for the sharding Key. The validity of anull sharding key is vendor-specific. Consult your vendor's documentation for additional information.

  API Note:

  This method validates that the sharding key is valid for theConnection. The timeout value indicates how long the driver should wait for theConnection to verify that the sharding key is valid beforesetShardingKeyIfValid returns false.

  Implementation Requirements:

  The default implementation will throw aSQLFeatureNotSupportedException.

  Parameters:

  shardingKey - the sharding key to be validated against this connection. The sharding key may benull

  timeout - time in seconds before which the validation process is expected to be completed,else the validation process is aborted. A value of 0 indicates the validation process will not time out.

  Returns:

  true if the connection is valid and the sharding key is valid to be set on this connection; false if the sharding key is not valid or the timeout period expires before the operation completes.

  Throws:

  SQLException - if there is an error while performing this validation; this method is called on a closedconnection; or thetimeout value is negative.

  SQLFeatureNotSupportedException - if the driver does not support sharding

  Since:

  9

  See Also:

  • ShardingKey
  • ShardingKeyBuilder

• setShardingKey

  default void setShardingKey(ShardingKey shardingKey,ShardingKey superShardingKey) throwsSQLException

  Specifies a shardingKey and superShardingKey to use with this Connection

  API Note:

  This method sets the specified sharding keys but does not require a round trip to the database to validate that the sharding keys are valid for theConnection.

  Implementation Requirements:

  The default implementation will throw aSQLFeatureNotSupportedException.

  Parameters:

  shardingKey - the sharding key to set on this connection. The sharding key may benull

  superShardingKey - the super sharding key to set on this connection. The super sharding key may benull

  Throws:

  SQLException - if an error occurs setting the sharding keys; this method is called on a closedconnection; or asuperShardingKey is specified without ashardingKey

  SQLFeatureNotSupportedException - if the driver does not support sharding

  Since:

  9

  See Also:

  • ShardingKey
  • ShardingKeyBuilder

• setShardingKey

  default void setShardingKey(ShardingKey shardingKey) throwsSQLException

  Specifies a shardingKey to use with this Connection

  API Note:

  This method sets the specified sharding key but does not require a round trip to the database to validate that the sharding key is valid for theConnection.

  Implementation Requirements:

  The default implementation will throw aSQLFeatureNotSupportedException.

  Parameters:

  shardingKey - the sharding key to set on this connection. The sharding key may benull

  Throws:

  SQLException - if an error occurs setting the sharding key; or this method is called on a closedconnection

  SQLFeatureNotSupportedException - if the driver does not support sharding

  Since:

  9

  See Also:

  • ShardingKey
  • ShardingKeyBuilder