org.drizzle.jdbc
Class DrizzleConnection

java.lang.Object
  extended by org.drizzle.jdbc.DrizzleConnection
All Implemented Interfaces:
java.sql.Connection, java.sql.Wrapper, ReplicationConnection

public final class DrizzleConnection
extends java.lang.Object
implements java.sql.Connection, ReplicationConnection

A JDBC Connection.

User: marcuse Date: Jan 14, 2009 Time: 7:47:37 AM


Field Summary
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Constructor Summary
DrizzleConnection(Protocol protocol, QueryFactory queryFactory)
          Creates a new connection with a given protocol and query factory.
 
Method Summary
 void clearWarnings()
          Clears all warnings reported for this Connection object.
 void close()
          close the connection.
 void commit()
          sends commit to the server.
 java.sql.Array createArrayOf(java.lang.String typeName, java.lang.Object[] elements)
          Factory method for creating Array objects.
 java.sql.Blob createBlob()
          Constructs an object that implements the Blob interface.
 java.sql.Clob createClob()
          Constructs an object that implements the Clob interface.
 java.sql.NClob createNClob()
          Constructs an object that implements the NClob interface.
 java.sql.SQLXML createSQLXML()
          Constructs an object that implements the SQLXML interface.
 java.sql.Statement createStatement()
          creates a new statement.
 java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency)
          Creates a Statement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 java.sql.Struct createStruct(java.lang.String typeName, java.lang.Object[] attributes)
          Factory method for creating Struct objects.
 boolean getAutoCommit()
          returns true if statements on this connection are auto commited.
 java.lang.String getCatalog()
          Retrieves this Connection object's current catalog name.
 java.util.Properties getClientInfo()
          Returns a list containing the name and current value of each client info property supported by the driver.
 java.lang.String getClientInfo(java.lang.String name)
          Returns the value of the client info property specified by name.
 java.lang.String getDatabase()
          returns the database.
 int getHoldability()
          Retrieves the current holdability of ResultSet objects created using this Connection object.
 java.lang.String getHostname()
          returns the hostname for the connection.
 java.sql.DatabaseMetaData getMetaData()
          returns the meta data about the database.
 java.lang.String getPassword()
          returns the password for the connection.
 int getPort()
          returns the port for the connection.
protected  java.util.concurrent.ScheduledExecutorService getTimeoutExecutor()
           
 int getTransactionIsolation()
          Retrieves this Connection object's current transaction isolation level.
 java.util.Map<java.lang.String,java.lang.Class<?>> getTypeMap()
          Retrieves the Map object associated with this Connection object.
 java.lang.String getUsername()
          returns the username for the connection.
 java.sql.SQLWarning getWarnings()
          Not yet implemented: Protocol needs to store any warnings related to connections

Retrieves the first warning reported by calls on this Connection object.

 boolean isClosed()
          checks if the connection is closed.
 boolean isReadOnly()
          Retrieves whether this Connection object is in read-only mode.
 boolean isValid(int timeout)
          Returns true if the connection has not been closed and is still valid.
 boolean isWrapperFor(java.lang.Class<?> iface)
          Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
 java.lang.String nativeSQL(java.lang.String sql)
          currently does nothing.
 java.sql.CallableStatement prepareCall(java.lang.String sql)
          not implemented.
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency)
          Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.CallableStatement prepareCall(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql)
          creates a new prepared statement.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int autoGeneratedKeys)
          Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int[] columnIndexes)
          Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency)
          Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
          Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
 java.sql.PreparedStatement prepareStatement(java.lang.String sql, java.lang.String[] columnNames)
          Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
 void releaseSavepoint(java.sql.Savepoint savepoint)
          Removes the specified Savepoint and subsequent Savepoint objects from the current transaction.
 void rollback()
          rolls back a transaction.
 void rollback(java.sql.Savepoint savepoint)
          Undoes all changes made after the given Savepoint object was set.
 void setAutoCommit(boolean autoCommit)
          Sets whether this connection is auto commited.
 void setBatchQueryHandlerFactory(ParameterizedBatchHandlerFactory batchHandlerFactory)
           
 void setCatalog(java.lang.String catalog)
          Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.
 void setClientInfo(java.util.Properties properties)
          Sets the value of the connection's client info properties.
 void setClientInfo(java.lang.String name, java.lang.String value)
          Sets the value of the client info property specified by name to the value specified by value.
 void setHoldability(int holdability)
          Changes the default holdability of ResultSet objects created using this Connection object to the given holdability.
 void setReadOnly(boolean readOnly)
          Sets whether this connection is read only.
 java.sql.Savepoint setSavepoint()
          Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
 java.sql.Savepoint setSavepoint(java.lang.String name)
          Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
 void setTransactionIsolation(int level)
          Attempts to change the transaction isolation level for this Connection object to the one given.
 void setTypeMap(java.util.Map<java.lang.String,java.lang.Class<?>> map)
          Installs the given TypeMap object as the type map for this Connection object.
 java.util.List<RawPacket> startBinlogDump(int position, java.lang.String logfile)
          returns a list of binlog entries.
<T> T
unwrap(java.lang.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
 

Constructor Detail

DrizzleConnection

public DrizzleConnection(Protocol protocol,
                         QueryFactory queryFactory)
Creates a new connection with a given protocol and query factory.

Parameters:
protocol - the protocol to use.
queryFactory - the query factory to use.
Method Detail

createStatement

public java.sql.Statement createStatement()
                                   throws java.sql.SQLException
creates a new statement.

Specified by:
createStatement in interface java.sql.Connection
Returns:
a statement
Throws:
java.sql.SQLException - if we cannot create the statement.

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql)
                                            throws java.sql.SQLException
creates a new prepared statement. Only client side prepared statement emulation right now.

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - the query.
Returns:
a prepared statement.
Throws:
java.sql.SQLException - if there is a problem preparing the statement.

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql)
                                       throws java.sql.SQLException
not implemented.

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - unused
Returns:
nothing.
Throws:
java.sql.SQLException - always since this is not implemented.

nativeSQL

public java.lang.String nativeSQL(java.lang.String sql)
                           throws java.sql.SQLException
currently does nothing. //TODO: implement

Specified by:
nativeSQL in interface java.sql.Connection
Parameters:
sql -
Returns:
Throws:
java.sql.SQLException

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws java.sql.SQLException
Sets whether this connection is auto commited.

Specified by:
setAutoCommit in interface java.sql.Connection
Parameters:
autoCommit - if it should be auto commited.
Throws:
java.sql.SQLException - if something goes wrong talking to the server.

getAutoCommit

public boolean getAutoCommit()
                      throws java.sql.SQLException
returns true if statements on this connection are auto commited.

Specified by:
getAutoCommit in interface java.sql.Connection
Returns:
true if auto commit is on.
Throws:
java.sql.SQLException

commit

public void commit()
            throws java.sql.SQLException
sends commit to the server.

Specified by:
commit in interface java.sql.Connection
Throws:
java.sql.SQLException - if there is an error commiting.

rollback

public void rollback()
              throws java.sql.SQLException
rolls back a transaction.

Specified by:
rollback in interface java.sql.Connection
Throws:
java.sql.SQLException - if there is an error rolling back.

close

public void close()
           throws java.sql.SQLException
close the connection.

Specified by:
close in interface java.sql.Connection
Throws:
java.sql.SQLException - if there is a problem talking to the server.

isClosed

public boolean isClosed()
                 throws java.sql.SQLException
checks if the connection is closed.

Specified by:
isClosed in interface java.sql.Connection
Returns:
true if the connection is closed
Throws:
java.sql.SQLException - if the connection cannot be closed.

getMetaData

public java.sql.DatabaseMetaData getMetaData()
                                      throws java.sql.SQLException
returns the meta data about the database.

Specified by:
getMetaData in interface java.sql.Connection
Returns:
meta data about the db.
Throws:
java.sql.SQLException - if there is a problem creating the meta data.

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws java.sql.SQLException
Sets whether this connection is read only.

Specified by:
setReadOnly in interface java.sql.Connection
Parameters:
readOnly - true if it should be read only.
Throws:
java.sql.SQLException - if there is a problem

isReadOnly

public boolean isReadOnly()
                   throws java.sql.SQLException
Retrieves whether this Connection object is in read-only mode.

Specified by:
isReadOnly in interface java.sql.Connection
Returns:
true if this Connection object is read-only; false otherwise
Throws:
java.sql.SQLException - SQLException if a database access error occurs or this method is called on a closed connection

setCatalog

public void setCatalog(java.lang.String catalog)
                throws java.sql.SQLException
Sets the given catalog name in order to select a subspace of this Connection object's database in which to work.

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

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

getCatalog

public java.lang.String getCatalog()
                            throws java.sql.SQLException
Retrieves this Connection object's current catalog name.

catalogs are not supported in drizzle

TODO: Explain the wrapper interface to be able to change database

Specified by:
getCatalog in interface java.sql.Connection
Returns:
the current catalog name or null if there is none
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
setCatalog(java.lang.String)

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws java.sql.SQLException
Attempts to change the transaction isolation level for this Connection object to the one given. The constants defined in the interface Connection are the possible transaction isolation levels.

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

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

getTransactionIsolation

public int getTransactionIsolation()
                            throws java.sql.SQLException
Retrieves this Connection object's current transaction isolation level.

Specified by:
getTransactionIsolation in interface java.sql.Connection
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, or Connection.TRANSACTION_NONE.
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
setTransactionIsolation(int)

getWarnings

public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException
Not yet implemented: Protocol needs to store any warnings related to connections

Retrieves the first warning reported by calls on this Connection object. If there is more than one warning, subsequent warnings will be chained to the first one and can be retrieved by calling the method SQLWarning.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 interface java.sql.Connection
Returns:
the first SQLWarning object or null if there are none
Throws:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
See Also:
SQLWarning

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException
Clears all warnings reported for this Connection object. After a call to this method, the method getWarnings returns null until a new warning is reported for this Connection object.

Specified by:
clearWarnings in interface java.sql.Connection
Throws:
java.sql.SQLException - SQLException if a database access error occurs or this method is called on a closed connection

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency)
                                   throws java.sql.SQLException
Creates a Statement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the createStatement 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 calling getHoldability().

Specified by:
createStatement in interface java.sql.Connection
Parameters:
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
a new Statement object that will generate ResultSet objects with the given type and concurrency
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type and concurrency

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency)
                                            throws java.sql.SQLException
Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareStatement 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 calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
Parameters:
sql - a String 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 of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.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:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type and concurrency

prepareCall

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency)
                                       throws java.sql.SQLException
Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall 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 calling getHoldability().

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters
resultSetType - a result set type; one of ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
Returns:
a new CallableStatement object containing the pre-compiled SQL statement that will produce ResultSet objects with the given type and concurrency
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type and concurrency
java.sql.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.

getTypeMap

public java.util.Map<java.lang.String,java.lang.Class<?>> getTypeMap()
                                                              throws java.sql.SQLException
Retrieves the Map object associated with this Connection object. Unless the application has added an entry, the type map returned will be empty.

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

setTypeMap

public void setTypeMap(java.util.Map<java.lang.String,java.lang.Class<?>> map)
                throws java.sql.SQLException
Installs the given TypeMap object as the type map for this Connection object. The type map will be used for the custom mapping of SQL structured types and distinct types.

Specified by:
setTypeMap in interface java.sql.Connection
Parameters:
map - the java.util.Map object to install as the replacement for this Connection object's default type map
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not a java.util.Map object
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
See Also:
getTypeMap()

setHoldability

public void setHoldability(int holdability)
                    throws java.sql.SQLException
Changes the default holdability of ResultSet objects created using this Connection object to the given holdability. The default holdability of ResultSet objects can be be determined by invoking DatabaseMetaData.getResultSetHoldability().

Specified by:
setHoldability in interface java.sql.Connection
Parameters:
holdability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
java.sql.SQLException - if a database access occurs, this method is called on a closed connection, or the given parameter is not a ResultSet constant indicating holdability
java.sql.SQLFeatureNotSupportedException - if the given holdability is not supported
Since:
1.4
See Also:
getHoldability(), DatabaseMetaData.getResultSetHoldability(), ResultSet

getHoldability

public int getHoldability()
                   throws java.sql.SQLException
Retrieves the current holdability of ResultSet objects created using this Connection object.

Specified by:
getHoldability in interface java.sql.Connection
Returns:
the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Throws:
java.sql.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

public java.sql.Savepoint setSavepoint()
                                throws java.sql.SQLException
Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.

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

Specified by:
setSavepoint in interface java.sql.Connection
Returns:
the new Savepoint object
Throws:
java.sql.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 this Connection object is currently in auto-commit mode
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4
See Also:
Savepoint

setSavepoint

public java.sql.Savepoint setSavepoint(java.lang.String name)
                                throws java.sql.SQLException
Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.

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

Specified by:
setSavepoint in interface java.sql.Connection
Parameters:
name - a String containing the name of the savepoint
Returns:
the new Savepoint object
Throws:
java.sql.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 this Connection object is currently in auto-commit mode
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4
See Also:
Savepoint

rollback

public void rollback(java.sql.Savepoint savepoint)
              throws java.sql.SQLException
Undoes all changes made after the given Savepoint object was set.

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

Specified by:
rollback in interface java.sql.Connection
Parameters:
savepoint - the Savepoint object to roll back to
Throws:
java.sql.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, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4
See Also:
Savepoint, rollback()

releaseSavepoint

public void releaseSavepoint(java.sql.Savepoint savepoint)
                      throws java.sql.SQLException
Removes the specified Savepoint and subsequent Savepoint objects from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.

Specified by:
releaseSavepoint in interface java.sql.Connection
Parameters:
savepoint - the Savepoint object to be removed
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given Savepoint object is not a valid savepoint in the current transaction
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4

createStatement

public java.sql.Statement createStatement(int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws java.sql.SQLException
Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the createStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

Specified by:
createStatement in interface java.sql.Connection
Parameters:
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
java.sql.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

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency,
                                                   int resultSetHoldability)
                                            throws java.sql.SQLException
Creates a PreparedStatement object that will generate ResultSet 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 interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain one or more '?' IN parameters
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
java.sql.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

public java.sql.CallableStatement prepareCall(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency,
                                              int resultSetHoldability)
                                       throws java.sql.SQLException
Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.

Specified by:
prepareCall in interface java.sql.Connection
Parameters:
sql - a String object that is the SQL statement to be sent to the database; may contain on or more '?' parameters
resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
Returns:
a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
Throws:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
java.sql.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

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int autoGeneratedKeys)
                                            throws java.sql.SQLException
Creates a default PreparedStatement 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 an INSERT 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 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 the PreparedStatement 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 type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
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 of Statement.RETURN_GENERATED_KEYS or Statement.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:
java.sql.SQLException - if a database access error occurs, this method is called on a closed connection or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS
Since:
1.4

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   int[] columnIndexes)
                                            throws java.sql.SQLException
Creates a default PreparedStatement 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 an INSERT 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 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 the PreparedStatement 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 type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
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 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:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4

prepareStatement

public java.sql.PreparedStatement prepareStatement(java.lang.String sql,
                                                   java.lang.String[] columnNames)
                                            throws java.sql.SQLException
Creates a default PreparedStatement 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 an INSERT 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 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 the PreparedStatement 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 type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY. The holdability of the created result sets can be determined by calling getHoldability().

Specified by:
prepareStatement in interface java.sql.Connection
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 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:
java.sql.SQLException - if a database access error occurs or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this method
Since:
1.4

createClob

public java.sql.Clob createClob()
                         throws java.sql.SQLException
Constructs an object that implements the Clob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the Clob interface may be used to add data to the Clob.

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

createBlob

public java.sql.Blob createBlob()
                         throws java.sql.SQLException
Constructs an object that implements the Blob interface. The object returned initially contains no data. The setBinaryStream and setBytes methods of the Blob interface may be used to add data to the Blob.

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

createNClob

public java.sql.NClob createNClob()
                           throws java.sql.SQLException
Constructs an object that implements the NClob interface. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the NClob interface may be used to add data to the NClob.

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

createSQLXML

public java.sql.SQLXML createSQLXML()
                             throws java.sql.SQLException
Constructs an object that implements the SQLXML interface. The object returned initially contains no data. The createXmlStreamWriter object and setString method of the SQLXML interface may be used to add data to the SQLXML object.

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

isValid

public boolean isValid(int timeout)
                throws java.sql.SQLException
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.

Specified by:
isValid in interface java.sql.Connection
Parameters:
timeout - - The time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.

Returns:
true if the connection is valid, false otherwise
Throws:
java.sql.SQLException - if the value supplied for timeout is less then 0
Since:
1.6

See Also:
DatabaseMetaData.getClientInfoProperties()

setClientInfo

public void setClientInfo(java.lang.String name,
                          java.lang.String value)
                   throws java.sql.SQLClientInfoException
Sets the value of the client info property specified by name to the value specified by value.

Applications may use the DatabaseMetaData.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 a SQLClientInfoException. If the driver generates a SQLClientInfoException, 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.

Specified by:
setClientInfo in interface java.sql.Connection
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:
java.sql.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

public void setClientInfo(java.util.Properties properties)
                   throws java.sql.SQLClientInfoException
Sets the value of the connection's client info properties. The Properties 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. See setClientInfo (String, String) for more information.

If an error occurs in setting any of the client info properties, a SQLClientInfoException is thrown. The SQLClientInfoException 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.

Specified by:
setClientInfo in interface java.sql.Connection
Parameters:
properties - the list of client info properties to set

Throws:
java.sql.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

public java.lang.String getClientInfo(java.lang.String name)
                               throws java.sql.SQLException
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 the DatabaseMetaData.getClientInfoProperties method to determine the client info properties supported by the driver.

Specified by:
getClientInfo in interface java.sql.Connection
Parameters:
name - The name of the client info property to retrieve

Returns:
The value of the client info property specified

Throws:
java.sql.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

public java.util.Properties getClientInfo()
                                   throws java.sql.SQLException
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.

Specified by:
getClientInfo in interface java.sql.Connection
Returns:
A Properties object that contains the name and current value of each of the client info properties supported by the driver.

Throws:
java.sql.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

public java.sql.Array createArrayOf(java.lang.String typeName,
                                    java.lang.Object[] elements)
                             throws java.sql.SQLException
Factory method for creating Array objects.

Note: When createArrayOf is used to create an array object that maps to a primitive data type, then it is implementation-defined whether the Array object is an array of that primitive data type or an array of Object.

Note: The JDBC driver is responsible for mapping the elements Object array to the default JDBC SQL type defined in java.sql.Types for the given class of Object. 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 an SQLException is thrown or the driver supports the resulting conversion.

Specified by:
createArrayOf in interface java.sql.Connection
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 by Array.getBaseTypeName
elements - the elements that populate the returned object
Returns:
an Array object whose elements map to the specified SQL type
Throws:
java.sql.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
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

createStruct

public java.sql.Struct createStruct(java.lang.String typeName,
                                    java.lang.Object[] attributes)
                             throws java.sql.SQLException
Factory method for creating Struct objects.

Specified by:
createStruct in interface java.sql.Connection
Parameters:
typeName - the SQL type name of the SQL structured type that this Struct 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 by Struct.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:
java.sql.SQLException - if a database error occurs, the typeName is null or this method is called on a closed connection
java.sql.SQLFeatureNotSupportedException - if the JDBC driver does not support this data type
Since:
1.6

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
         throws java.sql.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 calling unwrap 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 an SQLException is thrown.

Specified by:
unwrap in interface java.sql.Wrapper
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:
java.sql.SQLException - If no object found that implements the interface
Since:
1.6

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.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 calling isWrapperFor 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 to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Specified by:
isWrapperFor in interface java.sql.Wrapper
Parameters:
iface - a Class defining an interface.
Returns:
true if this implements the interface or directly or indirectly wraps an object that does.
Throws:
java.sql.SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.
Since:
1.6

getUsername

public java.lang.String getUsername()
returns the username for the connection.

Returns:
the username.

getPassword

public java.lang.String getPassword()
returns the password for the connection.

Returns:
the password.

getHostname

public java.lang.String getHostname()
returns the hostname for the connection.

Returns:
the hostname.

getPort

public int getPort()
returns the port for the connection.

Returns:
the port

getDatabase

public java.lang.String getDatabase()
returns the database.

Returns:
the database

startBinlogDump

public java.util.List<RawPacket> startBinlogDump(int position,
                                                 java.lang.String logfile)
                                          throws java.sql.SQLException
returns a list of binlog entries.

Specified by:
startBinlogDump in interface ReplicationConnection
Parameters:
position - the position to start at
logfile - the log file to use
Returns:
a list of rawpackets from the server
Throws:
java.sql.SQLException - if there is a problem talking to the server.

setBatchQueryHandlerFactory

public void setBatchQueryHandlerFactory(ParameterizedBatchHandlerFactory batchHandlerFactory)

getTimeoutExecutor

protected java.util.concurrent.ScheduledExecutorService getTimeoutExecutor()


Copyright © 2012. All Rights Reserved.