public static class Update.Assignments extends BuiltStatement
idempotent, NULL_PAYLOAD_VALUE
Modifier and Type | Method and Description |
---|---|
Update.Assignments |
and(Assignment assignment)
Adds a new assignment for this UPDATE statement.
|
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(CodecRegistry codecRegistry)
Returns the query string for this statement.
|
RetryPolicy |
getRetryPolicy()
Returns the retry policy sets for this query, if any.
|
ByteBuffer |
getRoutingKey(ProtocolVersion protocolVersion,
CodecRegistry codecRegistry)
Returns the routing key (in binary raw form) to use for token aware
routing of this query.
|
ByteBuffer[] |
getValues(ProtocolVersion protocolVersion,
CodecRegistry codecRegistry)
The positional values to use for this statement.
|
boolean |
hasValues()
Whether or not this statement has values, that is if
getValues
will return null or not. |
boolean |
isTracing()
Returns whether tracing is enabled for this query or not.
|
Update.Conditions |
onlyIf(Clause condition)
Adds a condition to the UPDATE statement those assignments are part of.
|
Statement |
setConsistencyLevel(ConsistencyLevel consistency)
Sets the consistency level for the query.
|
RegularStatement |
setForceNoValues(boolean forceNoValues)
Allows to force this builder to not generate values (through its
getValues() method). |
Statement |
setRetryPolicy(RetryPolicy policy)
Sets the retry policy to use for this query.
|
String |
toString()
Returns this statement as a CQL query string.
|
Update.Options |
using(Using using)
Adds an option to the UPDATE statement those assignments are part of.
|
Update.Where |
where(Clause clause)
Adds a where clause to the UPDATE statement those assignments are part of.
|
escapeId, getNamedValues, getObject, getObject, hasValues, isIdempotent, usesNamedValues
getQueryString
getDefaultTimestamp, getFetchSize, getOutgoingPayload, getReadTimeoutMillis, getSerialConsistencyLevel, isBatchIdempotent, setDefaultTimestamp, setFetchSize, setIdempotent, setOutgoingPayload, setPagingState, setPagingState, setPagingStateUnsafe, setReadTimeoutMillis, setSerialConsistencyLevel
public Update.Assignments and(Assignment assignment)
assignment
- the new Assignment to add.public Update.Where where(Clause clause)
clause
- the clause to add.public Update.Options using(Using using)
using
- the using clause to add.public Update.Conditions onlyIf(Clause condition)
Statement.isIdempotent()
for more information.condition
- the condition to add.public String getQueryString(CodecRegistry codecRegistry)
RegularStatement
Statement
objects.
For example, Statement
objects carry numerous protocol-level
settings, such as the consistency level
to use,
or the idempotence flag
, among others.
None of these settings will be included in the resulting query string.
Similarly, if values have been set on this statement because
it has bind markers, these values will not appear in the resulting query string.
Note: the consistency level was conveyed at CQL level in older versions
of the CQL grammar, but since CASSANDRA-4734
it is now a protocol-level setting and consequently does not appear in the query string.getQueryString
in class BuiltStatement
codecRegistry
- the codec registry that will be used if the actual
implementation needs to serialize Java objects in the
process of generating the query. Note that it might be
possible to use the no-arg RegularStatement.getQueryString()
depending on the type of statement this is called on.RegularStatement.getQueryString()
public ByteBuffer getRoutingKey(ProtocolVersion protocolVersion, CodecRegistry codecRegistry)
Statement
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.getRoutingKey
in class BuiltStatement
protocolVersion
- the protocol version that will be used if the actual
implementation needs to serialize something to compute
the key.codecRegistry
- the codec registry that will be used if the actual
implementation needs to serialize something to compute
this key.null
.public String getKeyspace()
Statement
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.getKeyspace
in class BuiltStatement
null
.public RegularStatement setForceNoValues(boolean forceNoValues)
BuiltStatement
getValues()
method).
By default (and unless the protocol version 1 is in use, see below) and
for performance reasons, the query builder will not serialize all values
provided to strings. This means that BuiltStatement.getQueryString(CodecRegistry)
may return a query string with bind markers (where and when is at the
discretion of the builder) and BuiltStatement.getValues(com.datastax.driver.core.ProtocolVersion, com.datastax.driver.core.CodecRegistry)
will return the binary
values for those markers. This method allows to force the builder to not
generate binary values but rather to inline them all in the query
string. In practice, this means that if you call setForceNoValues(true)
, you are guaranteed that getValues()
will
return null
and that the string returned by getQueryString()
will contain no other bind markers than the ones
specified by the user.
If the native protocol version 1 is in use, the driver will default
to not generating values since those are not supported by that version of
the protocol. In practice, the driver will automatically call this method
with true
as argument prior to execution. Hence, calling this
method when the protocol version 1 is in use is basically a no-op.
Note that this method is mainly useful for debugging purpose. In general,
the default behavior should be the correct and most efficient one.setForceNoValues
in class BuiltStatement
forceNoValues
- whether or not this builder may generate values.public Statement setConsistencyLevel(ConsistencyLevel consistency)
Statement
setConsistencyLevel
in class Statement
consistency
- the consistency level to set.Statement
object.public ConsistencyLevel getConsistencyLevel()
Statement
getConsistencyLevel
in class Statement
null
if no
consistency level has been specified (through setConsistencyLevel
).
In the latter case, the default consistency level will be used.public Statement enableTracing()
Statement
enableTracing
in class Statement
Statement
object.public Statement disableTracing()
Statement
disableTracing
in class Statement
Statement
object.public boolean isTracing()
Statement
public Statement setRetryPolicy(RetryPolicy policy)
Statement
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.setRetryPolicy
in class Statement
policy
- the retry policy to use for this query.Statement
object.public RetryPolicy getRetryPolicy()
Statement
getRetryPolicy
in class Statement
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).public ByteBuffer[] getValues(ProtocolVersion protocolVersion, CodecRegistry codecRegistry)
RegularStatement
RegularStatement.getNamedValues(ProtocolVersion, CodecRegistry)
will return null
.
Values for a RegularStatement (i.e. if either method does not return
null
) are not supported with the native protocol version 1: you
will get an UnsupportedProtocolVersionException
when submitting
one if version 1 of the protocol is in use (i.e. if you've forced version
1 through Cluster.Builder.withProtocolVersion(com.datastax.driver.core.ProtocolVersion)
or you use
Cassandra 1.2).getValues
in class BuiltStatement
protocolVersion
- the protocol version that will be used to serialize
the values.codecRegistry
- the codec registry that will be used to serialize the
values.SimpleStatement.SimpleStatement(String, Object...)
public boolean hasValues()
RegularStatement
getValues
will return null
or not.
This method calls RegularStatement.hasValues(CodecRegistry)
with ProtocolVersion.NEWEST_SUPPORTED
.
Whether you should use this or the other variant depends on the type of statement this is
called on:
SimpleStatement
or SchemaStatement
, the codec registry isn't
actually needed, so it's always safe to use this method;BuiltStatement
you can use this method if you use no custom codecs, or if
your custom codecs are registered with the default registry. Otherwise, use the other method and
provide the registry that contains your codecs (see BuiltStatement
for more explanations
on why this is so);BatchStatement
, use the first rule if it contains no built statements,
or the second rule otherwise.hasValues
in class RegularStatement
false
if RegularStatement.getValues(com.datastax.driver.core.ProtocolVersion, com.datastax.driver.core.CodecRegistry)
returns null
, true
otherwise.public String toString()
RegularStatement
Statement
objects.
See the javadocs of RegularStatement.getQueryString()
for more information.toString
in class BuiltStatement
RegularStatement.getQueryString()