Trait/Object

com.twitter.finagle.mysql

Client

Related Docs: object Client | package mysql

Permalink

trait Client extends Closable

A MySQL client that is not Service-based like com.twitter.finagle.Mysql.Client is, making it easier to use for most cases.

Example:

  1. Creation:

    import com.twitter.finagle.Mysql
import com.twitter.finagle.mysql.Client
val client: Client = Mysql.client
  .withCredentials("username", "password")
  .withDatabase("database")
  .newRichClient("host:port")
Linear Supertypes
Closable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. Closable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(deadline: Time): Future[Unit]

    Permalink
    Definition Classes
    Closable

  2. abstract def cursor(sql: String): CursoredStatement

    Permalink

    Create a CursoredStatement with the given parameterized sql query.

    Create a CursoredStatement with the given parameterized sql query. The returned cursored statement can be reused and applied with varying parameters.

    Note

    The cursored statements are built on a prepare -> execute -> fetch flow that requires state tracking. It is important to either fully consume the resulting stream, or explicitly call CursorResult.close().

  3. abstract def ping(): Future[Unit]

    Permalink

    Returns the result of pinging the server.

  4. abstract def prepare(sql: String): PreparedStatement

    Permalink

    Returns a new PreparedStatement instance based on the given sql query.

    Returns a new PreparedStatement instance based on the given sql query. The returned prepared statement can be reused and applied with varying parameters.

    Note

    Mysql prepared statements are stateful, that is, they allocate resources on the mysql server. The allocations are managed by a finagle-mysql connection. Closing the client implicitly closes all outstanding PreparedStatements.

  5. abstract def query(sql: String): Future[Result]

    Permalink

    Returns the result of executing the sql query on the server.

    Returns the result of executing the sql query on the server.

    Note: this is a lower-level API. For SELECT queries, prefer using select or read, and use modify for DML (INSERT/UPDATE/DELETE) and DDL.

    returns

    a Result Future. A successful SELECT query will satisfy the Future with a ResultSet while DML and DDL will be an OK. If there is a server error the Future will be failed with a ServerError exception, not an Error from the Result ADT.

  6. abstract def select[T](sql: String)(f: (Row) ⇒ T): Future[Seq[T]]

    Permalink

    Sends the given sql to the server and maps each resulting row to f, a function from Row => T.

    Sends the given sql to the server and maps each resulting row to f, a function from Row => T. If no ResultSet is returned, the function returns an empty Seq.

    Example: 

    1. import com.twitter.finagle.mysql.Client
import com.twitter.util.Future
val client: Client = ???
val names: Future[Seq[String]] =
  client.select("SELECT name FROM employee") { row =>
    row.stringOrNull("name")
  }
    See also

    PreparedStatement.select

    read

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def close(after: Duration): Future[Unit]

    Permalink
    Definition Classes
    Closable

  7. final def close(): Future[Unit]

    Permalink
    Definition Classes
    Closable

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. def modify(sql: String): Future[OK]

    Permalink

    Executes the given DML (e.g.

    Executes the given DML (e.g. INSERT/UPDATE/DELETE) or DDL (e.g. CREATE TABLE, DROP TABLE, COMMIT, START TRANSACTION, etc) given by sql.

    Example: 

    1. import com.twitter.finagle.mysql.{Client, OK}
import com.twitter.util.Future
val client: Client = ???
val result: Future[OK] =
  client.modify("INSERT INTO employee (name) VALUES ('Alice')")
    See also

    PreparedStatement.modify

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. def read(sql: String): Future[ResultSet]

    Permalink

    Executes the given SELECT query given by sql.

    Executes the given SELECT query given by sql.

    Example: 

    1. import com.twitter.finagle.mysql.{Client, ResultSet}
import com.twitter.util.Future
val client: Client = ???
val resultSet: Future[ResultSet] =
  client.read("SELECT name FROM employee")
    See also

    PreparedStatement.read

    select

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped