com.datastax.dse.graph.api

Class DseGraph

java.lang.Object

com.datastax.dse.graph.api.DseGraph

public final class DseGraph
extends Object

Utility class for interacting with DataStax Enterprise Graph and Apache TinkerPop.

Constructor Summary

Constructors

Constructor and Description
DseGraph()

Method Summary

Modifier and Type	Method and Description
static TraversalBatch	batch() Create a TraversalBatch object to perform batch mutations on a DSE Graph.
static <S,E> GraphStatement	statementFromTraversal(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<S,E> traversal) Create an initialized GraphStatement from a GraphTraversal to use directly with a DseSession.
static org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	traversal() Create a GraphTraversalSource that will be used to build Traversals for use with the statementFromTraversal(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<S, E>) method.
static <C extends org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource> C	traversal(Class<C> traversalSourceClass) Create a GraphTraversalSource instance as specified by the traversalSourceClass parameter that will be used to build Traversals for use with the statementFromTraversal(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<S, E>) method.
static org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	traversal(DseSession dseSession) Create a GraphTraversalSource initialized to work remotely with a DSE Graph server, communicating via the DataStax Enterprise Java Driver.
static <C extends org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource> C	traversal(DseSession dseSession, Class<C> traversalSourceClass) Create a GraphTraversalSource instance as specified by the traversalSourceClass parameter, initialized to work remotely with a DSE Graph server, communicating via the DataStax Enterprise Java Driver.
static org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	traversal(DseSession dseSession, GraphOptions graphOptions) Create a GraphTraversalSource initialized to work remotely with a DSE Graph server, communicating via the DataStax Enterprise Java Driver.
static <C extends org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource> C	traversal(DseSession dseSession, GraphOptions graphOptions, Class<C> traversalSourceClass) Create a GraphTraversalSource instance as specified by the traversalSourceClass parameter, initialized to work remotely with a DSE Graph server, communicating via the DataStax Enterprise Java Driver.

Methods inherited from class java.lang.Object

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

Constructor Detail

DseGraph

public DseGraph()

Method Detail

traversal

public static org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource traversal()

Create a GraphTraversalSource that will be used to build Traversals for use with the statementFromTraversal(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<S, E>) method.

Iterating on a GraphTraversalSource created with this method will not work.

Returns:

a simple and non-iterable traversal source, associated to a EmptyGraph.

traversal

public static <C extends org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource> C traversal(Class<C> traversalSourceClass)

Create a GraphTraversalSource instance as specified by the traversalSourceClass parameter that will be used to build Traversals for use with the statementFromTraversal(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<S, E>) method. This method is typically utilized when specifying a DSL-based GraphTraversalSource.

Iterating on a GraphTraversalSource created with this method will not work.

Parameters:

traversalSourceClass - the DSL class to instantiate to work remotely with a DSE Graph server.

Returns:

a simple and non-iterable traversal source, associated to a EmptyGraph.

traversal

public static org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource traversal(DseSession dseSession,
                                                                                                      GraphOptions graphOptions)

Create a GraphTraversalSource initialized to work remotely with a DSE Graph server, communicating via the DataStax Enterprise Java Driver.

Parameters:

dseSession - an initialized and active session created with a DseCluster that will be used internally to communicate with the DSE server. All of the configurations made on the DseSession's creation will be effective when the traversal source is used.

graphOptions - configurations to use for this traversal source. The options on this object will override the ones defined on the GraphOptions of the DseCluster behind the DseSession input.

Returns:

a remotely connected and initialized traversal source that can be used right away.

traversal

public static <C extends org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource> C traversal(DseSession dseSession,
                                                                                                                    GraphOptions graphOptions,
                                                                                                                    Class<C> traversalSourceClass)

Create a GraphTraversalSource instance as specified by the traversalSourceClass parameter, initialized to work remotely with a DSE Graph server, communicating via the DataStax Enterprise Java Driver. This method is typically utilized when specifying a DSL-based GraphTraversalSource.

Parameters:

dseSession - an initialized and active session created with a DseCluster that will be used internally to communicate with the DSE server. All of the configurations made on the DseSession's creation will be effective when the traversal source is used.

graphOptions - configurations to use for this traversal source. The options on this object will override the ones defined on the GraphOptions of the DseCluster behind the DseSession input.

traversalSourceClass - the DSL class to instantiate to work remotely with a DSE Graph server.

Returns:

a remotely connected and initialized traversal source that can be used right away.

traversal

public static org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource traversal(DseSession dseSession)

Create a GraphTraversalSource initialized to work remotely with a DSE Graph server, communicating via the DataStax Enterprise Java Driver.

Parameters:

dseSession - an initialized and active session created with a DseCluster that will be used internally to communicate with the DSE server. All of the configurations made on the DseSession's creation will be effective when the traversal source is used.

Returns:

a remotely connected and initialized traversal source that can be used right away.

traversal

public static <C extends org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource> C traversal(DseSession dseSession,
                                                                                                                    Class<C> traversalSourceClass)

Create a GraphTraversalSource instance as specified by the traversalSourceClass parameter, initialized to work remotely with a DSE Graph server, communicating via the DataStax Enterprise Java Driver. This method is typically utilized when specifying a DSL-based GraphTraversalSource.

Parameters:

dseSession - an initialized and active session created with a DseCluster that will be used internally to communicate with the DSE server. All of the configurations made on the DseSession's creation will be effective when the traversal source is used.

traversalSourceClass - the DSL class to instantiate to work remotely with a DSE Graph server.

Returns:

a remotely connected and initialized traversal source that can be used right away.

statementFromTraversal

public static <S,E> GraphStatement statementFromTraversal(org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal<S,E> traversal)

Create an initialized GraphStatement from a GraphTraversal to use directly with a DseSession.

Parameters:

traversal - the Traversal to use to create the statement.

Returns:

a statement executable in a DseSession.executeGraph(java.lang.String) or DseSession.executeGraphAsync(java.lang.String) call.

batch

public static TraversalBatch batch()

Create a TraversalBatch object to perform batch mutations on a DSE Graph.

Mutations made to the DSE Graph via a TraversalBatch may all or none succeed. In case of an issue during one of the mutations, the execution of the batch will fail and none of the mutations will have been applied. A TraversalBatch can be directly executed via DseSession.executeGraph(java.lang.String).

Note that executing a TraversalBatch via the DseSession will return an empty result. If the batch has completed successfully then there will be no error thrown, otherwise an error is thrown, but no result is ever returned since batch operations are only destined to graph mutations, hence, no result is necessary.

TraversalBatch is only usable against a DSE 6.0+ cluster.

Returns:

the TraversalBatch object allowing to execute mutations inside the same single transaction.