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

Class BatchStatementBuilder

java.lang.Object

com.datastax.oss.driver.api.core.cql.StatementBuilder<BatchStatementBuilder,BatchStatement>

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

@NotThreadSafe
public class BatchStatementBuilder
extends StatementBuilder<BatchStatementBuilder,BatchStatement>

A builder to create a batch statement.

This class is mutable and not thread-safe.

Field Summary

Fields inherited from class com.datastax.oss.driver.api.core.cql.StatementBuilder

consistencyLevel, executionProfile, executionProfileName, idempotent, node, nowInSeconds, pageSize, pagingState, routingKey, routingKeyspace, routingToken, serialConsistencyLevel, timeout, timestamp, tracing

Constructor Summary

Constructors

Constructor and Description
BatchStatementBuilder(BatchStatement template)
BatchStatementBuilder(BatchType batchType)

Method Summary

Modifier and Type	Method and Description
BatchStatementBuilder	addStatement(BatchableStatement<?> statement) Adds a new statement to the batch.
BatchStatementBuilder	addStatements(BatchableStatement<?>... statements) Adds new statements to the batch.
BatchStatementBuilder	addStatements(Iterable<BatchableStatement<?>> statements) Adds new statements to the batch.
BatchStatement	build()
BatchStatementBuilder	clearStatements() Clears all the statements in this batch.
int	getStatementsCount()
BatchStatementBuilder	setKeyspace(CqlIdentifier keyspace) Sets the CQL keyspace to execute this batch in.
BatchStatementBuilder	setKeyspace(String keyspaceName) Sets the CQL keyspace to execute this batch in.

Methods inherited from class com.datastax.oss.driver.api.core.cql.StatementBuilder

addCustomPayload, buildCustomPayload, clearCustomPayload, disableTracing, enableTracing, setConsistencyLevel, setDefaultTimestamp, setExecutionProfile, setExecutionProfileName, setFetchSize, setIdempotence, setNode, setNowInSeconds, setPageSize, setPagingState, setQueryTimestamp, setRoutingKey, setRoutingKey, setRoutingKeyspace, setRoutingKeyspace, setRoutingToken, setSerialConsistencyLevel, setTimeout, setTracing, setTracing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchStatementBuilder

public BatchStatementBuilder(@NonNull
                             BatchType batchType)

BatchStatementBuilder

public BatchStatementBuilder(@NonNull
                             BatchStatement template)

Method Detail

setKeyspace

@NonNull
public BatchStatementBuilder setKeyspace(@NonNull
                                                  CqlIdentifier keyspace)

Sets the CQL keyspace to execute this batch in.

Returns:

this builder; never null.

See Also:

Request.getKeyspace()

setKeyspace

@NonNull
public BatchStatementBuilder setKeyspace(@NonNull
                                                  String keyspaceName)

Sets the CQL keyspace to execute this batch in. Shortcut for setKeyspace(CqlIdentifier.fromCql(keyspaceName)).

Returns:

this builder; never null.

addStatement

@NonNull
public BatchStatementBuilder addStatement(@NonNull
                                                   BatchableStatement<?> statement)

Adds a new statement to the batch.

Returns:

this builder; never null.

See Also:

BatchStatement.add(BatchableStatement)

addStatements

@NonNull
public BatchStatementBuilder addStatements(@NonNull
                                                    Iterable<BatchableStatement<?>> statements)

Adds new statements to the batch.

Returns:

this builder; never null.

See Also:

BatchStatement.addAll(Iterable)

addStatements

@NonNull
public BatchStatementBuilder addStatements(@NonNull
                                                    BatchableStatement<?>... statements)

Adds new statements to the batch.

Returns:

this builder; never null.

See Also:

BatchStatement.addAll(BatchableStatement[])

clearStatements

@NonNull
public BatchStatementBuilder clearStatements()

Clears all the statements in this batch.

Returns:

this builder; never null.

build

@NonNull
public BatchStatement build()

Specified by:

build in class StatementBuilder<BatchStatementBuilder,BatchStatement>

Returns:

a newly-allocated batch; never null..

getStatementsCount

public int getStatementsCount()