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

Interface GraphResultSet

All Superinterfaces:

Iterable<GraphNode>

public interface GraphResultSet
extends Iterable<GraphNode>

The result of a synchronous Graph query.

This object is a container for GraphNode objects that will contain the data returned by Graph queries.

Note that this object can only be iterated once: items are "consumed" as they are read, subsequent calls to iterator() will return the same iterator instance.

The default implementation returned by the driver is not thread-safe. It can only be iterated by the thread that invoked dseSession.execute.

See Also:

GraphNode, GraphSession.execute(GraphStatement)

Method Summary

Modifier and Type	Method and Description
default List<GraphNode>	all() Returns all the remaining nodes as a list; not recommended for paginated queries that return a large number of nodes.
void	cancel() Cancels the query and asks the server to stop sending results.
GraphExecutionInfo	getExecutionInfo() Deprecated. Use getRequestExecutionInfo() instead.
default ExecutionInfo	getRequestExecutionInfo() The execution information for the query that have been performed to assemble this result set.
default GraphNode	one() Returns the next node, or null if the result set is exhausted.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

one

@Nullable
default GraphNode one()

Returns the next node, or null if the result set is exhausted.

This is convenient for queries that are known to return exactly one row, for example count queries.

all

@NonNull
default List<GraphNode> all()

Returns all the remaining nodes as a list; not recommended for paginated queries that return a large number of nodes.

At this time (DSE 6.0.0), graph queries are not paginated and the server sends all the results at once.

cancel

void cancel()

Cancels the query and asks the server to stop sending results.

At this time (DSE 6.0.0), graph queries are not paginated and the server sends all the results at once; therefore this method has no effect.

getRequestExecutionInfo

@NonNull
default ExecutionInfo getRequestExecutionInfo()

The execution information for the query that have been performed to assemble this result set.

getExecutionInfo

@Deprecated
 @NonNull
GraphExecutionInfo getExecutionInfo()

Deprecated. Use getRequestExecutionInfo() instead.