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

Interface GraphStatement<SelfT extends GraphStatement<SelfT>>

Type Parameters:

SelfT - the "self type" used for covariant returns in subtypes.

All Superinterfaces:

Request

All Known Subinterfaces:

BatchGraphStatement, FluentGraphStatement, ScriptGraphStatement

public interface GraphStatement<SelfT extends GraphStatement<SelfT>>
extends Request

A request to execute a DSE Graph query.

Field Summary

Fields

Modifier and Type	Field and Description
static GenericType<CompletionStage<AsyncGraphResultSet>>	ASYNC The type returned when a graph statement is executed asynchronously.
static GenericType<GraphResultSet>	SYNC The type returned when a graph statement is executed synchronously.

Method Summary

Modifier and Type	Method and Description
ConsistencyLevel	getConsistencyLevel() Returns the consistency level to use for the statement.
String	getGraphName() The name of the graph to use for this statement.
default CqlIdentifier	getKeyspace() Graph statements do not have a per-query keyspace, this method always returns null.
ConsistencyLevel	getReadConsistencyLevel() The consistency level to use for the internal read queries that will be produced by this statement.
default ByteBuffer	getRoutingKey() Graph statements can't be routed, this method always returns null.
default CqlIdentifier	getRoutingKeyspace() Graph statements can't be routed, this method always returns null.
default Token	getRoutingToken() Graph statements can't be routed, this method always returns null.
String	getSubProtocol() The DSE graph sub-protocol to use for this statement.
Duration	getTimeout() How long to wait for this request to complete.
long	getTimestamp() Get the timestamp set on the statement.
String	getTraversalSource() The name of the traversal source to use for this statement.
ConsistencyLevel	getWriteConsistencyLevel() The consistency level to use for the internal write queries that will be produced by this statement.
default boolean	isTracing() Whether tracing information should be recorded for this statement.
SelfT	setConsistencyLevel(ConsistencyLevel newConsistencyLevel) Sets the consistency level to use for this statement.
SelfT	setCustomPayload(Map<String,ByteBuffer> newCustomPayload) Sets the custom payload to use for execution.
SelfT	setExecutionProfile(DriverExecutionProfile executionProfile) Sets the configuration profile to use for execution.
SelfT	setExecutionProfileName(String name) Sets the name of the driver configuration profile that will be used for execution.
SelfT	setGraphName(String newGraphName) Sets the graph name.
SelfT	setIdempotent(Boolean idempotent) Set the idempotence to use for execution.
SelfT	setNode(Node newNode) Sets the Node that should handle this query.
SelfT	setReadConsistencyLevel(ConsistencyLevel newReadConsistencyLevel) Sets the read consistency level.
SelfT	setSubProtocol(String newSubProtocol) Sets the sub-protocol.
SelfT	setTimeout(Duration newTimeout) Sets how long to wait for this request to complete.
SelfT	setTimestamp(long timestamp) Set the timestamp to use for execution.
SelfT	setTraversalSource(String newTraversalSource) Sets the traversal source.
SelfT	setWriteConsistencyLevel(ConsistencyLevel newWriteConsistencyLevel) Sets the write consistency level.

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

getCustomPayload, getExecutionProfile, getExecutionProfileName, getNode, isIdempotent

Field Detail

SYNC

static final GenericType<GraphResultSet> SYNC

The type returned when a graph statement is executed synchronously.

Most users won't use this explicitly. It is needed for the generic execute method (Session.execute(Request, GenericType)), but graph statements will generally be run with one of the DSE driver's built-in helper methods (such as GraphSession.execute(GraphStatement)).

ASYNC

static final GenericType<CompletionStage<AsyncGraphResultSet>> ASYNC

The type returned when a graph statement is executed asynchronously.

Most users won't use this explicitly. It is needed for the generic execute method (Session.execute(Request, GenericType)), but graph statements will generally be run with one of the DSE driver's built-in helper methods (such as GraphSession.executeAsync(GraphStatement)).

Method Detail

setIdempotent

@NonNull
 @CheckReturnValue
SelfT setIdempotent(@Nullable
                                                Boolean idempotent)

Set the idempotence to use for execution.

Idempotence defines whether it will be possible to speculatively re-execute the statement, based on a SpeculativeExecutionPolicy.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

Parameters:

idempotent - a boolean instance to set a statement-specific value, or null to use the default idempotence defined in the configuration.

getTimeout

@Nullable
Duration getTimeout()

How long to wait for this request to complete. This is a global limit on the duration of a session.execute() call, including any retries the driver might do.

Note that, if this method returns null, graph statements fall back to a dedicated configuration option: basic.graph.timeout. See reference.conf in the DSE driver distribution for more details.

Specified by:

getTimeout in interface Request

Returns:

the set duration, or null to use the default value defined in the configuration.

See Also:

DefaultDriverOption.REQUEST_TIMEOUT

setTimeout

@NonNull
 @CheckReturnValue
SelfT setTimeout(@Nullable
                                             Duration newTimeout)

Sets how long to wait for this request to complete. This is a global limit on the duration of a session.execute() call, including any retries the driver might do.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

Parameters:

newTimeout - the timeout to use, or null to use the default value defined in the configuration.

See Also:

getTimeout()

setNode

@NonNull
 @CheckReturnValue
SelfT setNode(@Nullable
                                          Node newNode)

Sets the Node that should handle this query.

In the general case, use of this method is heavily discouraged and should only be used in specific cases, such as applying a series of schema changes, which may be advantageous to execute in sequence on the same node.

Configuring a specific node causes the configured LoadBalancingPolicy to be completely bypassed. However, if the load balancing policy dictates that the node is at distance NodeDistance.IGNORED or there is no active connectivity to the node, the request will fail with a NoNodeAvailableException.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

Parameters:

newNode - The node that should be used to handle executions of this statement or null to delegate to the configured load balancing policy.

getTimestamp

long getTimestamp()

Get the timestamp set on the statement.

By default, if left unset, the value returned by this is Long.MIN_VALUE, which means that the timestamp will be set via the Timestamp Generator.

Returns:

the timestamp set on this statement.

setTimestamp

@CheckReturnValue
SelfT setTimestamp(long timestamp)

Set the timestamp to use for execution.

By default the timestamp generator (see reference config file) will be used for timestamps, unless set explicitly via this method.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

setExecutionProfile

@NonNull
 @CheckReturnValue
SelfT setExecutionProfile(@Nullable
                                                      DriverExecutionProfile executionProfile)

Sets the configuration profile to use for execution.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

setExecutionProfileName

@NonNull
 @CheckReturnValue
SelfT setExecutionProfileName(@Nullable
                                                          String name)

Sets the name of the driver configuration profile that will be used for execution.

For all the driver's built-in implementations, this method has no effect if setExecutionProfile(com.datastax.oss.driver.api.core.config.DriverExecutionProfile) has been called with a non-null argument.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

setCustomPayload

@NonNull
 @CheckReturnValue
SelfT setCustomPayload(@NonNull
                                                   Map<String,ByteBuffer> newCustomPayload)

Sets the custom payload to use for execution.

This is intended for advanced use cases, such as tools with very advanced knowledge of DSE Graph, and reserved for internal settings like transaction settings. Note that the driver also adds graph-related options to the payload, in addition to the ones provided here; it won't override any option that is already present.

All the driver's built-in statement implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

Note that it's your responsibility to provide a thread-safe map. This can be achieved with a concurrent or immutable implementation, or by making it effectively immutable (meaning that it's never modified after being set on the statement).

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

getGraphName

@Nullable
String getGraphName()

The name of the graph to use for this statement.

This is the programmatic equivalent of the configuration option basic.graph.name, and takes precedence over it. That is, if this property is non-null, then the configuration will be ignored.

setGraphName

@NonNull
 @CheckReturnValue
SelfT setGraphName(@Nullable
                                               String newGraphName)

Sets the graph name.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

See Also:

getGraphName()

getTraversalSource

@Nullable
String getTraversalSource()

The name of the traversal source to use for this statement.

This is the programmatic equivalent of the configuration option basic.graph.traversal-source, and takes precedence over it. That is, if this property is non-null, then the configuration will be ignored.

setTraversalSource

@NonNull
 @CheckReturnValue
SelfT setTraversalSource(@Nullable
                                                     String newTraversalSource)

Sets the traversal source.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

See Also:

getTraversalSource()

getSubProtocol

@Nullable
String getSubProtocol()

The DSE graph sub-protocol to use for this statement.

This is the programmatic equivalent of the configuration option advanced.graph.sub-protocol, and takes precedence over it. That is, if this property is non-null, then the configuration will be ignored.

setSubProtocol

@NonNull
 @CheckReturnValue
SelfT setSubProtocol(@Nullable
                                                 String newSubProtocol)

Sets the sub-protocol.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

See Also:

getSubProtocol()

getConsistencyLevel

@Nullable
ConsistencyLevel getConsistencyLevel()

Returns the consistency level to use for the statement.

This is the programmatic equivalent of the configuration option basic.request.consistency, and takes precedence over it. That is, if this property is non-null, then the configuration will be ignored.

setConsistencyLevel

@CheckReturnValue
SelfT setConsistencyLevel(@Nullable
                                            ConsistencyLevel newConsistencyLevel)

Sets the consistency level to use for this statement.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

Parameters:

newConsistencyLevel - the consistency level to use, or null to use the default value defined in the configuration.

See Also:

getConsistencyLevel()

getReadConsistencyLevel

@Nullable
ConsistencyLevel getReadConsistencyLevel()

The consistency level to use for the internal read queries that will be produced by this statement.

This is the programmatic equivalent of the configuration option basic.graph.read-consistency-level, and takes precedence over it. That is, if this property is non-null, then the configuration will be ignored.

If this property isn't set here or in the configuration, the default consistency level will be used (getConsistencyLevel() or basic.request.consistency).

setReadConsistencyLevel

@NonNull
 @CheckReturnValue
SelfT setReadConsistencyLevel(@Nullable
                                                          ConsistencyLevel newReadConsistencyLevel)

Sets the read consistency level.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

See Also:

getReadConsistencyLevel()

getWriteConsistencyLevel

@Nullable
ConsistencyLevel getWriteConsistencyLevel()

The consistency level to use for the internal write queries that will be produced by this statement.

This is the programmatic equivalent of the configuration option basic.graph.write-consistency-level, and takes precedence over it. That is, if this property is non-null, then the configuration will be ignored.

If this property isn't set here or in the configuration, the default consistency level will be used (getConsistencyLevel() or basic.request.consistency).

setWriteConsistencyLevel

@NonNull
 @CheckReturnValue
SelfT setWriteConsistencyLevel(@Nullable
                                                           ConsistencyLevel newWriteConsistencyLevel)

Sets the write consistency level.

All the driver's built-in implementations are immutable, and return a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

See Also:

getWriteConsistencyLevel()

getKeyspace

@Nullable
default CqlIdentifier getKeyspace()

Graph statements do not have a per-query keyspace, this method always returns null.

Specified by:

getKeyspace in interface Request

See Also:

CASSANDRA-10145

getRoutingKeyspace

@Nullable
default CqlIdentifier getRoutingKeyspace()

Graph statements can't be routed, this method always returns null.

Specified by:

getRoutingKeyspace in interface Request

getRoutingKey

@Nullable
default ByteBuffer getRoutingKey()

Graph statements can't be routed, this method always returns null.

Specified by:

getRoutingKey in interface Request

getRoutingToken

@Nullable
default Token getRoutingToken()

Graph statements can't be routed, this method always returns null.

Specified by:

getRoutingToken in interface Request

isTracing

default boolean isTracing()

Whether tracing information should be recorded for this statement.

This method is only exposed for future extensibility. At the time of writing, graph statements do not support tracing, and this always returns false.