Click or drag to resize
Batch Class
Inheritance Hierarchy
SystemObject
  CassandraStatement
    Cassandra.Data.LinqBatch

Namespace: Cassandra.Data.Linq
Assembly: Cassandra (in Cassandra.dll) Version: 3.2.0
Syntax
C#
public abstract class Batch : Statement

The Batch type exposes the following members.

Methods
  NameDescription
Public methodAppend(CqlCommand)
Public methodAppend(IEnumerableCqlCommand)
Public methodBeginExecute
Public methodDisableTracing
Disable tracing for the statement.
(Inherited from Statement.)
Public methodEnableTracing
Enables tracing for the statement
(Inherited from Statement.)
Public methodEndExecute
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecute
Public methodExecuteAsync
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetAutoPage
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.
(Inherited from Statement.)
Public methodSetConsistencyLevel
Public methodSetIdempotence
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.

(Inherited from Statement.)
Public methodSetOutgoingPayload
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.
(Inherited from Statement.)
Public methodSetPageSize
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.
(Inherited from Statement.)
Public methodSetPagingState
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.
(Inherited from Statement.)
Public methodSetReadTimeoutMillis
Overrides the default per-host read timeout ReadTimeoutMillis for this statement.
(Inherited from Statement.)
Public methodSetRetryPolicy
Sets the retry policy to use for this query.

The default retry policy, if this method is not called, is the one returned by Policies#RetryPolicy in the cluster configuration. This method is thus only useful in case you want to punctually override the default policy for this request.

(Inherited from Statement.)
Public methodSetSerialConsistencyLevel
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).
(Inherited from Statement.)
Public methodSetTimestamp
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyAutoPage
Determines if the RowSet returned when executing this IStatement will automatically fetch the following result pages. Defaults to true.
(Inherited from Statement.)
Public propertyConsistencyLevel
Gets the consistency level for this query.
(Inherited from Statement.)
Public propertyIsEmpty
Public propertyIsIdempotent
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.
(Inherited from Statement.)
Public propertyIsTracing
Gets whether tracing is enabled for this query or not.
(Inherited from Statement.)
Public propertyOutgoingPayload
Gets custom payload for that will be included when executing this Statement.
(Inherited from Statement.)
Public propertyPageSize
Gets query's page size.
(Inherited from Statement.)
Public propertyPagingState (Inherited from Statement.)
Public propertyQueryTrace
Public propertyQueryValues (Inherited from Statement.)
Public propertyReadTimeoutMillis
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.

(Inherited from Statement.)
Public propertyRetryPolicy
Gets the retry policy sets for this query, if any.
(Inherited from Statement.)
Public propertyRoutingKey (Overrides StatementRoutingKey.)
Public propertySerialConsistencyLevel
Gets the serial consistency level for this query.
(Inherited from Statement.)
Public propertySkipMetadata (Inherited from Statement.)
Public propertyTimestamp
Gets the timestamp associated with this statement execution.
(Inherited from Statement.)
Top
See Also