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

Interface GraphSession

All Superinterfaces:

AsyncAutoCloseable, AutoCloseable, Session

All Known Subinterfaces:

CqlSession, DseSession

public interface GraphSession
extends Session

A session that has the ability to execute DSE Graph requests.

Generally this interface won't be referenced directly in an application; instead, you should use CqlSession, which is a combination of this interface and many others for a more integrated usage of DataStax Enterprise's multi-model database via a single entry point. However, it is still possible to cast a CqlSession to a GraphSession to only expose the DSE Graph execution methods.

Field Summary

Fields inherited from interface com.datastax.oss.driver.api.core.session.Session

OSS_DRIVER_COORDINATES

Method Summary

Modifier and Type	Method and Description
default GraphResultSet	execute(GraphStatement<?> graphStatement) Executes a graph statement synchronously (the calling thread blocks until the result becomes available).
default CompletionStage<AsyncGraphResultSet>	executeAsync(GraphStatement<?> graphStatement) Executes a graph statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).

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

checkSchemaAgreement, checkSchemaAgreementAsync, execute, getContext, getKeyspace, getMetadata, getMetrics, getName, isSchemaMetadataEnabled, refreshSchema, refreshSchemaAsync, setSchemaMetadataEnabled

Methods inherited from interface com.datastax.oss.driver.api.core.AsyncAutoCloseable

close, closeAsync, closeFuture, forceCloseAsync, isClosed

Method Detail

execute

@NonNull
default GraphResultSet execute(@NonNull
                                        GraphStatement<?> graphStatement)

Executes a graph statement synchronously (the calling thread blocks until the result becomes available).

The driver provides different kinds of graph statements:

• FluentGraphStatement (recommended): wraps a fluent TinkerPop traversal;
• BatchGraphStatement: groups together multiple mutating traversals (g.addV()/g.addE()) inside a single transaction and avoids multiple client-server round-trips. Improves performance in data ingestion scenarios;
• ScriptGraphStatement: wraps a Gremlin-groovy script provided as a plain Java string. Required for administrative queries such as creating/dropping a graph, configuration and schema.

This feature is only available with Datastax Enterprise. Executing graph queries against an Apache Cassandra® cluster will result in a runtime error.

Parameters:

graphStatement - the graph query to execute (that can be any GraphStatement).

Returns:

the result of the graph query. That result will never be null but can be empty.

See Also:

GraphResultSet

executeAsync

@NonNull
default CompletionStage<AsyncGraphResultSet> executeAsync(@NonNull
                                                                   GraphStatement<?> graphStatement)

Executes a graph statement asynchronously (the call returns as soon as the statement was sent, generally before the result is available).

This feature is only available with Datastax Enterprise. Executing graph queries against an Apache Cassandra® cluster will result in a runtime error.

Parameters:

graphStatement - the graph query to execute (that can be any GraphStatement).

Returns:

the CompletionStage on the result of the graph query.

See Also:

execute(GraphStatement), AsyncGraphResultSet