com.datastax.driver.core.querybuilder
Class Update.Options

java.lang.Object
  com.datastax.driver.core.Statement
      com.datastax.driver.core.RegularStatement
          com.datastax.driver.core.querybuilder.Update.Options

Enclosing class:

Update

public static class Update.Options
extends RegularStatement

The options of a UDPATE statement.

Field Summary

protected Boolean	isCounterOp
protected String	keyspace
protected T	statement

Method Summary

Update.Options	and(Using using) Adds the provided option.
protected StringBuilder	buildQueryString()
Statement	disableTracing() Disables tracing for this query.
Statement	enableTracing() Enables tracing for this query.
ConsistencyLevel	getConsistencyLevel() The consistency level for this query.
String	getKeyspace() Returns the keyspace this query operates on.
String	getQueryString() Returns the query string for this statement.
RetryPolicy	getRetryPolicy() Returns the retry policy sets for this query, if any.
ByteBuffer	getRoutingKey() Returns the routing key (in binary raw form) to use for token aware routing of this query.
ByteBuffer[]	getValues() The values to use for this statement.
protected boolean	isCounterOp()
boolean	isTracing() Returns whether tracing is enabled for this query or not.
Update.Conditions	onlyIf(Clause condition) Adds a condition to the UPDATE statement these options are part of.
Statement	setConsistencyLevel(ConsistencyLevel consistency) Sets the consistency level for the query.
protected void	setCounterOp(boolean isCounterOp)
protected void	setDirty()
Statement	setRetryPolicy(RetryPolicy policy) Sets the retry policy to use for this query.
Update.Where	where(Clause clause) Adds a where clause to the UPDATE statement these options are part of.
Update.Assignments	with(Assignment assignment) Adds an assignment to the UPDATE statement those options are part of.

Methods inherited from class com.datastax.driver.core.RegularStatement

toString

Methods inherited from class com.datastax.driver.core.Statement

getFetchSize, getSerialConsistencyLevel, setFetchSize, setSerialConsistencyLevel

Methods inherited from class java.lang.Object

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

Field Detail

statement

protected T extends com.datastax.driver.core.querybuilder.BuiltStatement statement

keyspace

protected final String keyspace

isCounterOp

protected Boolean isCounterOp

Method Detail

and

public Update.Options and(Using using)

Adds the provided option.

Parameters:

using - an UPDATE option.

Returns:

this Options object.

with

public Update.Assignments with(Assignment assignment)

Adds an assignment to the UPDATE statement those options are part of.

Parameters:

assignment - the assignment to add.

Returns:

the assignments of the UPDATE statement those options are part of.

where

public Update.Where where(Clause clause)

Adds a where clause to the UPDATE statement these options are part of.

Parameters:

clause - clause to add.

Returns:

the WHERE clause of the UPDATE statement these options are part of.

onlyIf

public Update.Conditions onlyIf(Clause condition)

Adds a condition to the UPDATE statement these options are part of.

Parameters:

condition - the condition to add.

Returns:

the conditions for the UPDATE statement these options are part of.

getQueryString

public String getQueryString()

Description copied from class: RegularStatement

Returns the query string for this statement.

Returns:

a valid CQL query string.

buildQueryString

protected StringBuilder buildQueryString()

getRoutingKey

public ByteBuffer getRoutingKey()

Description copied from class: Statement

Returns the routing key (in binary raw form) to use for token aware routing of this query.

The routing key is optional in that implementers are free to return null. The routing key is an hint used for token-aware routing (see TokenAwarePolicy), and if provided should correspond to the binary value for the query partition key. However, not providing a routing key never causes a query to fail and if the load balancing policy used is not token aware, then the routing key can be safely ignored.

Returns:

the routing key for this query or null.

getKeyspace

public String getKeyspace()

Description copied from class: Statement

Returns the keyspace this query operates on.

Note that not all query specify on which keyspace they operate on, and so this method can always reutrn null. Firstly, some queries do not operate inside a keyspace: keyspace creation, USE queries, user creation, etc. Secondly, even query that operate within a keyspace do not have to specify said keyspace directly, in which case the currently logged in keyspace (the one set through a USE query (or through the use of Cluster.connect(String))). Lastly, as for the routing key, this keyspace information is only a hint for token-aware routing (since replica placement depend on the replication strategy in use which is a per-keyspace property) and having this method return null (or even a bogus keyspace name) will never cause the query to fail.

Returns:

the keyspace this query operate on if relevant or null.

setDirty

protected void setDirty()

isCounterOp

protected boolean isCounterOp()

setConsistencyLevel

public Statement setConsistencyLevel(ConsistencyLevel consistency)

Description copied from class: Statement

Sets the consistency level for the query.

Overrides:

setConsistencyLevel in class Statement

Parameters:

consistency - the consistency level to set.

Returns:

this Statement object.

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Description copied from class: Statement

The consistency level for this query.

Overrides:

getConsistencyLevel in class Statement

Returns:

the consistency level for this query, or null if no consistency level has been specified (through setConsistencyLevel). In the latter case, the default consistency level will be used.

enableTracing

public Statement enableTracing()

Description copied from class: Statement

Enables tracing for this query. By default (that is unless you call this method), tracing is not enabled.

Overrides:

enableTracing in class Statement

Returns:

this Statement object.

disableTracing

public Statement disableTracing()

Description copied from class: Statement

Disables tracing for this query.

Overrides:

disableTracing in class Statement

Returns:

this Statement object.

isTracing

public boolean isTracing()

Description copied from class: Statement

Returns whether tracing is enabled for this query or not.

Overrides:

isTracing in class Statement

Returns:

true if this query has tracing enabled, false otherwise.

setRetryPolicy

public Statement setRetryPolicy(RetryPolicy policy)

Description copied from class: Statement

Sets the retry policy to use for this query.

The default retry policy, if this method is not called, is the one returned by Policies.getRetryPolicy() in the cluster configuration. This method is thus only useful in case you want to punctually override the default policy for this request.

Overrides:

setRetryPolicy in class Statement

Parameters:

policy - the retry policy to use for this query.

Returns:

this Statement object.

getRetryPolicy

public RetryPolicy getRetryPolicy()

Description copied from class: Statement

Returns the retry policy sets for this query, if any.

Overrides:

getRetryPolicy in class Statement

Returns:

the retry policy sets specifically for this query or null if no query specific retry policy has been set through Statement.setRetryPolicy(com.datastax.driver.core.policies.RetryPolicy) (in which case the Cluster retry policy will apply if necessary).

setCounterOp

protected void setCounterOp(boolean isCounterOp)

getValues

public ByteBuffer[] getValues()

Description copied from class: RegularStatement

The values to use for this statement.

Specified by:

getValues in class RegularStatement

Returns:

the values to use for this statement or null if there is no such values.

See Also:

SimpleStatement.SimpleStatement(String, Object...)