org.drizzle.jdbc.internal.mysql

Class MySQLProtocol

java.lang.Object

org.drizzle.jdbc.internal.mysql.MySQLProtocol

All Implemented Interfaces:

Protocol

public class MySQLProtocol
extends Object
implements Protocol

TODO: refactor, clean up TODO: when should i read up the resultset? TODO: thread safety? TODO: exception handling User: marcuse Date: Jan 14, 2009 Time: 4:06:26 PM

Constructor Summary

Constructors

Constructor and Description
MySQLProtocol(String host, int port, String database, String username, String password, Properties info) Get a protocol instance

Method Summary

Modifier and Type	Method and Description
void	addToBatch(Query dQuery) adds a query to the batch
void	cancelCurrentQuery() cancels the current query - clones the current protocol and executes a query using the new connection thread safe
void	clearBatch() clears the current batch
void	close() Closes socket and stream readers/writers
void	commit() commits the current transaction
boolean	createDB() should a database be created if it does not exist ?
List<QueryResult>	executeBatch() executes the batch of queries
QueryResult	executeQuery(Query dQuery) executes a query
QueryResult	executeQuery(Query dQuery, InputStream inputStream)
String	getCatalog() Catalogs are not supported in drizzle so this will always return null with a Drizzle connection MySQL treats catalogs as databases.
String	getDatabase() returns the current used database
SupportedDatabases	getDatabaseType()
String	getHost() returns the host
QueryResult	getMoreResults()
String	getPassword() the current password
int	getPort() returns the port we are connected to
boolean	getReadonly() check if it is possble to execute writing operations on this connection
String	getServerVariable(String variable)
String	getServerVersion() returns the server version string
String	getUsername() returns the current connected username
static String	hexdump(byte[] buffer, int offset)
static String	hexdump(ByteBuffer bb, int offset)
boolean	isClosed() returns true if the connection has been closed
boolean	noPrepStmtCache()
boolean	ping() checks whether the connectiion is still valid
void	releaseSavepoint(String savepoint) releases the savepoint
void	rollback() rolls back the current transaction
void	rollback(String savepoint) rolls back to the given save point
void	selectDB(String database) selects what database to use
void	setCatalog(String catalog) Catalogs are not supported in drizzle so this is a no-op with a Drizzle connection MySQL treats catalogs as databases.
void	setReadonly(boolean readOnly) sets whether this connection should be read only TODO: actually enforce this
void	setSavepoint(String savepoint) sets a save point
List<RawPacket>	startBinlogDump(int startPos, String filename)
boolean	supportsPBMS()
void	timeOut()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MySQLProtocol

public MySQLProtocol(String host,
                     int port,
                     String database,
                     String username,
                     String password,
                     Properties info)
              throws QueryException

Get a protocol instance

Parameters:

host - the host to connect to

port - the port to connect to

database - the initial database

username - the username

password - the password

info -

Throws:

QueryException - if there is a problem reading / sending the packets

Method Detail

close

public void close()
           throws QueryException

Closes socket and stream readers/writers

Specified by:

close in interface Protocol

Throws:

QueryException - if the socket or readers/writes cannot be closed

isClosed

public boolean isClosed()

Description copied from interface: Protocol

returns true if the connection has been closed

Specified by:

isClosed in interface Protocol

Returns:

true if the connection is closed

selectDB

public void selectDB(String database)
              throws QueryException

Description copied from interface: Protocol

selects what database to use

Specified by:

selectDB in interface Protocol

Parameters:

database - the database

Throws:

QueryException - if there is a problem selecting the database

getServerVersion

public String getServerVersion()

Description copied from interface: Protocol

returns the server version string

Specified by:

getServerVersion in interface Protocol

Returns:

setReadonly

public void setReadonly(boolean readOnly)

Description copied from interface: Protocol

sets whether this connection should be read only

TODO: actually enforce this

Specified by:

setReadonly in interface Protocol

Parameters:

readOnly - if the connection should be read only

getReadonly

public boolean getReadonly()

Description copied from interface: Protocol

check if it is possble to execute writing operations on this connection

Specified by:

getReadonly in interface Protocol

Returns:

true if we can update etc

commit

public void commit()
            throws QueryException

Description copied from interface: Protocol

commits the current transaction

Specified by:

commit in interface Protocol

Throws:

QueryException - if there is a problem committing the txn

rollback

public void rollback()
              throws QueryException

Description copied from interface: Protocol

rolls back the current transaction

Specified by:

rollback in interface Protocol

Throws:

QueryException - if there is a problem rolling back

rollback

public void rollback(String savepoint)
              throws QueryException

Description copied from interface: Protocol

rolls back to the given save point

Specified by:

rollback in interface Protocol

Parameters:

savepoint - the save point to roll back to

Throws:

QueryException - if there is a problem rolling back

setSavepoint

public void setSavepoint(String savepoint)
                  throws QueryException

Description copied from interface: Protocol

sets a save point

Specified by:

setSavepoint in interface Protocol

Parameters:

savepoint - the save point name

Throws:

QueryException - if there is a problem setting the save point

releaseSavepoint

public void releaseSavepoint(String savepoint)
                      throws QueryException

Description copied from interface: Protocol

releases the savepoint

Specified by:

releaseSavepoint in interface Protocol

Parameters:

savepoint - the name of the savepoint to release

Throws:

QueryException - if there is a problem releasing the save point

getHost

public String getHost()

Description copied from interface: Protocol

returns the host

Specified by:

getHost in interface Protocol

Returns:

the host we are connected to

getPort

public int getPort()

Description copied from interface: Protocol

returns the port we are connected to

Specified by:

getPort in interface Protocol

Returns:

the port

getDatabase

public String getDatabase()

Description copied from interface: Protocol

returns the current used database

Specified by:

getDatabase in interface Protocol

Returns:

getUsername

public String getUsername()

Description copied from interface: Protocol

returns the current connected username

Specified by:

getUsername in interface Protocol

Returns:

the username

getPassword

public String getPassword()

Description copied from interface: Protocol

the current password

Specified by:

getPassword in interface Protocol

Returns:

the password

ping

public boolean ping()
             throws QueryException

Description copied from interface: Protocol

checks whether the connectiion is still valid

Specified by:

ping in interface Protocol

Returns:

true if it is valid

Throws:

QueryException - if there is a problem communicating

executeQuery

public QueryResult executeQuery(Query dQuery)
                         throws QueryException

Description copied from interface: Protocol

executes a query

Specified by:

executeQuery in interface Protocol

Parameters:

dQuery - the query to execute

Returns:

a query result.

Throws:

QueryException - if there is a problem with the query

addToBatch

public void addToBatch(Query dQuery)

Description copied from interface: Protocol

adds a query to the batch

Specified by:

addToBatch in interface Protocol

Parameters:

dQuery - the query to add

executeBatch

public List<QueryResult> executeBatch()
                               throws QueryException

Description copied from interface: Protocol

executes the batch of queries

Specified by:

executeBatch in interface Protocol

Returns:

a list of query results

Throws:

QueryException - if there is a problem

clearBatch

public void clearBatch()

Description copied from interface: Protocol

clears the current batch

Specified by:

clearBatch in interface Protocol

startBinlogDump

public List<RawPacket> startBinlogDump(int startPos,
                                       String filename)
                                throws BinlogDumpException

Specified by:

startBinlogDump in interface Protocol

Throws:

BinlogDumpException

getDatabaseType

public SupportedDatabases getDatabaseType()

Specified by:

getDatabaseType in interface Protocol

supportsPBMS

public boolean supportsPBMS()

Specified by:

supportsPBMS in interface Protocol

getServerVariable

public String getServerVariable(String variable)
                         throws QueryException

Specified by:

getServerVariable in interface Protocol

Throws:

QueryException

executeQuery

public QueryResult executeQuery(Query dQuery,
                                InputStream inputStream)
                         throws QueryException

Specified by:

executeQuery in interface Protocol

Throws:

QueryException

cancelCurrentQuery

public void cancelCurrentQuery()
                        throws QueryException

cancels the current query - clones the current protocol and executes a query using the new connection

thread safe

Specified by:

cancelCurrentQuery in interface Protocol

Throws:

QueryException

timeOut

public void timeOut()
             throws QueryException

Specified by:

timeOut in interface Protocol

Throws:

QueryException

createDB

public boolean createDB()

Description copied from interface: Protocol

should a database be created if it does not exist ?

Specified by:

createDB in interface Protocol

noPrepStmtCache

public boolean noPrepStmtCache()

Specified by:

noPrepStmtCache in interface Protocol

getMoreResults

public QueryResult getMoreResults()
                           throws QueryException

Specified by:

getMoreResults in interface Protocol

Throws:

QueryException

hexdump

public static String hexdump(byte[] buffer,
                             int offset)

hexdump

public static String hexdump(ByteBuffer bb,
                             int offset)

setCatalog

public void setCatalog(String catalog)
                throws QueryException

Catalogs are not supported in drizzle so this is a no-op with a Drizzle connection
MySQL treats catalogs as databases. The only difference with selectDB(String) is that the catalog is switched inside the connection using SQL 'USE' command

Specified by:

setCatalog in interface Protocol

Parameters:

catalog - the name of a catalog (subspace in this Connection object's database) in which to work

Throws:

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

See Also:

Protocol.getCatalog()

getCatalog

public String getCatalog()
                  throws QueryException

Catalogs are not supported in drizzle so this will always return null with a Drizzle connection
MySQL treats catalogs as databases. This function thus returns the currently selected database

Specified by:

getCatalog in interface Protocol

Returns:

the current catalog name or null if there is none

Throws:

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

See Also:

Protocol.setCatalog(java.lang.String)