com.datastax.driver.dse.graph

Class GraphOptions

java.lang.Object

com.datastax.driver.dse.graph.GraphOptions

public class GraphOptions
extends Object

The default graph options to use for a DSE cluster.

These options will be used for all graph statements sent to the cluster, unless they have been explicitly overridden at the statement level (by using methods such as GraphStatement.setGraphName(String)).

Graph options are specified at cluster initialization with DseCluster.Builder.withGraphOptions(GraphOptions), and can be retrieved at runtime with dseCluster.getConfiguration().getGraphOptions().

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GRAPH_LANGUAGE The default value for getGraphLanguage() ("gremlin-groovy").
static String	DEFAULT_GRAPH_SOURCE The default value for getGraphSource() ("g").

Constructor Summary

Constructors

Constructor and Description
GraphOptions()

Method Summary

Modifier and Type	Method and Description
Map<String,ByteBuffer>	buildPayloadWithDefaults(GraphStatement statement) Builds the custom payload for the given statement, providing defaults from these graph options if necessary.
String	getGraphLanguage() Returns the graph language to use in graph queries.
String	getGraphName() Returns the graph name to use in graph queries.
ConsistencyLevel	getGraphReadConsistencyLevel() Returns the read consistency level to use in graph queries.
String	getGraphSource() Returns the graph traversal source name to use in graph queries.
GraphProtocol	getGraphSubProtocol() Return the graph sub protocol set for all queries.
ConsistencyLevel	getGraphWriteConsistencyLevel() Returns the write consistency level to use in graph queries.
int	getReadTimeoutMillis() Return the per-host socket read timeout that is set for all graph queries.
GraphOptions	setGraphLanguage(String graphLanguage) Sets the graph language to use in graph queries.
GraphOptions	setGraphName(String graphName) Sets the graph name to use in graph queries.
GraphOptions	setGraphReadConsistencyLevel(ConsistencyLevel cl) Sets the read consistency level to use for graph queries.
GraphOptions	setGraphSource(String graphSource) Sets the graph traversal source name to use in graph queries.
GraphOptions	setGraphSubProtocol(GraphProtocol graphSubProtocol) Set the sub protocol to use with DSE Graph.
GraphOptions	setGraphWriteConsistencyLevel(ConsistencyLevel cl) Sets the write consistency level to use for graph queries.
GraphOptions	setReadTimeoutMillis(int readTimeoutMillis) Sets the per-host read timeout in milliseconds for graph queries.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GRAPH_LANGUAGE

public static final String DEFAULT_GRAPH_LANGUAGE

The default value for getGraphLanguage() ("gremlin-groovy").

See Also:

Constant Field Values

DEFAULT_GRAPH_SOURCE

public static final String DEFAULT_GRAPH_SOURCE

The default value for getGraphSource() ("g").

See Also:

Constant Field Values

Constructor Detail

GraphOptions

public GraphOptions()

Method Detail

getGraphLanguage

public String getGraphLanguage()

Returns the graph language to use in graph queries.

Returns:

the graph language to use in graph queries.

See Also:

setGraphLanguage(String)

setGraphLanguage

public GraphOptions setGraphLanguage(String graphLanguage)

Sets the graph language to use in graph queries.

This property is required. If you don't call this method, it defaults to "gremlin-groovy".

Parameters:

graphLanguage - the graph language to use in graph queries.

Returns:

this GraphOptions instance (for method chaining).

getGraphSource

public String getGraphSource()

Returns the graph traversal source name to use in graph queries.

Returns:

The graph traversal source name to use in graph queries.

See Also:

setGraphSource(String)

setGraphSource

public GraphOptions setGraphSource(String graphSource)

Sets the graph traversal source name to use in graph queries.

This property is required. If you don't call this method, it defaults to "g".

Parameters:

graphSource - the graph traversal source name to use in graph queries.

Returns:

this GraphOptions instance (for method chaining).

getGraphName

public String getGraphName()

Returns the graph name to use in graph queries.

Returns:

The graph name to use in graph queries.

See Also:

setGraphName(String)

setGraphName

public GraphOptions setGraphName(String graphName)

Sets the graph name to use in graph queries.

This property is optional. If you don't call this method, it is left unset.

Parameters:

graphName - The Graph name to use in graph queries.

Returns:

this GraphOptions instance (for method chaining).

getGraphReadConsistencyLevel

public ConsistencyLevel getGraphReadConsistencyLevel()

Returns the read consistency level to use in graph queries.

Returns:

the read consistency level configured with graph queries.

setGraphReadConsistencyLevel

public GraphOptions setGraphReadConsistencyLevel(ConsistencyLevel cl)

Sets the read consistency level to use for graph queries.

This setting will override the consistency level set with GraphStatement.setConsistencyLevel(ConsistencyLevel) only for the READ part of the graph query.

Please see GraphStatement.setConsistencyLevel(ConsistencyLevel) for more information.

Parameters:

cl - the consistency level to set.

Returns:

this GraphOptions instance (for method chaining).

getGraphWriteConsistencyLevel

public ConsistencyLevel getGraphWriteConsistencyLevel()

Returns the write consistency level to use in graph queries.

Returns:

the write consistency level configured with graph queries.

setGraphWriteConsistencyLevel

public GraphOptions setGraphWriteConsistencyLevel(ConsistencyLevel cl)

Sets the write consistency level to use for graph queries.

This setting will override the consistency level set with GraphStatement.setConsistencyLevel(ConsistencyLevel) only for the write part of the graph query.

Please see GraphStatement.setConsistencyLevel(ConsistencyLevel) for more information.

Parameters:

cl - the consistency level to set.

Returns:

this GraphStatement instance (for method chaining).

getReadTimeoutMillis

public int getReadTimeoutMillis()

Return the per-host socket read timeout that is set for all graph queries.

Returns:

the timeout.

setReadTimeoutMillis

public GraphOptions setReadTimeoutMillis(int readTimeoutMillis)

Sets the per-host read timeout in milliseconds for graph queries. The default is 0, which means the driver will wait until the coordinator responds with the result or an error, or times out.

Only call this method if you want to wait less than the server's default timeout (defined in dse.yaml). Note that the server will abort a query once the client has stopped waiting for it, so there's no risk of leaving long-running queries on the server.

Parameters:

readTimeoutMillis - the timeout to set.

Returns:

this GraphOptions instance (for method chaining).

setGraphSubProtocol

public GraphOptions setGraphSubProtocol(GraphProtocol graphSubProtocol)

Set the sub protocol to use with DSE Graph. See GraphProtocol for more information.

Parameters:

graphSubProtocol - the sub protocol to choose

Returns:

this GraphOptions instance (for method chaining).

getGraphSubProtocol

public GraphProtocol getGraphSubProtocol()

Return the graph sub protocol set for all queries.

Returns:

the sub protocol currently used.

buildPayloadWithDefaults

public Map<String,ByteBuffer> buildPayloadWithDefaults(GraphStatement statement)

Builds the custom payload for the given statement, providing defaults from these graph options if necessary.

This method is intended for internal use only.

Parameters:

statement - the statement.

Returns:

the payload.