com.datastax.driver.core.querybuilder

Class Batch

java.lang.Object

com.datastax.driver.core.Statement

com.datastax.driver.core.RegularStatement

com.datastax.driver.core.querybuilder.Batch

public class Batch
extends RegularStatement

A built BATCH statement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Batch.Options The options of a BATCH statement.

Method Summary

Methods

Modifier and Type	Method and Description
Batch	add(RegularStatement statement) Adds a new statement to this batch.
String	getKeyspace() Returns the keyspace of the first statement in this batch.
String	getQueryString() Returns the query string for this statement.
ByteBuffer	getRoutingKey() Returns the first non-null routing key of the statements in this batch or null otherwise.
ByteBuffer[]	getValues() The values to use for this statement.
RegularStatement	setForceNoValues(boolean forceNoValues) Allows to force this builder to not generate values (through its getValues() method).
String	toString()
Batch.Options	using(Using using) Adds a new options for this BATCH statement.

Methods inherited from class com.datastax.driver.core.Statement

disableTracing, enableTracing, getConsistencyLevel, getFetchSize, getRetryPolicy, getSerialConsistencyLevel, isTracing, setConsistencyLevel, setFetchSize, setRetryPolicy, setSerialConsistencyLevel

Methods inherited from class java.lang.Object

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

Method Detail

add

public Batch add(RegularStatement statement)

Adds a new statement to this batch.

Parameters:

statement - the new statement to add.

Returns:

this batch.

Throws:

IllegalArgumentException - if counter and non-counter operations are mixed.

using

public Batch.Options using(Using using)

Adds a new options for this BATCH statement.

Parameters:

using - the option to add.

Returns:

the options of this BATCH statement.

getRoutingKey

public ByteBuffer getRoutingKey()

Returns the first non-null routing key of the statements in this batch or null otherwise.

Returns:

the routing key for this batch statement.

getKeyspace

public String getKeyspace()

Returns the keyspace of the first statement in this batch.

Returns:

the keyspace of the first statement in this batch.

getQueryString

public String getQueryString()

Description copied from class: RegularStatement

Returns the query string for this statement.

Specified by:

getQueryString in class RegularStatement

Returns:

a valid CQL query string.

getValues

public ByteBuffer[] getValues()

Description copied from class: RegularStatement

The values to use for this statement.

Specified by:

getValues in class RegularStatement

Returns:

the values to use for this statement or null if there is no such values.

See Also:

SimpleStatement.SimpleStatement(String, Object...)

toString

public String toString()

Overrides:

toString in class RegularStatement

setForceNoValues

public RegularStatement setForceNoValues(boolean forceNoValues)

Allows to force this builder to not generate values (through its getValues() method).

By default and for performance reasons, the query builder will not serialize all values provided to strings. This means that the getQueryString() may return a query string with bind markers (where and when is at the discretion of the builder) and getValues() will return the binary values for those markers. This method allows to force the builder to not generate binary values but rather to serialize them all in the query string. In practice, this means that if you call setForceNoValues(true), you are guarateed that getValues() will return null and that the string returned by getQueryString() will contain no other bind markers than the one inputed by the user.

Note that this method is mainly useful for debugging purpose. In general, the default behavior should be the correct and most efficient one.

Parameters:

forceNoValues - whether or not this builder may generate values.

Returns:

this statement.