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
AClient
implementation that does not operate in a session. Requests are sent to multiple servers given aLoadBalancingStrategy
. 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.AliasClusteredClient, Client.ClusteredClient, Client.SessionedClient, Client.SessionSettings, Client.Settings
-
-
Field Summary
-
Fields inherited from class org.apache.tinkerpop.gremlin.driver.Client
cluster, initialized, settings, TOO_MANY_IN_FLIGHT_REQUESTS
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Client
alias(String graphOrTraversalSource)
Create a newClient
that aliases the specifiedGraph
orTraversalSource
name on the server to a variable called "g" for the context of the requests made through thatClient
.Client
alias(Map<String,String> aliases)
Creates aClient
that supplies the specified set of aliases, thus allowing the user to re-name one or more globally definedGraph
orTraversalSource
server bindings for the context of the createdClient
.protected org.apache.tinkerpop.gremlin.driver.Connection
chooseConnection(RequestMessage msg)
Uses aLoadBalancingStrategy
to choose the bestHost
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.boolean
isClosing()
ResultSet
submit(String gremlin, String graphOrTraversalSource)
Submits a Gremlin script to the server and returns aResultSet
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 aResultSet
once the write of the request is complete.boolean
tryReInitializeHost(Host host)
Attempt to re-initialize theHost
that was previously marked as unavailable.-
Methods inherited from class org.apache.tinkerpop.gremlin.driver.Client
buildMessage, close, getCluster, getSettings, init, makeDefaultAliasMap, submit, submit, submit, submit, submit, submit, submitAsync, submitAsync, submitAsync, submitAsync, submitAsync, submitAsync, submitAsync, submitAsync, submitAsync
-
-
-
-
Method Detail
-
submit
public ResultSet submit(String gremlin, String graphOrTraversalSource)
Submits a Gremlin script to the server and returns aResultSet
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 aResultSet
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 toClient.submit(String)
. Parameterized scripts will perform better.- Parameters:
gremlin
- the gremlin script to executeparameters
- a map of parameters that will be bound to the script on executiongraphOrTraversalSource
- rebinds the specified global Gremlin Server variable to "g"
-
alias
public Client alias(String graphOrTraversalSource)
Create a newClient
that aliases the specifiedGraph
orTraversalSource
name on the server to a variable called "g" for the context of the requests made through thatClient
.
-
alias
public Client alias(Map<String,String> aliases)
Creates aClient
that supplies the specified set of aliases, thus allowing the user to re-name one or more globally definedGraph
orTraversalSource
server bindings for the context of the createdClient
.
-
chooseConnection
protected org.apache.tinkerpop.gremlin.driver.Connection chooseConnection(RequestMessage msg) throws TimeoutException, ConnectionException
Uses aLoadBalancingStrategy
to choose the bestHost
and then selects the best connection from that host's connection pool.- Specified by:
chooseConnection
in classClient
- Throws:
TimeoutException
ConnectionException
-
initializeImplementation
protected void initializeImplementation()
Initializes the connection pools on all hosts.- Specified by:
initializeImplementation
in classClient
-
closeAsync
public CompletableFuture<Void> closeAsync()
Closes all the connection pools on all hosts.- Specified by:
closeAsync
in classClient
-
tryReInitializeHost
public boolean tryReInitializeHost(Host host)
-
-