com.faunadb.client

Class FaunaClient

java.lang.Object

com.faunadb.client.FaunaClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class FaunaClient
extends java.lang.Object
implements java.lang.AutoCloseable

The Java native client for FaunaDB.

The client is asynchronous. All methods that performs latent operations return an instance of CompletableFuture.

The close() method must be called in order to release the FaunaClient I/O resources.

Queries are constructed by using the static methods in the Language class.

Example:

 import static com.faunadb.client.query.Language.*;

 FaunaClient client = FaunaClient.builder()
   .withSecret("someAuthToken")
   .build();

 client.query(
   Get(
     Ref(Class("some_class"), "123")
   )
 );
 
 

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() Releases any resources being held by the FaunaClient instance.
FaunaClient	newSessionClient(java.lang.String secret) Creates a session client with the user secret provided.
java.util.concurrent.CompletableFuture<java.util.List<Value>>	query(Expr... exprs) Issues multiple queries to FaunaDB.
java.util.concurrent.CompletableFuture<Value>	query(Expr expr) Issues a Query to FaunaDB.
java.util.concurrent.CompletableFuture<java.util.List<Value>>	query(java.util.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

Returns:

FaunaClient.Builder

newSessionClient

public FaunaClient newSessionClient(java.lang.String secret)

Creates a session client with the user secret provided. Queries submitted to a session client will be authenticated with the secret provided. A session client shares its parent's Connection instance and must be closed after used.

Parameters:

secret - user secret for the session client

Returns:

a new FaunaClient

close

public void close()

Releases any resources being held by the FaunaClient instance.

Specified by:

close in interface java.lang.AutoCloseable

query

public java.util.concurrent.CompletableFuture<Value> query(Expr expr)

Issues a Query to FaunaDB.

Queries are constructed by the helper methods in the Language class.

Responses are represented as structured tree where each node is a Value instance. Value instances can be converted to native types. See Value class for details.

Parameters:

expr - the query to be executed.

Returns:

a CompletableFuture containing the root node of the response tree.

See Also:

Value, Language

query

public java.util.concurrent.CompletableFuture<java.util.List<Value>> query(Expr... exprs)

Issues multiple queries to FaunaDB.

These queries are sent to FaunaDB in a single request. A list containing all responses is returned in the same order as the issued queries.

Parameters:

exprs - the list of queries to be sent to FaunaDB.

Returns:

a CompletableFuture containing an ordered list of the query's responses.

query

public java.util.concurrent.CompletableFuture<java.util.List<Value>> query(java.util.List<? extends Expr> exprs)

Issues multiple queries to FaunaDB.

These queries are sent to FaunaDB in a single request. A list containing all responses is returned in the same order as the issued queries.

Parameters:

exprs - the list of queries to be sent to FaunaDB.

Returns:

a CompletableFuture containing an ordered list of the query's responses.