mysql

Type Members

1. class BinaryEncodedRow extends Row

   

   Defines a Row where the data is presumed to be encoded with the mysql binary protocol.

   Defines a Row where the data is presumed to be encoded with the mysql binary protocol. http://dev.mysql.com/doc/internals/en/binary-protocol-resultset-row.html

2. case class ByteValue(b: Byte) extends Value with Product with Serializable

   

3. trait CanBeParameter[-A] extends AnyRef

   

4. case class Capability(mask: Int) extends Product with Serializable

   

5. trait Client extends Closable

   

6. class ClientDispatcher extends GenSerialClientDispatcher[Request, Result, Packet, Packet]

   

   A ClientDispatcher that implements the mysql client/server protocol.

   A ClientDispatcher that implements the mysql client/server protocol. For a detailed exposition of the client/server protocol refer to: http://dev.mysql.com/doc/internals/en/client-server-protocol.html

   Note, the mysql protocol does not support any form of multiplexing so requests are dispatched serially and concurrent requests are queued.

7. case class CloseRequest(stmtId: Int) extends CommandRequest with Product with Serializable

   

   A CloseRequest deallocates a prepared statement on the server.

   A CloseRequest deallocates a prepared statement on the server. No response is sent back to the client. http://dev.mysql.com/doc/internals/en/com-stmt-close.html

8. abstract class CommandRequest extends Request

   

   A command request is a request initiated by the client and has a cmd byte associated with it.

9. trait Decoder[T <: Result] extends (Packet) ⇒ Try[T]

   

   A decoder for Results contained in a single packet.

10. case class DoubleValue(d: Double) extends Value with Product with Serializable

    

11. case class EOF(warnings: Short, serverStatus: Short) extends Result with Product with Serializable

    

12. case class Error(code: Short, sqlState: String, message: String) extends Result with Product with Serializable

    

13. class ExecuteRequest extends CommandRequest

    

    Uses the binary protocol to build an execute request for a prepared statement.

    Uses the binary protocol to build an execute request for a prepared statement. http://dev.mysql.com/doc/internals/en/com-stmt-execute.html

14. case class Field(catalog: String, db: String, table: String, origTable: String, name: String, origName: String, charset: Short, displayLength: Int, fieldType: Short, flags: Short, decimals: Byte) extends Result with Product with Serializable

    

15. case class FloatValue(f: Float) extends Value with Product with Serializable

    

16. case class Handshake(username: Option[String] = None, password: Option[String] = None, database: Option[String] = None, clientCap: Capability = Capability.baseCap, charset: Short = Utf8_general_ci, maxPacketSize: StorageUnit = 1.gigabyte) extends (HandshakeInit) ⇒ Try[HandshakeResponse] with Product with Serializable

    

    Bridges a server handshake (HandshakeInit) with a client handshake (HandshakeResponse) using the given parameters.

    Bridges a server handshake (HandshakeInit) with a client handshake (HandshakeResponse) using the given parameters. This facilitates the connection phase of the mysql protocol.

    username

    MySQL username used to login.

    password

    MySQL password used to login.

    database

    initial database to use for the session.

    clientCap

    The capability this client has.

    charset

    default character established with the server.

    maxPacketSize

    max size of a command packet that the client intends to send to the server. The largest possible packet that can be transmitted to or from a MySQL 5.5 server or client is 1GB.

    returns

    A Try[HandshakeResponse] that encodes incompatibility with the server.

17. case class HandshakeInit(protocol: Byte, version: String, threadId: Int, salt: Array[Byte], serverCap: Capability, charset: Short, status: Short) extends Result with Product with Serializable

    

18. case class HandshakeResponse(username: Option[String], password: Option[String], database: Option[String], clientCap: Capability, salt: Array[Byte], serverCap: Capability, charset: Short, maxPacketSize: Int) extends Request with Product with Serializable

    

    Client response sent during connection phase.

    Client response sent during connection phase. Responsible for encoding credentials used to authenticate a session. http://dev.mysql.com/doc/internals/en/connection-phase-packets.html#packet-Protocol::HandshakeResponse41

19. class IncompatibleServerError extends Exception

    

    A base class for exceptions related to client incompatibility with an upstream MySQL server.

20. case class IntValue(i: Int) extends Value with Product with Serializable

    

21. case class LongValue(l: Long) extends Value with Product with Serializable

    

22. case class LostSyncException(underlying: Throwable) extends RuntimeException with Product with Serializable

    

23. case class OK(affectedRows: Long, insertId: Long, serverStatus: Int, warningCount: Int, message: String) extends Result with Product with Serializable

    

24. sealed trait Parameter extends AnyRef

    

    A value of type A can implicitly convert to a Parameter if an evidence CanBeParameter[A] is available in scope.

    A value of type A can implicitly convert to a Parameter if an evidence CanBeParameter[A] is available in scope. This type is not to be instantiated in any other manner.

25. case class PrepareOK(id: Int, numOfCols: Int, numOfParams: Int, warningCount: Int, columns: Seq[Field] = Nil, params: Seq[Field] = Nil) extends Result with Product with Serializable

    

26. case class PrepareRequest(sqlStatement: String) extends SimpleCommandRequest with Product with Serializable

    

    Allocates a prepared statement on the server from the passed in query string.

    Allocates a prepared statement on the server from the passed in query string. http://dev.mysql.com/doc/internals/en/com-stmt-prepare.html

27. trait PreparedStatement extends AnyRef

    

    A PreparedStatement represents a parameterized sql statement which may be applied concurrently with varying parameters.

28. case class QueryRequest(sqlStatement: String) extends SimpleCommandRequest with Product with Serializable

    

    A QueryRequest is used to send the server a text-based query that is executed immediately.

    A QueryRequest is used to send the server a text-based query that is executed immediately. http://dev.mysql.com/doc/internals/en/com-query.html

29. case class RawValue(typ: Short, charset: Short, isBinary: Boolean, bytes: Array[Byte]) extends Value with Product with Serializable

    

    A RawValue contains the raw bytes that represent a value and enough meta data to decode the bytes.

    A RawValue contains the raw bytes that represent a value and enough meta data to decode the bytes.

    typ

    The mysql type code for this value.

    charset

    The charset encoding of the bytes.

    isBinary

    Disambiguates between the text and binary protocol.

    bytes

    The raw bytes for this value.

30. sealed trait Request extends AnyRef

    

31. sealed trait Result extends AnyRef

    

32. case class ResultSet(fields: Seq[Field], rows: Seq[Row]) extends Result with Product with Serializable

    

33. trait Row extends AnyRef

    

    A Row makes it easy to extract Value's from a mysql row.

    A Row makes it easy to extract Value's from a mysql row. Specific Value's based on mysql column name can be accessed via the apply method.

34. case class ServerError(code: Short, sqlState: String, message: String) extends Exception with Product with Serializable

    

    A catch-all exception class for errors returned from the upstream MySQL server.

35. case class ShortValue(s: Short) extends Value with Product with Serializable

    

36. class SimpleCommandRequest extends CommandRequest

    

    Defines a request that encodes the command byte and associated data into a packet.

37. class StringEncodedRow extends Row

    

    Defines a row where the data is presumed to be encoded with the mysql text-based protocol.

    Defines a row where the data is presumed to be encoded with the mysql text-based protocol. http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-ProtocolText::ResultsetRow

38. case class StringValue(s: String) extends Value with Product with Serializable

    

39. class TimestampValue extends Injectable[Timestamp] with Extractable[Timestamp]

    

    An injector/extractor of java.sql.Timestamp values.

40. trait Transactions extends AnyRef

    

41. case class UseRequest(dbName: String) extends SimpleCommandRequest with Product with Serializable

    

    A UseRequest is used to change the default schema of the connection.

    A UseRequest is used to change the default schema of the connection. http://dev.mysql.com/doc/internals/en/com-init-db.html

42. sealed trait Value extends AnyRef

    

    Defines a Value ADT that represents the domain of values received from a mysql server.