CassandraBatchOperations (Spring Data for Apache Cassandra Core 3.2.2 API)

```
public interface CassandraBatchOperations
```
Batch operations for insert/update/delete actions on a table. CassandraBatchOperations use logged Cassandra BATCHes for single entities and collections of entities. A CassandraBatchOperations instance cannot be modified/used once it was executed.
Batches are atomic by default. In the context of a Cassandra batch operation, atomic means that if any of the batch succeeds, all of it will. Statement order does not matter within a batch. CassandraBatchOperations applies all rows using the same timestamp if supplied, otherwise Cassandra will generate a timestamp.
Multi partition batches should only be used to achieve atomicity for a few writes on different tables. Apart from this they should be avoided because they’re too expensive. Single partition batches can be used to get atomicity and isolation, they're not much more expensive than normal writes.

Since:

1.5

Author:

Mark Paluch, Anup Sabbi

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CassandraBatchOperations`	`delete(Iterable<?> entities)` Add a collection of deletes to the batch.
`CassandraBatchOperations`	`delete(Iterable<?> entities, WriteOptions options)` Add a collection of deletes with given `WriteOptions` to the batch.
`CassandraBatchOperations`	`delete(Object... entities)` Add an array of deletes to the batch.
`default CassandraBatchOperations`	`delete(Object entity, WriteOptions options)` Add delete to the batch.
`WriteResult`	`execute()` Execute the batch.
`CassandraBatchOperations`	`insert(Iterable<?> entities)` Add a collection of inserts to the batch.
`CassandraBatchOperations`	`insert(Iterable<?> entities, WriteOptions options)` Add a collection of inserts with given `WriteOptions` to the batch.
`CassandraBatchOperations`	`insert(Object... entities)` Add an array of inserts to the batch.
`default CassandraBatchOperations`	`insert(Object entity, WriteOptions options)` Add an insert to the batch.
`CassandraBatchOperations`	`update(Iterable<?> entities)` Add a collection of updates to the batch.
`CassandraBatchOperations`	`update(Iterable<?> entities, WriteOptions options)` Add a collection of updates with given `WriteOptions` to the batch.
`CassandraBatchOperations`	`update(Object... entities)` Add an array of updates to the batch.
`default CassandraBatchOperations`	`update(Object entity, WriteOptions options)` Add an update to the batch.
`CassandraBatchOperations`	`withTimestamp(long timestamp)` Apply a given `timestamp` to the whole batch.

- Method Detail
  - execute
```
WriteResult execute()
```
    Execute the batch. The batch can be executed only once.
    
    Returns:
    
    the WriteResult for the bulk operation.
    
    Throws:
    
    IllegalStateException - if the batch is executed after it was executed already.
  - withTimestamp
```
CassandraBatchOperations withTimestamp(long timestamp)
```
    Apply a given timestamp to the whole batch.
    
    Parameters:
    
    timestamp - the timestamp to apply.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
  - insert
```
default CassandraBatchOperations insert(Object entity,
                                        WriteOptions options)
```
    Add an insert to the batch.
    
    Parameters:
    
    entity - the entity to insert; must not be null.
    
    options - the WriteOptions to apply; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
    
    Since:
    
    3.2.2
  - insert
```
CassandraBatchOperations insert(Object... entities)
```
    Add an array of inserts to the batch.
    
    Parameters:
    
    entities - the entities to insert; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
  - insert
```
CassandraBatchOperations insert(Iterable<?> entities)
```
    Add a collection of inserts to the batch.
    
    Parameters:
    
    entities - the entities to insert; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
  - insert
```
CassandraBatchOperations insert(Iterable<?> entities,
                                WriteOptions options)
```
    Add a collection of inserts with given WriteOptions to the batch.
    
    Parameters:
    
    entities - the entities to insert; must not be null.
    
    options - the WriteOptions to apply; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
    
    Since:
    
    2.0
    
    See Also:
    
    InsertOptions
  - update
```
default CassandraBatchOperations update(Object entity,
                                        WriteOptions options)
```
    Add an update to the batch.
    
    Parameters:
    
    entity - the entity to update; must not be null.
    
    options - the WriteOptions to apply; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
    
    Since:
    
    3.2.2
  - update
```
CassandraBatchOperations update(Object... entities)
```
    Add an array of updates to the batch.
    
    Parameters:
    
    entities - the entities to update; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
  - update
```
CassandraBatchOperations update(Iterable<?> entities)
```
    Add a collection of updates to the batch.
    
    Parameters:
    
    entities - the entities to update; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
  - update
```
CassandraBatchOperations update(Iterable<?> entities,
                                WriteOptions options)
```
    Add a collection of updates with given WriteOptions to the batch.
    
    Parameters:
    
    entities - the entities to update; must not be null.
    
    options - the WriteOptions to apply; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
    
    Since:
    
    2.0
    
    See Also:
    
    UpdateOptions
  - delete
```
default CassandraBatchOperations delete(Object entity,
                                        WriteOptions options)
```
    Add delete to the batch.
    
    Parameters:
    
    entity - the entity to delete; must not be null.
    
    options - the WriteOptions to apply; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
    
    Since:
    
    3.2.2
  - delete
```
CassandraBatchOperations delete(Object... entities)
```
    Add an array of deletes to the batch.
    
    Parameters:
    
    entities - the entities to delete; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
  - delete
```
CassandraBatchOperations delete(Iterable<?> entities)
```
    Add a collection of deletes to the batch.
    
    Parameters:
    
    entities - the entities to delete; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
  - delete
```
CassandraBatchOperations delete(Iterable<?> entities,
                                WriteOptions options)
```
    Add a collection of deletes with given WriteOptions to the batch.
    
    Parameters:
    
    entities - the entities to delete; must not be null.
    
    options - the WriteOptions to apply; must not be null.
    
    Returns:
    
    this CassandraBatchOperations.
    
    Throws:
    
    IllegalStateException - if the batch was already executed.
    
    Since:
    
    2.2
    
    See Also:
    
    DeleteOptions

Interface CassandraBatchOperations

Method Summary

Method Detail

execute

withTimestamp

insert

insert

insert

insert

update

update

update

update

delete

delete

delete

delete