public abstract class BuiltStatement extends RegularStatement
|Modifier and Type||Method and Description|
Returns the keyspace this query operates on.
Returns the query string for this statement.
Returns the routing key (in binary raw form) to use for token aware routing of this query.
The values to use for this statement.
Whether or not this statement has values, that is if
Whether this statement is idempotent, i.e.
Allows to force this builder to not generate values (through its
Returns this statement as a CQL query string.
disableTracing, enableTracing, getConsistencyLevel, getDefaultTimestamp, getFetchSize, getRetryPolicy, getSerialConsistencyLevel, isTracing, setConsistencyLevel, setDefaultTimestamp, setFetchSize, setIdempotent, setPagingState, setPagingStateUnsafe, setRetryPolicy, setSerialConsistencyLevel
public String getQueryString()
Statementobjects. For example,
Statementobjects carry numerous protocol-level settings, such as the
consistency levelto 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.
public Object getObject(int i)
ith value as the Java type matching its CQL type.
public ByteBuffer getRoutingKey()
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.
public String getKeyspace()
null. Firstly, some queries do not operate inside a keyspace: keyspace creation,
USEqueries, 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
USEquery (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.
public ByteBuffer getValues(ProtocolVersion protocolVersion)
null) are not supported with the native protocol version 1: you will get an
UnsupportedProtocolVersionExceptionwhen 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).
protocolVersion- the protocol version in which the returned values must be serialized for.
nullif there is no such values.
public boolean hasValues()
public Boolean isIdempotent()
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
nullfor all statements, except for
BuiltStatements, 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
PreparedStatements created from it.
public String toString()
Statementobjects. See the javadocs of
RegularStatement.getQueryString()for more information.
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
nulland 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
trueas 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.