com.faunadb.client

Class FaunaClient

java.lang.Object

com.faunadb.client.FaunaClient

All Implemented Interfaces:

AutoCloseable

public class FaunaClient
extends Object
implements AutoCloseable

The Java native client for FaunaDB.

This client is asynchronous, so all methods that perform latent operations return a ListenableFuture.

Queries are constructed by using the static helpers in the Language package.

Example:

 import static com.faunadb.client.query.Language.*;
 FaunaClient client = FaunaClient.builder().withSecret("someAuthToken").build();
 client.query(Get(Ref("some/ref")));
 
 

See Also:

Language

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FaunaClient.Builder A builder for creating an instance of FaunaClient

Method Summary

Modifier and Type	Method and Description
static FaunaClient.Builder	builder() Creates a new FaunaClient.Builder
void	close() Frees any resources held by the client.
FaunaClient	newSessionClient(String secret) Creates a session client with the user secret provided.
ListenableFuture<Value>	query(Expr expr) Issues a Query to FaunaDB.
ListenableFuture<ImmutableList<Value>>	query(List<? extends Expr> exprs) Issues multiple queries to FaunaDB.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static FaunaClient.Builder builder()

Creates a new FaunaClient.Builder

newSessionClient

public FaunaClient newSessionClient(String secret)

Creates a session client with the user secret provided. Queries submited to a session client will be authenticated with the secret provided. A session client shares its parent's Connection instance.

Parameters:

secret - user secret for the session client

Returns:

a new FaunaClient

close

public void close()

Frees any resources held by the client. Also closes the underlying Connection.

Specified by:

close in interface AutoCloseable

query

public ListenableFuture<Value> query(Expr expr)

Issues a Query to FaunaDB.

Queries are modeled through the FaunaDB query language, represented by the helper functions in the Language class.

Responses are modeled as a general response tree. Each node is a Value, and can be coerced to structured types through various methods on that class.

Parameters:

expr - The query expression to be sent to FaunaDB.

Returns:

A ListenableFuture containing the root node of the Response tree.

See Also:

Value, Language

query

public ListenableFuture<ImmutableList<Value>> query(List<? extends Expr> exprs)

Issues multiple queries to FaunaDB.

These queries are sent to FaunaDB in a single request, and are evaluated. The list of response nodes is returned in the same order as the issued queries.

See query(Expr) for more information on the individual queries.

Parameters:

exprs - the list of query expressions to be sent to FaunaDB.

Returns:

a ListenableFuture containing an ordered list of root response nodes.