com.datastax.oss.driver.api.core.cql

Interface BatchStatement

All Superinterfaces:

Iterable<BatchableStatement<?>>, Request, Statement<BatchStatement>

public interface BatchStatement
extends Statement<BatchStatement>, Iterable<BatchableStatement<?>>

A statement that groups a number of other statements, so that they can be executed as a batch (i.e. sent together as a single protocol frame).

The default implementation returned by the driver is immutable and thread-safe. All mutating methods return a new instance. See also the static factory methods and builders in this interface.

Field Summary

Fields inherited from interface com.datastax.oss.driver.api.core.cql.Statement

ASYNC, NO_DEFAULT_TIMESTAMP, NO_NOW_IN_SECONDS, SYNC

Method Summary

Modifier and Type	Method and Description
BatchStatement	add(BatchableStatement<?> statement) Adds a new statement to the batch.
default BatchStatement	addAll(BatchableStatement<?>... statements)
BatchStatement	addAll(Iterable<? extends BatchableStatement<?>> statements) Adds new statements to the batch.
static BatchStatementBuilder	builder(BatchStatement template) Returns a builder to create an instance of the default implementation, copying the fields of the given statement.
static BatchStatementBuilder	builder(BatchType batchType) Returns a builder to create an instance of the default implementation.
BatchStatement	clear() Clears the batch, removing all the statements added so far.
default int	computeSizeInBytes(DriverContext context) Calculates the approximate size in bytes that the statement will have when encoded.
BatchType	getBatchType()
static BatchStatement	newInstance(BatchType batchType) Creates an instance of the default implementation for the given batch type.
static BatchStatement	newInstance(BatchType batchType, BatchableStatement<?>... statements) Creates an instance of the default implementation for the given batch type, containing the given statements.
static BatchStatement	newInstance(BatchType batchType, Iterable<BatchableStatement<?>> statements) Creates an instance of the default implementation for the given batch type, containing the given statements.
BatchStatement	setBatchType(BatchType newBatchType) Sets the batch type.
BatchStatement	setKeyspace(CqlIdentifier newKeyspace) Sets the CQL keyspace to associate with this batch.
default BatchStatement	setKeyspace(String newKeyspaceName) Shortcut for setKeyspace(CqlIdentifier.fromCql(newKeyspaceName)).
int	size()

Methods inherited from interface com.datastax.oss.driver.api.core.cql.Statement

copy, disableTracing, enableTracing, getConsistencyLevel, getDefaultTimestamp, getFetchSize, getNowInSeconds, getPageSize, getPagingState, getQueryTimestamp, getSerialConsistencyLevel, isTracing, setConsistencyLevel, setCustomPayload, setDefaultTimestamp, setExecutionProfile, setExecutionProfileName, setFetchSize, setIdempotent, setNode, setNowInSeconds, setPageSize, setPagingState, setPagingState, setPagingState, setQueryTimestamp, setRoutingKey, setRoutingKey, setRoutingKeyspace, setRoutingKeyspace, setRoutingToken, setSerialConsistencyLevel, setTimeout, setTracing

Methods inherited from interface com.datastax.oss.driver.api.core.session.Request

getCustomPayload, getExecutionProfile, getExecutionProfileName, getKeyspace, getNode, getPartitioner, getRoutingKey, getRoutingKeyspace, getRoutingToken, getTimeout, isIdempotent

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

newInstance

@NonNull
static BatchStatement newInstance(@NonNull
                                           BatchType batchType)

Creates an instance of the default implementation for the given batch type.

Note that the returned object is immutable.

newInstance

@NonNull
static BatchStatement newInstance(@NonNull
                                           BatchType batchType,
                                           @NonNull
                                           Iterable<BatchableStatement<?>> statements)

Creates an instance of the default implementation for the given batch type, containing the given statements.

Note that the returned object is immutable.

newInstance

@NonNull
static BatchStatement newInstance(@NonNull
                                           BatchType batchType,
                                           @NonNull
                                           BatchableStatement<?>... statements)

Creates an instance of the default implementation for the given batch type, containing the given statements.

Note that the returned object is immutable.

builder

@NonNull
static BatchStatementBuilder builder(@NonNull
                                              BatchType batchType)

Returns a builder to create an instance of the default implementation.

Note that this builder is mutable and not thread-safe.

builder

@NonNull
static BatchStatementBuilder builder(@NonNull
                                              BatchStatement template)

Returns a builder to create an instance of the default implementation, copying the fields of the given statement.

Note that this builder is mutable and not thread-safe.

getBatchType

@NonNull
BatchType getBatchType()

setBatchType

@NonNull
BatchStatement setBatchType(@NonNull
                                     BatchType newBatchType)

Sets the batch type.

The driver's built-in implementation is immutable, and returns a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

setKeyspace

@NonNull
BatchStatement setKeyspace(@Nullable
                                    CqlIdentifier newKeyspace)

Sets the CQL keyspace to associate with this batch.

If the keyspace is not set explicitly with this method, it will be inferred from the first simple statement in the batch that has a keyspace set (or will be null if no such statement exists).

This feature is only available with native protocol v5 or higher. Specifying a per-request keyspace with lower protocol versions will cause a runtime error.

See Also:

Request.getKeyspace()

setKeyspace

@NonNull
default BatchStatement setKeyspace(@NonNull
                                            String newKeyspaceName)

Shortcut for setKeyspace(CqlIdentifier.fromCql(newKeyspaceName)).

add

@NonNull
BatchStatement add(@NonNull
                            BatchableStatement<?> statement)

Adds a new statement to the batch.

Note that, due to protocol limitations, simple statements with named values are currently not supported.

The driver's built-in implementation is immutable, and returns a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

addAll

@NonNull
BatchStatement addAll(@NonNull
                               Iterable<? extends BatchableStatement<?>> statements)

Adds new statements to the batch.

Note that, due to protocol limitations, simple statements with named values are currently not supported.

The driver's built-in implementation is immutable, and returns a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

addAll

@NonNull
default BatchStatement addAll(@NonNull
                                       BatchableStatement<?>... statements)

See Also:

addAll(Iterable)

size

int size()

Returns:

The number of child statements in this batch.

clear

@NonNull
BatchStatement clear()

Clears the batch, removing all the statements added so far.

The driver's built-in implementation is immutable, and returns a new instance from this method. However custom implementations may choose to be mutable and return the same instance.

computeSizeInBytes

default int computeSizeInBytes(@NonNull
                               DriverContext context)

Description copied from interface: Statement

Calculates the approximate size in bytes that the statement will have when encoded.

The size might be over-estimated by a few bytes due to global options that may be defined on a Session but not explicitly set on the statement itself.

The result of this method is not cached, calling it will cause some encoding to be done in order to determine some of the statement's attributes sizes. Therefore, use this method sparingly in order to avoid unnecessary computation.

Specified by:

computeSizeInBytes in interface Statement<BatchStatement>

Returns:

the approximate number of bytes this statement will take when encoded.