org.apache.tinkerpop.gremlin.driver

Class Client.ClusteredClient

java.lang.Object

org.apache.tinkerpop.gremlin.driver.Client

org.apache.tinkerpop.gremlin.driver.Client.ClusteredClient

Enclosing class:

Client

public static final class Client.ClusteredClient
extends Client

A Client implementation that does not operate in a session. Requests are sent to multiple servers given a LoadBalancingStrategy. Transactions are automatically committed (or rolled-back on error) after each request.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tinkerpop.gremlin.driver.Client

Client.ClusteredClient, Client.ReboundClusteredClient, Client.SessionedClient

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.driver.Client

cluster, initialized

Method Summary

Modifier and Type	Method and Description
protected org.apache.tinkerpop.gremlin.driver.Connection	chooseConnection(RequestMessage msg) Uses a LoadBalancingStrategy to choose the best Host and then selects the best connection from that host's connection pool.
CompletableFuture<Void>	closeAsync() Closes all the connection pools on all hosts.
protected void	initializeImplementation() Initializes the connection pools on all hosts.
Client	rebind(Map<String,String> rebindings) Creates a Client that supplies the specified set of rebindings, thus allowing the user to re-name one or more globally defined Graph or TraversalSource server bindings for the context of the created Client.
Client	rebind(String graphOrTraversalSource) Create a new Client that rebinds the specified Graph or TraversalSource name on the server to a variable called "g" for the context of the requests made through that Client.
ResultSet	submit(String gremlin, String graphOrTraversalSource) Submits a Gremlin script to the server and returns a ResultSet once the write of the request is complete.
ResultSet	submit(String gremlin, String graphOrTraversalSource, Map<String,Object> parameters) Submits a Gremlin script and bound parameters to the server and returns a ResultSet once the write of the request is complete.
CompletableFuture<ResultSet>	submitAsync(String gremlin, String graphOrTraversalSource, Map<String,Object> parameters) The asynchronous version of Client.submit(String, Map)} where the returned future will complete when the write of the request completes.

Methods inherited from class org.apache.tinkerpop.gremlin.driver.Client

buildMessage, close, init, submit, submit, submitAsync, submitAsync, submitAsync

Methods inherited from class java.lang.Object

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

Method Detail

submit

public ResultSet submit(String gremlin,
                        String graphOrTraversalSource)

Submits a Gremlin script to the server and returns a ResultSet once the write of the request is complete.

Parameters:

gremlin - the gremlin script to execute

submit

public ResultSet submit(String gremlin,
                        String graphOrTraversalSource,
                        Map<String,Object> parameters)

Submits a Gremlin script and bound parameters to the server and returns a ResultSet once the write of the request is complete. If a script is to be executed repeatedly with slightly different arguments, prefer this method to concatenating a Gremlin script from dynamically produced strings and sending it to Client.submit(String). Parameterized scripts will perform better.

Parameters:

gremlin - the gremlin script to execute

parameters - a map of parameters that will be bound to the script on execution

graphOrTraversalSource - rebinds the specified global Gremlin Server variable to "g"

submitAsync

public CompletableFuture<ResultSet> submitAsync(String gremlin,
                                                String graphOrTraversalSource,
                                                Map<String,Object> parameters)

The asynchronous version of Client.submit(String, Map)} where the returned future will complete when the write of the request completes.

Parameters:

gremlin - the gremlin script to execute

parameters - a map of parameters that will be bound to the script on execution

graphOrTraversalSource - rebinds the specified global Gremlin Server variable to "g"

rebind

public Client rebind(String graphOrTraversalSource)

Create a new Client that rebinds the specified Graph or TraversalSource name on the server to a variable called "g" for the context of the requests made through that Client.

Specified by:

rebind in class Client

Parameters:

graphOrTraversalSource - rebinds the specified global Gremlin Server variable to "g"

rebind

public Client rebind(Map<String,String> rebindings)

Creates a Client that supplies the specified set of rebindings, thus allowing the user to re-name one or more globally defined Graph or TraversalSource server bindings for the context of the created Client.

chooseConnection

protected org.apache.tinkerpop.gremlin.driver.Connection chooseConnection(RequestMessage msg)
                                                                   throws TimeoutException,
                                                                          ConnectionException

Uses a LoadBalancingStrategy to choose the best Host and then selects the best connection from that host's connection pool.

Specified by:

chooseConnection in class Client

Throws:

TimeoutException

ConnectionException

initializeImplementation

protected void initializeImplementation()

Initializes the connection pools on all hosts.

Specified by:

initializeImplementation in class Client

closeAsync

public CompletableFuture<Void> closeAsync()

Closes all the connection pools on all hosts.

Specified by:

closeAsync in class Client