public abstract class BuiltStatement extends RegularStatement
idempotent
Modifier and Type | Method and Description |
---|---|
protected static String |
escapeId(String ident) |
String |
getKeyspace()
Returns the keyspace this query operates on.
|
Object |
getObject(int i)
Returns the
i th value as the Java type matching its CQL type. |
String |
getQueryString()
Returns the query string for this statement.
|
ByteBuffer |
getRoutingKey()
Returns the routing key (in binary raw form) to use for token aware
routing of this query.
|
ByteBuffer[] |
getValues(ProtocolVersion protocolVersion)
The 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 |
isIdempotent()
Whether this statement is idempotent, i.e.
|
RegularStatement |
setForceNoValues(boolean forceNoValues)
Allows to force this builder to not generate values (through its
getValues() method). |
String |
toString()
Returns this statement as a CQL query string.
|
getValues, getValues
disableTracing, enableTracing, getConsistencyLevel, getDefaultTimestamp, getFetchSize, getRetryPolicy, getSerialConsistencyLevel, isTracing, setConsistencyLevel, setDefaultTimestamp, setFetchSize, setIdempotent, setPagingState, setPagingStateUnsafe, setRetryPolicy, setSerialConsistencyLevel
public String getQueryString()
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 RegularStatement
public Object getObject(int i)
i
th value as the Java type matching its CQL type.i
- the index to retrieve.i
th value of this statement.IllegalStateException
- if this statement does not have values.IndexOutOfBoundsException
- if i
is not a valid index for this object.public ByteBuffer getRoutingKey()
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 Statement
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 Statement
null
.public ByteBuffer[] getValues(ProtocolVersion protocolVersion)
RegularStatement
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 force version
1 through Cluster.Builder.withProtocolVersion(com.datastax.driver.core.ProtocolVersion)
or you use
Cassandra 1.2).getValues
in class RegularStatement
protocolVersion
- the protocol version in which the returned values
must be serialized for.null
if there is
no such values.SimpleStatement.SimpleStatement(String, Object...)
public boolean hasValues()
RegularStatement
getValues
will return null
or not.hasValues
in class RegularStatement
false
if RegularStatement.getValues(com.datastax.driver.core.ProtocolVersion)
returns null
, true
otherwise.public Boolean isIdempotent()
Statement
speculative executions
.
If a statement is not idempotent, the driver will not schedule speculative
executions for it.
Note that this method can return null
, in which case the driver will default to
QueryOptions.getDefaultIdempotence()
.
By default, this method returns null
for all statements, except for
BuiltStatement
s, where the value will be inferred from the query: if it updates
counters, prepends/appends to a list, or uses a function call or
QueryBuilder.raw(String)
anywhere in an inserted value,
the result will be false
; otherwise it will be true
.
In all cases, calling Statement.setIdempotent(boolean)
forces a value that overrides every other mechanism.
Note that when a statement is prepared (Session.prepare(String)
), its idempotence flag will be propagated
to all PreparedStatement
s created from it.isIdempotent
in class Statement
null
to use
QueryOptions.getDefaultIdempotence()
.public String toString()
RegularStatement
Statement
objects.
See the javadocs of RegularStatement.getQueryString()
for more information.toString
in class RegularStatement
RegularStatement.getQueryString()
public RegularStatement setForceNoValues(boolean forceNoValues)
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 the getQueryString()
may
return a query string with bind markers (where and when is at the
discretion of the builder) and getValues(com.datastax.driver.core.ProtocolVersion)
will return the binary
values for those markers. This method allows to force the builder to not
generate binary values but rather to serialize 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 one
inputted 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.forceNoValues
- whether or not this builder may generate values.