A group of statements that are executed as a single batch.

Note: Batches are not supported by the binary protocol version 1.

Requires Cassandra: 2.0+

Functions

CassBatch *

cass_batch_new

( type )

Creates a new batch statement with batch type.

Requires Cassandra: 2.0+

Parameters:
Name Type Details
in type
Returns:
Type Details
CassBatch *

Returns a batch statement that must be freed.

See Also:
void

cass_batch_free

( batch )

Frees a batch instance. Batches can be immediately freed after being executed.

Requires Cassandra: 2.0+

Parameters:
Name Type Details
in batch
CassError

cass_batch_set_keyspace

( batch, keyspace )

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.

Parameters:
Name Type Details
in batch
in keyspace
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.

CassError

cass_batch_set_keyspace_n

( batch, keyspace, keyspace_length )

Same as CassBatch::cass_batch_set_keyspace, but with lengths for string parameters.

Parameters:
Name Type Details
in batch
in keyspace
in keyspace_length
Returns:
Type Details
CassError

same as CassBatch::cass_batch_set_keyspace

See Also:
CassError

cass_batch_set_consistency

( batch, consistency )

Sets the batch’s consistency level

Requires Cassandra: 2.0+

Parameters:
Name Type Details
in batch
in consistency

The batch’s write consistency.

Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.

CassError

cass_batch_set_serial_consistency

( batch, serial_consistency )

Sets the batch’s serial consistency level.

Requires Cassandra: 2.0+

Default: Not set

Parameters:
Name Type Details
in batch
in serial_consistency
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.

CassError

cass_batch_set_timestamp

( batch, timestamp )

Sets the batch’s timestamp.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in batch
in timestamp
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.

CassError

cass_batch_set_request_timeout

( batch, timeout_ms )

Sets the batch’s timeout for waiting for a response from a node.

Default: Disabled (use the cluster-level request timeout)

Parameters:
Name Type Details
in batch
in timeout_ms

Request timeout in milliseconds. Use 0 for no timeout or CASS_UINT64_MAX to disable (to use the cluster-level request timeout).

Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.

See Also:
CassError

cass_batch_set_is_idempotent

( batch, is_idempotent )

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.

Parameters:
Name Type Details
in batch
in is_idempotent
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.

See Also:
CassError

cass_batch_set_retry_policy

( batch, retry_policy )

Sets the batch’s retry policy.

Requires Cassandra: 2.0+

Parameters:
Name Type Details
in batch
in retry_policy
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.

CassError

cass_batch_set_custom_payload

( batch, payload )

Sets the batch’s custom payload.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in batch
in payload
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.

CassError

cass_batch_add_statement

( batch, statement )

Adds a statement to a batch.

Requires Cassandra: 2.0+

Parameters:
Name Type Details
in batch
in statement
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.