IStatement Interface |
Namespace: Dse
public interface IStatement
The IStatement type exposes the following members.
Name | Description | |
---|---|---|
DisableTracing |
Disable tracing for the statement.
| |
EnableTracing |
Enables tracing for the statement
| |
ExecutingAs |
Allows this statement to be executed as a different user/role than the one
currently authenticated (a.k.a. proxy execution).
| |
SetAutoPage | ||
SetConsistencyLevel |
Sets the consistency level for the query. The default consistency level, if this method is not called, is ConsistencyLevel.ONE. | |
SetIdempotence |
Sets whether this statement is idempotent.
Idempotence of the statement plays a role in ISpeculativeExecutionPolicy. If a statement is not idempotent, the driver will not schedule speculative executions for it. | |
SetOutgoingPayload |
Sets a custom outgoing payload for this statement.
Each time this statement is executed, this payload will be included in the request.
Once it is set using this method, the payload should not be modified.
| |
SetPageSize |
Sets the page size for this query.
The page size controls how much resulting rows will be retrieved
simultaneously (the goal being to avoid loading too much results
in memory for queries yielding large results). Please note that
while value as low as 1 can be used, it is highly discouraged to
use such a low value in practice as it will yield very poor
performance. If in doubt, leaving the default is probably a good
idea.
Also note that only SELECT queries ever make use of that setting. the page size to use. If set to 0 or less, the default value will be used. To disable paging of the result set, use int.MaxValueReturn ValueType:this Query object. | |
SetPagingState |
Sets the paging state, a token representing the current page state of query used to continue paging by retrieving the following result page.
Setting the paging state will disable automatic paging.
| |
SetReadTimeoutMillis |
Overrides the default per-host read timeout ReadTimeoutMillis for this statement.
| |
SetRetryPolicy |
Sets the retry policy to use for this query.
Calling this method is only required when you want to override the default RetryPolicy set in the cluster configuration for this request. Use a IExtendedRetryPolicy implementation to cover all error scenarios. | |
SetSerialConsistencyLevel |
Sets the serial consistency level for the query.
The serial consistency level is only used by conditional updates (so INSERT, UPDATE
and DELETE with an IF condition). For those, the serial consistency level defines
the consistency level of the serial phase (or "paxos" phase) while the
normal consistency level defines the consistency for the "learn" phase, i.e. what
type of reads will be guaranteed to see the update right away. For instance, if
a conditional write has a regular consistency of QUORUM (and is successful), then a
QUORUM read is guaranteed to see that write. But if the regular consistency of that
write is ANY, then only a read with a consistency of SERIAL is guaranteed to see it
(even a read with consistency ALL is not guaranteed to be enough).
| |
SetTimestamp |
Sets the timestamp associated with this statement execution.
If provided, this will replace the server side assigned
timestamp as default timestamp. Note that a timestamp in the query itself will still override this timestamp.
|
Name | Description | |
---|---|---|
AutoPage |
Determines if the RowSet returned when executing this IStatement will automatically fetch the following result pages. Defaults to true.
| |
ConsistencyLevel |
Gets the consistency level for this query.
| |
IsIdempotent |
Determines if this statement is idempotent, i.e. whether it can be applied multiple times without
changing the result beyond the initial application.
Idempotence of the statement plays a role in ISpeculativeExecutionPolicy. If a statement is not idempotent, the driver will not schedule speculative executions for it. When the property is null, the driver will use the default value from the GetDefaultIdempotence. | |
IsTracing |
Gets whether tracing is enabled for this query or not.
| |
Keyspace |
Gets the keyspace this query operates on. The returned value should not be null only when the
IStatement applies to a different keyspace to the logged keyspace of the
ISession.
| |
OutgoingPayload |
Gets custom payload for that will be included when executing this Statement.
| |
PageSize |
Gets query's page size.
| |
PagingState |
This object represents the next page to be fetched if the query is multi page. It can be saved and reused
later on a different execution.
| |
QueryValues | ||
ReadTimeoutMillis |
Gets the per-host read timeout for this statement.
When the value is 0 or lower, the default value from the socket options will be used. | |
RetryPolicy |
Gets the retry policy sets for this query, if any.
| |
RoutingKey |
The routing key (in binary raw form) to use for token aware routing of this
query. The routing key is optional in the sense 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. | |
SerialConsistencyLevel |
Gets the serial consistency level for the query.
The serial consistency level is only used by conditional updates (INSERT, UPDATE and DELETE with an IF condition). | |
SkipMetadata | ||
Timestamp |
Gets the timestamp associated with this statement execution.
|