com.datastax.dse.driver.api.core.graph

Interface BatchGraphStatement

All Superinterfaces:

GraphStatement<BatchGraphStatement>, Iterable<org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal>, Request

public interface BatchGraphStatement
extends GraphStatement<BatchGraphStatement>, Iterable<org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal>

A graph statement that groups multiple mutating traversals together, to be executed in the same transaction.

It is reserved for graph mutations, and does not return any result.

All the mutations grouped in the batch will either all succeed, or they will all be discarded and return an error.

The default implementation returned by the driver is immutable and thread-safe. Each mutation operation returns a copy. If you chain many of those operations, it is recommended to use builder() instead for better memory usage.

Typically used like so:

 import static com.datastax.dse.driver.api.core.graph.DseGraph.g;

 BatchGraphStatement statement =
     BatchGraphStatement.builder()
         .addTraversal(
                 g.addV("person").property("name", "batch1").property("age", 1))
         .addTraversal(
                 g.addV("person").property("name", "batch2").property("age", 2))
         .build();

 GraphResultSet graphResultSet = dseSession.execute(statement);
 

See Also:

DseGraph.g

Field Summary

Fields inherited from interface com.datastax.dse.driver.api.core.graph.GraphStatement

ASYNC, SYNC

Method Summary

Modifier and Type	Method and Description
BatchGraphStatement	addTraversal(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal traversal) Add a traversal to this statement.
BatchGraphStatement	addTraversals(Iterable<org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal> traversals) Adds several traversals to this statement.
static BatchGraphStatementBuilder	builder() Create a builder helper object to start creating a new instance.
static BatchGraphStatementBuilder	builder(BatchGraphStatement template) Create a builder helper object to start creating a new instance with an existing statement as a template.
static BatchGraphStatement	newInstance() Create a new, empty instance.
static BatchGraphStatement	newInstance(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal... traversals) Create a new instance from the given list of traversals.
static BatchGraphStatement	newInstance(Iterable<org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal> traversals) Create a new instance from the given list of traversals.
int	size() Get the number of traversals already added to this statement.

Methods inherited from interface com.datastax.dse.driver.api.core.graph.GraphStatement

getConsistencyLevel, getGraphName, getKeyspace, getReadConsistencyLevel, getRoutingKey, getRoutingKeyspace, getRoutingToken, getSubProtocol, getTimeout, getTimestamp, getTraversalSource, getWriteConsistencyLevel, isTracing, setConsistencyLevel, setCustomPayload, setExecutionProfile, setExecutionProfileName, setGraphName, setIdempotent, setNode, setReadConsistencyLevel, setSubProtocol, setTimeout, setTimestamp, setTraversalSource, setWriteConsistencyLevel

Methods inherited from interface com.datastax.oss.driver.api.core.session.Request

getCustomPayload, getExecutionProfile, getExecutionProfileName, getNode, getPartitioner, isIdempotent

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

newInstance

@NonNull
static BatchGraphStatement newInstance()

Create a new, empty instance.

Traversals can be added with addTraversal(GraphTraversal).

newInstance

@NonNull
static BatchGraphStatement newInstance(@NonNull
                                                Iterable<org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal> traversals)

Create a new instance from the given list of traversals.

newInstance

@NonNull
static BatchGraphStatement newInstance(@NonNull
                                                org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal... traversals)

Create a new instance from the given list of traversals.

builder

@NonNull
static BatchGraphStatementBuilder builder()

Create a builder helper object to start creating a new instance.

Note that this builder is mutable and not thread-safe.

builder

@NonNull
static BatchGraphStatementBuilder builder(@NonNull
                                                   BatchGraphStatement template)

Create a builder helper object to start creating a new instance with an existing statement as a template. The traversals and options set on the template will be copied for the new statement at the moment this method is called.

Note that this builder is mutable and not thread-safe.

addTraversal

@NonNull
BatchGraphStatement addTraversal(@NonNull
                                          org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal traversal)

Add a traversal to this statement. If many traversals need to be added, use a builder(), or the addTraversals(Iterable) method instead to avoid intermediary copies.

addTraversals

@NonNull
BatchGraphStatement addTraversals(@NonNull
                                           Iterable<org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal> traversals)

Adds several traversals to this statement. If this method is to be called many times, consider using a builder() instead to avoid intermediary copies.

size

int size()

Get the number of traversals already added to this statement.