FaunaClient

The Scala native client for FaunaDB.

Create a new client using FaunaClient.apply.

Query requests are made asynchronously: All methods will return a scala.concurrent.Future.

Example:

case class User(ref: RefV, name: String, age: Int)

val client = FaunaClient(secret = "myKeySecret")

val fut = client.query(Get(Ref("classes/users/123")))
val instance = Await.result(fut, 5.seconds)

val userCast =
  for {
    ref <- instance("ref").to[RefV]
    name <- instance("data", "name").to[String]
    age <- instance("data", "age").to[Int]
  } yield {
    User(ref, name, age)
  }

userCast.get

Linear Supertypes

AnyRef, Any

Instance Constructors

new FaunaClient(connection: Connection)

create a new client with a configured com.faunadb.common.Connection.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

Frees any resources held by the client and close the underlying connection.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def query(exprs: Iterable[Expr])(implicit ec: ExecutionContext): Future[IndexedSeq[Value]]

Issues multiple queries as a single transaction.
Issues multiple queries as a single transaction.
exprs
the queries to run.
returns
A scala.concurrent.Future containing an IndexedSeq of the results of each query. Each result is an instance of faunadb.values.Value, which can be cast to a typed value using the faunadb.values.Field API. If *any* query fails, a failed future is returned.
def query(expr: Expr)(implicit ec: ExecutionContext): Future[Value]

Issues a query.
Issues a query.
expr
the query to run, created using the query dsl helpers in faunadb.query.
returns
A scala.concurrent.Future containing the query result. The result is an instance of faunadb.values.Result, which can be cast to a typed value using the faunadb.values.Field API. If the query fails, failed future is returned.
def sessionWith[A](secret: String)(session: (FaunaClient) ⇒ A): A

Creates a new scope to execute session queries.
Creates a new scope to execute session queries. Queries submited within the session scope will be authenticated with the secret provided. A session client shares its parent's com.faunadb.common.Connection instance and is closed as soon as the session scope ends.
secret
user secret for the session scope
session
a function that receives a session client
returns
the value produced by the session function
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object FaunaClient | package faunadb

class FaunaClient extends AnyRef

Instance Constructors

new FaunaClient(connection: Connection)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def query(exprs: Iterable[Expr])(implicit ec: ExecutionContext): Future[IndexedSeq[Value]]

def query(expr: Expr)(implicit ec: ExecutionContext): Future[Value]

def sessionWith[A](secret: String)(session: (FaunaClient) ⇒ A): A

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped