BatchStatement Class

Initializes a new instance of the BatchStatement class

Determines if the RowSet returned when executing this IStatement will automatically fetch the following result pages. Defaults to true.

Gets the batch type

Gets the consistency level for this query.

Gets the host configured on this Statement, or null if none is configured.

In the general case, the host used to execute this Statement will depend on the configured ILoadBalancingPolicy and this property will return null.

Determines if the batch does not contain any query

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.

Gets whether tracing is enabled for this query or not.

Gets custom payload for that will be included when executing this Statement.

Gets query's page size.

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.

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.

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

Gets the routing key for the query.

Routing key can be provided using the SetRoutingValues(Object) method.

Gets the serial consistency level for this query.

Gets the timestamp associated with this statement execution.

Adds a new statement to this batch. Note that statement can be any Statement. It is allowed to mix SimpleStatement and BoundStatement in the same BatchStatement in particular. Please note that the options of the added Statement (all those defined directly by the Statement class: consistency level, fetch size, tracing, ...) will be ignored for the purpose of the execution of the Batch. Instead, the options used are the one of this BatchStatement object.

Disable tracing for the statement.

Enables tracing for the statement

Determines whether the specified object is equal to the current object.

Allows this statement to be executed as a different user/role than the one currently authenticated (a.k.a. proxy execution).

Serves as the default hash function.

Gets the Type of the current instance.

Sets the paging behavior. When set to true (default), the RowSet returned when executing this IStatement will automatically fetch the following result pages. When false, the RowSet returned will only contain the rows contained in the result page and will not fetch additional pages.

Sets the BatchType

Sets the consistency level for the query.

The default consistency level, if this method is not called, is ConsistencyLevel.ONE.

Sets the Host that should handle this query.

In the general case, use of this method is heavily discouraged and should only be used in the following cases:

• Querying node-local tables, such as tables in the system and system_views keyspaces.
• Applying a series of schema changes, where it may be advantageous to execute schema changes in sequence on the same node.

Configuring a specific host causes the configured ILoadBalancingPolicy to be completely bypassed. However, if the load balancing policy dictates that the host is at distance Ignored or there is no active connectivity to the host, the request will fail with a NoHostAvailableException.

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.

Sets the keyspace this batch operates on. The keyspace should only be set when the statements in this batch apply to a different keyspace to the logged keyspace of the ISession.

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.

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.MaxValue

Return Value

Type: 
this Query object.

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.

Overrides the default per-host read timeout ReadTimeoutMillis for this statement.

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.

Set the routing key for this query.

This method allows to manually provide a routing key for this query. It is thus optional since the routing key is only an hint for token aware load balancing policy but is never mandatory.

If the partition key for the query is composite, use the #setRoutingKey(ByteBuffer...) method instead to build the routing key.

Sets the partition key values in order to route the query to the correct replicas.

For simple partition keys, set the partition key value.

For composite partition keys, set the multiple the partition key values in correct order.

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).

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.

Returns a string that represents the current object.