final class BatchStatement implements Statement (View source)

Batch statements are used to execute a series of simple or prepared statements.

There are 3 types of batch statements:

  • Cassandra::BATCH_LOGGED - this is the default batch type. This batch guarantees that either all or none of its statements will be executed. This behavior is achieved by writing a batch log on the coordinator, which slows down the execution somewhat.
  • Cassandra::BATCH_UNLOGGED - this batch will not be verified when executed, which makes it faster than a LOGGED batch, but means that some of its statements might fail, while others - succeed.
  • Cassandra::BATCH_COUNTER - this batch is used for counter updates, which are, unlike other writes, not idempotent.

Methods

__construct(int $type)

Creates a new batch statement.

add(string|Statement $statement, array|null $arguments)

Adds a statement to this batch.

Details

__construct(int $type)

Creates a new batch statement.

Parameters

int $type

must be one of Cassandra::BATCH_* (default: Cassandra::BATCH_LOGGED).

BatchStatement add(string|Statement $statement, array|null $arguments)

Adds a statement to this batch.

Parameters

string|Statement $statement

string or statement to add

array|null $arguments

positional or named arguments (optional)

Return Value

BatchStatement self

Exceptions

InvalidArgumentException