DataStax Java Driver

Graph

The driver provides full support for DSE graph, the distributed graph database available in DataStax Enterprise. The CqlSession interface extends GraphSession, which adds specialized methods to execute requests expressed in the Gremlin graph traversal language.

This manual only covers driver usage; for more information about server-side configuration and data modeling, refer to the DSE developer guide.

Note: graph capabilities require the Apache TinkerPop™ library to be present on the classpath. The driver has a non-optional dependency on that library, but if your application does not use graph at all, it is possible to exclude it to minimize the number of runtime dependencies (see the Integration>Driver dependencies section for more details). If the library cannot be found at runtime, graph queries won’t be available and a warning will be logged, but the driver will otherwise operate normally (this is also valid for OSGi deployments).

If you do use graph, it is important to keep the precise TinkerPop version that the driver depends on: unlike the driver, TinkerPop does not follow semantic versioning, so even a patch version change (e.g. 3.3.0 vs 3.3.3) could introduce incompatibilities. So do not declare an explicit dependency in your application, let the driver pull it transitively.

Overview

There are 3 ways to execute graph requests:

Passing a Gremlin script directly in a plain Java string. We’ll refer to this as the script API:

CqlSession session = CqlSession.builder().build();

String script = "g.V().has('name', name)";
ScriptGraphStatement statement =
    ScriptGraphStatement.builder(script)
        .withQueryParam("name", "marko")
        .build();

GraphResultSet result = session.execute(statement);
for (GraphNode node : result) {
  System.out.println(node.asVertex());
}

Building a traversal with the TinkerPop fluent API, and executing it explicitly with the session:

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

GraphTraversal<Vertex, Vertex> traversal = g.V().has("name", "marko");
FluentGraphStatement statement = FluentGraphStatement.newInstance(traversal);

GraphResultSet result = session.execute(statement);
for (GraphNode node : result) {
  System.out.println(node.asVertex());
}

Building a connected traversal with the fluent API, and executing it implicitly by invoking a terminal step:

GraphTraversalSource g = DseGraph.g
    .withRemote(DseGraph.remoteConnectionBuilder(session).build());

List<Vertex> vertices = g.V().has("name", "marko").toList();

All executions modes rely on the same set of configuration options.

The script and explicit fluent API return driver-specific result sets. The implicit fluent API returns Apache TinkerPop™ types directly.

Graph

Overview

Contents