Was this page helpful?
A group of statements that are executed as a single batch.
Note: Batches are not supported by the binary protocol version 1.
Requires Apache Cassandra: 2.0+
Public Functions
Creates a new batch statement with batch type.
Requires Apache Cassandra: 2.0+
See also
type – [in]
Returns a batch statement that must be freed.
Frees a batch instance. Batches can be immediately freed after being executed.
Requires Apache Cassandra: 2.0+
batch – [in]
Sets the batch’s keyspace. When using protocol v5 or greater it overrides the session’s keyspace for the batch.
Note: If not set explicitly then the batch will inherit the keyspace of the first child statement with a non-empty keyspace.
batch – [in]
keyspace – [in]
CASS_OK if successful, otherwise an error occurred.
Same as cass_batch_set_keyspace(), but with lengths for string parameters.
See also
batch – [in]
keyspace – [in]
keyspace_length – [in]
same as cass_batch_set_keyspace()
Sets the batch’s consistency level
Requires Apache Cassandra: 2.0+
batch – [in]
consistency – [in] The batch’s write consistency.
CASS_OK if successful, otherwise an error occurred.
Sets the batch’s serial consistency level.
Requires Apache Cassandra: 2.0+
Default: Not set
batch – [in]
serial_consistency – [in]
CASS_OK if successful, otherwise an error occurred.
Sets the batch’s timestamp.
Requires Apache Cassandra: 2.1+
batch – [in]
timestamp – [in]
CASS_OK if successful, otherwise an error occurred.
Sets the batch’s timeout for waiting for a response from a node.
Default: Disabled (use the cluster-level request timeout)
See also
batch – [in]
timeout_ms – [in] Request timeout in milliseconds. Use 0 for no timeout or CASS_UINT64_MAX to disable (to use the cluster-level request timeout).
CASS_OK if successful, otherwise an error occurred.
Sets whether the statements in a batch are idempotent. Idempotent batches are able to be automatically retried after timeouts/errors and can be speculatively executed.
batch – [in]
is_idempotent – [in]
CASS_OK if successful, otherwise an error occurred.
Sets the batch’s retry policy.
Requires Apache Cassandra: 2.0+
batch – [in]
retry_policy – [in]
CASS_OK if successful, otherwise an error occurred.
Sets the batch’s custom payload.
Requires Apache Cassandra: 2.2+
batch – [in]
payload – [in]
CASS_OK if successful, otherwise an error occurred.
Adds a statement to a batch.
Requires Apache Cassandra: 2.0+
batch – [in]
statement – [in]
CASS_OK if successful, otherwise an error occurred.
Sets the execution profile to execute the batch with.
Note: NULL or empty string will clear execution profile from batch
See also
batch – [in]
name – [in]
CASS_OK if successful, otherwise an error occurred.
Same as cass_batch_set_execution_profile(), but with lengths for string parameters.
See also
batch – [in]
name – [in]
name_length – [in]
CASS_OK if successful, otherwise an error occurred.
Sets the name of the user to execute the batch as.
batch – [in]
name – [in]
CASS_OK if successful, otherwise an error occurred.
Same as cass_batch_set_execute_as(), but with lengths for string parameters.
See also
batch – [in]
name – [in]
name_length – [in]
same as cass_batch_set_execute_as()
Was this page helpful?
On this page
CassBatchCassBatch::cass_batch_new()CassBatch::cass_batch_free()CassBatch::cass_batch_set_keyspace()CassBatch::cass_batch_set_keyspace_n()CassBatch::cass_batch_set_consistency()CassBatch::cass_batch_set_serial_consistency()CassBatch::cass_batch_set_timestamp()CassBatch::cass_batch_set_request_timeout()CassBatch::cass_batch_set_is_idempotent()CassBatch::cass_batch_set_retry_policy()CassBatch::cass_batch_set_custom_payload()CassBatch::cass_batch_add_statement()CassBatch::cass_batch_set_execution_profile()CassBatch::cass_batch_set_execution_profile_n()CassBatch::cass_batch_set_execute_as()CassBatch::cass_batch_set_execute_as_n()