Package

com.twitter.finagle

mysql

Permalink

package mysql

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. mysql
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class BigIntTooLongException extends Exception

    Permalink
  2. case class BigIntValue(bi: BigInt) extends Value with Product with Serializable

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

    Permalink
  4. trait CanBeParameter[-A] extends AnyRef

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

    Permalink
  6. trait Client extends Closable

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

    Permalink

    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

    Permalink

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

  9. trait CursorResult[T] extends Closable

    Permalink

    A closable async stream of projected rows from a CursoredStatement.

  10. trait CursoredStatement extends AnyRef

    Permalink

    A CursoredStatement represents a parameterized sql statement which when applied to parameters yields a lazy stream of rows.

    A CursoredStatement represents a parameterized sql statement which when applied to parameters yields a lazy stream of rows. Can be used concurrently.

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

    Permalink

    A decoder for Results contained in a single packet.

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

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

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

    Permalink
  15. class ExecuteRequest extends CommandRequest

    Permalink

    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

  16. class FetchRequest extends CommandRequest

    Permalink
  17. case class FetchResult(rowPackets: Seq[Packet], containsLastRow: Boolean) extends Result with Product with Serializable

    Permalink
  18. 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

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

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

    Permalink

    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.

    enableFoundRows

    if the server should return the number of found (matched) rows, not the number of changed rows for UPDATE and INSERT ... ON DUPLICATE KEY UPDATE statements.

    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.

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

    Permalink
  22. 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

    Permalink

    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

  23. class IncompatibleServerError extends Exception

    Permalink

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

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

    Permalink
  25. sealed trait IsolationLevel extends AnyRef

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

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

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

    Permalink
  29. sealed trait Parameter extends AnyRef

    Permalink

    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.

  30. 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

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

    Permalink

    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

  32. trait PreparedStatement extends AnyRef

    Permalink

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

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

    Permalink

    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

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

    Permalink

    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.

  35. sealed trait Request extends AnyRef

    Permalink
  36. sealed trait Result extends AnyRef

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

    Permalink
  38. trait Row extends AnyRef

    Permalink

    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.

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

    Permalink

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

  40. case class ServerStatus(mask: Int) extends Product with Serializable

    Permalink

    Represents the ServerStatus as represented in EOF packets

    Represents the ServerStatus as represented in EOF packets

    mask

    the raw bit mask in the EOF packet

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

    Permalink
  42. class SimpleCommandRequest extends CommandRequest

    Permalink

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

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

    Permalink
  44. class TimestampValue extends Injectable[Timestamp] with Extractable[Timestamp]

    Permalink

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

  45. trait Transactions extends AnyRef

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

    Permalink

    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

  47. sealed trait Value extends AnyRef

    Permalink

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

Value Members

  1. object BigDecimalValue extends Injectable[BigDecimal] with Extractable[BigDecimal]

    Permalink
  2. object CanBeParameter

    Permalink
  3. object Capability extends Serializable

    Permalink
  4. object Charset

    Permalink
  5. object Client

    Permalink
  6. object CloseStatementOK extends OK

    Permalink

    Used internally to synthesize a response from the server when sending a prepared statement CloseRequest

  7. object Command

    Permalink
  8. object DateValue extends Injectable[Date] with Extractable[Date]

    Permalink
  9. object EOF extends Decoder[EOF] with Serializable

    Permalink

    Represents and EOF result received from the server which contains any warnings and the server status.

    Represents and EOF result received from the server which contains any warnings and the server status. http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-EOF_Packet

  10. object EmptyValue extends Value with Product with Serializable

    Permalink
  11. object Error extends Decoder[Error] with Serializable

    Permalink

    Represents the Error Packet received from the server and the data sent along with it.

    Represents the Error Packet received from the server and the data sent along with it. http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-ERR_Packet

  12. object ExecuteRequest

    Permalink
  13. object FetchResult extends Serializable

    Permalink
  14. object Field extends Decoder[Field] with Serializable

    Permalink

    Represents the column meta-data associated with a query.

    Represents the column meta-data associated with a query. Sent during ResultSet transmission and as part of the meta-data associated with a Row. http://dev.mysql.com/doc/internals/en/com-query-response.html#packet-Protocol::ColumnDefinition41

  15. object FieldAttributes

    Permalink

    These bit masks are to understand whether corresponding attribute is set for the field.

    These bit masks are to understand whether corresponding attribute is set for the field. Link to source code from mysql is below. https://github.com/mysql/mysql-server/blob/5.7/include/mysql_com.h

  16. object Handshake extends Serializable

    Permalink
  17. object HandshakeInit extends Decoder[HandshakeInit] with Serializable

    Permalink

    First result received from the server as part of the connection phase.

    First result received from the server as part of the connection phase. http://dev.mysql.com/doc/internals/en/connection-phase-packets.html

  18. object IncompatibleCharset extends IncompatibleServerError with Product with Serializable

    Permalink

    Indicates that the server to which the client is connected is configured to use a charset that the client is incompatible with.

  19. object IncompatibleVersion extends IncompatibleServerError with Product with Serializable

    Permalink

    Indicates that the server to which the client is connected is running a version of MySQL that the client is incompatible with.

  20. object IsolationLevel

    Permalink

    MySQL Isolation Levels.

    MySQL Isolation Levels. Used to override the SESSION or GLOBAL isolation level when executing transactions.

    See also

    https://dev.mysql.com/doc/refman/5.7/en/innodb-transaction-isolation-levels.html

    com.twitter.finagle.mysql.Transactions

  21. object NullValue extends Value with Product with Serializable

    Permalink
  22. object OK extends Decoder[OK] with Serializable

    Permalink

    Represents the OK Packet received from the server.

    Represents the OK Packet received from the server. It is sent to indicate that a command has completed succesfully. http://dev.mysql.com/doc/internals/en/generic-response-packets.html#packet-OK_Packet

  23. object Parameter

    Permalink

    Note: There is a Java-friendly API for this object: com.twitter.finagle.mysql.Parameters.

  24. object Parameters

    Permalink

    A Java adaptation of the com.twitter.finagle.mysql.Parameter companion object.

  25. object PingRequest extends SimpleCommandRequest with Product with Serializable

    Permalink

    A request to check if the server is alive.

    A request to check if the server is alive. http://dev.mysql.com/doc/internals/en/com-ping.html

  26. object PrepareOK extends Decoder[PrepareOK] with Serializable

    Permalink

    Meta data returned from the server in response to a prepared statement initialization request COM_STMT_PREPARE.

    Meta data returned from the server in response to a prepared statement initialization request COM_STMT_PREPARE. http://dev.mysql.com/doc/internals/en/com-stmt-prepare-response.html#packet-COM_STMT_PREPARE_OK

  27. object QuitRequest extends SimpleCommandRequest with Product with Serializable

    Permalink

    Tells the server that the client wants to close the connection.

    Tells the server that the client wants to close the connection. http://dev.mysql.com/doc/internals/en/com-quit.html

  28. object ServerStatus extends Serializable

    Permalink
  29. object Type

    Permalink
  30. package transport

    Permalink

Deprecated Value Members

  1. object TimestampValue extends TimestampValue

    Permalink

    Extracts a value in UTC.

    Extracts a value in UTC. To use a different time zone, create an instance of com.twitter.finagle.mysql.TimestampValue.

    Annotations
    @deprecated
    Deprecated

    (Since version 6.20.2)

Inherited from AnyRef

Inherited from Any

Ungrouped