Type Members

1.  case class Authorized() extends Response[Authorized] with Product with Serializable

   Server response when the authorization was succeed

2.  case class BatchQuery(id: Int, query: String, params: Seq[Map[Int, ParameterValue]]) extends Command[BatchQuery] with Product with Serializable

   Batch query

   Batch query

   id

   request id

   query

   query text

   params

   list of params

3.  case class Cancel(id: Int) extends Command[Cancel] with Product with Serializable

   Cancels query execution without reading to the end.

4.  case class Cancelled(id: Int) extends Response[Cancelled] with Product with Serializable

   Server response when the query was canceled by Cancel command

5.  abstract class Command[C <: Message[C]] extends Message[C]

   Base class for client messages

6.  case class Credentials(method: String, user: Option[String], password: Option[String]) extends Command[Credentials] with Product with Serializable

   Credentials response from the client

   Credentials response from the client

   method

   authentication method

   user

   user name

   password

   password

7.  case class CredentialsRequest(methods: Seq[String]) extends Response[CredentialsRequest] with Product with Serializable

   Authentication request

   Authentication request

   methods

   supported authentication methods

8.  case class ErrorMessage(message: String, streamId: Option[Int] = None, severity: Byte = ErrorMessage.SEVERITY_ERROR) extends Response[ErrorMessage] with Product with Serializable

   Error message from server to client

   Error message from server to client

   message

   text of the message

   streamId

   if the error related to some query

   severity

   message importance

9.  case class Frame[B](frameType: Byte, payload: B) extends Product with Serializable

   Frame representation

   Frame representation

   frameType

   message type

   payload

   serialized message

10.  case class Heartbeat(time: Int) extends Command[Heartbeat] with Product with Serializable

    Keep alive message from client to server

11.  case class Hello(protocolVersion: Int, clientVersion: String, timestamp: Long, params: Map[String, String]) extends Command[Hello] with Product with Serializable

    Greeting message from client to server

    Greeting message from client to server

    protocolVersion

    client protocol version

    clientVersion

    client version

    timestamp

    client timestamp

    params

    extra params, reserved for new features.

12.  case class HelloResponse(protocolVersion: Int, reqTime: Long) extends Response[HelloResponse] with Product with Serializable

    Server greeting to the client

    Server greeting to the client

    protocolVersion

    server protocol version

    reqTime

    client request time from Hello

13.  trait Message[M <: Message[M]] extends AnyRef

    Base class for all messages.

14.  trait MessageHelper[M <: Message[M]] extends AnyRef

    Helper class for a message type.

    Helper class for a message type. Provides methods to serialize and deserialize messages.

    M

    type of the message

15.  case class NextBatch(id: Int, batchSize: Int) extends Command[NextBatch] with Product with Serializable

    Request for next batch of data

    Request for next batch of data

    id

    request id

    batchSize

    size of requested batch

16.  case class NumericValue(value: BigDecimal) extends ParameterValue with Product with Serializable
17.  sealed trait ParameterValue extends AnyRef
18.  case class Quit() extends Command[Quit] with Product with Serializable
19.  trait Read[T] extends AnyRef
20.  trait ReadWrite[T] extends Read[T] with Write[T]

    Type class for data serialization from / to the ByteReaderWriter

    Type class for data serialization from / to the ByteReaderWriter

    T

    type to be serialized

21.  abstract class Response[R <: Response[R]] extends Message[R]

    Base class for server messages

22.  case class ResultField(name: String, typeName: String) extends Product with Serializable

    Field definition

    Field definition

    name

    field name

    typeName

    field type, e.g VARCHAR, INTEGER

23.  case class ResultFooter(id: Int, millis: Long, rows: Int) extends Response[ResultFooter] with Product with Serializable

    Query execution statistics

    Query execution statistics

    id

    request id

    millis

    execution time

    rows

    number of rows provided to the client

24.  case class ResultHeader(id: Int, tableName: String, fields: Seq[ResultField]) extends Response[ResultHeader] with Product with Serializable

    Query execution result header

    Query execution result header

    id

    request id

    tableName

    result table name

    fields

    fields definitions

25.  case class ResultRow(id: Int, values: Seq[Array[Byte]]) extends Response[ResultRow] with Product with Serializable

    Query result row

    Query result row

    id

    request id

    values

    result values serialized into arrays of bytes

26.  case class SqlQuery(id: Int, query: String, params: Map[Int, ParameterValue]) extends Command[SqlQuery] with Product with Serializable

    Query request

    Query request

    id

    request id. Must be unique within single connection uncompleted queries

    query

    query string

    params

    parameters if there are any (for prepared queries).

27.  case class StringValue(value: String) extends ParameterValue with Product with Serializable
28.  case class TimestampValue(millis: Long) extends ParameterValue with Product with Serializable
29.  trait Write[T] extends AnyRef