com.datastax.driver.dse.graph

Class SimpleGraphStatement

java.lang.Object

com.datastax.driver.dse.graph.GraphStatement

com.datastax.driver.dse.graph.RegularGraphStatement

com.datastax.driver.dse.graph.SimpleGraphStatement

public class SimpleGraphStatement
extends RegularGraphStatement

A simple graph statement implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleStatement	statement

Constructor Summary

Constructors

Constructor and Description
SimpleGraphStatement(String query)
SimpleGraphStatement(String query, Map<String,Object> valuesMap)

Method Summary

Modifier and Type	Method and Description
GraphStatement	executingAs(String userOrRole) Allows this statement to be executed as a different user/role than the one currently authenticated (a.k.a.
ConsistencyLevel	getConsistencyLevel() Returns the consistency level to use with this statement.
long	getDefaultTimestamp() The default timestamp for this query.
String	getQueryString() Returns the graph query string for this statement.
int	getReadTimeoutMillis() Return the per-host socket read timeout that was set for this statement.
SimpleGraphStatement	set(String name, Object value) Sets a parameter on this statement.
GraphStatement	setConsistencyLevel(ConsistencyLevel consistencyLevel) Sets the consistency level to use for this statement.
GraphStatement	setDefaultTimestamp(long defaultTimestamp) Sets the default timestamp for this query (in microseconds since the epoch).
GraphStatement	setReadTimeoutMillis(int readTimeoutMillis) Overrides the default per-host read timeout (GraphOptions.setReadTimeoutMillis(int)) for this statement.
SimpleStatement	unwrap() Deprecated.
SimpleStatement	unwrap(GraphOptions graphOptions) "Unwraps" the current graph statement, that is, returns an executable Statement object corresponding to this graph statement.
SimpleStatement	unwrap(GraphProtocol graphProtocol) Deprecated.

Methods inherited from class com.datastax.driver.dse.graph.GraphStatement

getGraphInternalOption, getGraphLanguage, getGraphName, getGraphReadConsistencyLevel, getGraphSource, getGraphWriteConsistencyLevel, getTransformResultFunction, isIdempotent, isSystemQuery, setGraphInternalOption, setGraphLanguage, setGraphName, setGraphReadConsistencyLevel, setGraphSource, setGraphWriteConsistencyLevel, setIdempotent, setSystemQuery, setTransformResultFunction

Methods inherited from class java.lang.Object

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

Field Detail

statement

protected SimpleStatement statement

Constructor Detail

SimpleGraphStatement

public SimpleGraphStatement(String query)

SimpleGraphStatement

public SimpleGraphStatement(String query,
                            Map<String,Object> valuesMap)

Method Detail

getQueryString

public String getQueryString()

Description copied from class: RegularGraphStatement

Returns the graph query string for this statement.

Specified by:

getQueryString in class RegularGraphStatement

Returns:

the graph query string for this statement.

set

public SimpleGraphStatement set(String name,
                                Object value)

Sets a parameter on this statement.

Note that, contrary to CQL parameters, which are identified either by a bind marker "?" or by the sign ":" in front of a parameter name, parameters in Gremlin queries are simply referenced by their names. Please refer to Gremlin's documentation for more information.

Parameter values can be of any type supported by the subprotocol in use: Boolean, Integer, Long, Float, Double, String, Map, List, GraphNode, Element, any geospatial type.

Parameters:

name - the parameter name, as referenced in the graph query.

value - the parameter value.

setConsistencyLevel

public GraphStatement setConsistencyLevel(ConsistencyLevel consistencyLevel)

Description copied from class: GraphStatement

Sets the consistency level to use for this statement.

This setting will affect the general consistency when executing the graph query. However executing a graph query on the server side is going to involve the execution of CQL queries to the persistence engine that is Cassandra. Those queries can be both reads and writes and both will have a settable consistency level. Setting only this property will indicate to the server to use this consistency level for both reads and writes in Cassandra. Read or write consistency level can be set separately with respectively GraphStatement.setGraphReadConsistencyLevel(ConsistencyLevel) and GraphStatement.setGraphWriteConsistencyLevel(ConsistencyLevel) and will override the consistency set here.

Specified by:

setConsistencyLevel in class GraphStatement

Parameters:

consistencyLevel - the consistency level to set.

Returns:

this GraphStatement instance (for method chaining).

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Description copied from class: GraphStatement

Returns the consistency level to use with this statement.

This will return the consistency level used for reads and writes in Cassandra.

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

Specified by:

getConsistencyLevel in class GraphStatement

Returns:

the consistency level configured in this statement.

setDefaultTimestamp

public GraphStatement setDefaultTimestamp(long defaultTimestamp)

Description copied from class: GraphStatement

Sets the default timestamp for this query (in microseconds since the epoch).

The actual timestamp that will be used for this query is, in order of preference:

• the timestamp specified through this method, if different from Long.MIN_VALUE;
• the timestamp returned by the TimestampGenerator currently in use, if different from Long.MIN_VALUE.

If none of these apply, no timestamp will be sent with the query and DseGraph will generate a server-side one.

Specified by:

setDefaultTimestamp in class GraphStatement

Parameters:

defaultTimestamp - the default timestamp for this query (must be strictly positive).

Returns:

this GraphStatement instance (for method chaining).

See Also:

DseCluster.Builder.withTimestampGenerator(com.datastax.driver.core.TimestampGenerator)

getReadTimeoutMillis

public int getReadTimeoutMillis()

Description copied from class: GraphStatement

Return the per-host socket read timeout that was set for this statement.

Specified by:

getReadTimeoutMillis in class GraphStatement

Returns:

the timeout. A negative value means that the timeout has not been set on this statement; the default GraphOptions.getReadTimeoutMillis() will be used.

setReadTimeoutMillis

public GraphStatement setReadTimeoutMillis(int readTimeoutMillis)

Description copied from class: GraphStatement

Overrides the default per-host read timeout (GraphOptions.setReadTimeoutMillis(int)) for this statement.

If you don't call this method, the default GraphOptions.getReadTimeoutMillis() will be used.

Specified by:

setReadTimeoutMillis in class GraphStatement

Parameters:

readTimeoutMillis - the timeout to set. 0 will disable the timeout for the query, negative values are not allowed.

Returns:

this GraphOptions instance (for method chaining).

getDefaultTimestamp

public long getDefaultTimestamp()

Description copied from class: GraphStatement

The default timestamp for this query.

Specified by:

getDefaultTimestamp in class GraphStatement

Returns:

the default timestamp (in microseconds since the epoch).

unwrap

@Deprecated
public SimpleStatement unwrap()

Deprecated.

Description copied from class: GraphStatement

This method is deprecated because a GraphOptions object is required to produce a valid Statement. Use GraphStatement.unwrap(GraphOptions) instead.

This method will call GraphStatement#unwrap(GraphProtocol.GRAPHSON_1_0).

Specified by:

unwrap in class RegularGraphStatement

Returns:

an executable Statement.

unwrap

@Deprecated
public SimpleStatement unwrap(GraphProtocol graphProtocol)

Deprecated.

Description copied from class: GraphStatement

This method is deprecated because a GraphOptions object is required to produce a valid Statement. Use GraphStatement.unwrap(GraphOptions) instead.

This method will call GraphStatement#unwrap(new GraphOptions().setGraphSubProtocol(graphProtocol)).

Specified by:

unwrap in class GraphStatement

unwrap

public SimpleStatement unwrap(GraphOptions graphOptions)

Description copied from class: GraphStatement

"Unwraps" the current graph statement, that is, returns an executable Statement object corresponding to this graph statement.

This method is intended for internal use only, users wishing to execute graph statements should use DseSession.executeGraph(GraphStatement).

This method acts as a bridge between graph statements and regular Statements.

Implementations are free to cache the returned Statement if appropriate.

Overrides:

unwrap in class GraphStatement

Parameters:

graphOptions - the graph options required to encode the statement's parameters into the correct sub-protocol format.

Returns:

an executable Statement.

executingAs

public GraphStatement executingAs(String userOrRole)

Description copied from class: GraphStatement

Allows this statement to be executed as a different user/role than the one currently authenticated (a.k.a. proxy execution).

This feature is only available in DSE 5.1+.

Overrides:

executingAs in class GraphStatement

Parameters:

userOrRole - The user or role name to act as when executing this statement.