com.datastax.oss.dsbulk.batcher.api

Enum BatchMode

java.lang.Object

java.lang.Enum<BatchMode>

com.datastax.oss.dsbulk.batcher.api.BatchMode

All Implemented Interfaces:

Serializable, Comparable<BatchMode>

public enum BatchMode
extends Enum<BatchMode>

Available batch modes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PARTITION_KEY Groups together statements that share the same partition key.
REPLICA_SET Groups together statements that share the same replica set.

Method Summary

Modifier and Type	Method and Description
static BatchMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BatchMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PARTITION_KEY

public static final BatchMode PARTITION_KEY

Groups together statements that share the same partition key. This is the default mode, and the preferred one.

Under the hood, this mode uses either the statement's routing key or routing token, whichever is available, starting with the routing token.

REPLICA_SET

public static final BatchMode REPLICA_SET

Groups together statements that share the same replica set. This mode might yield better results for small clusters and lower replication factors, but tends to perform equally well or even worse than PARTITION_KEY for larger clusters or high replication factors (i.e. RF > 3).

Note that this mode can only work if the statements to batch have their routing keyspace set. If this condition is not met, the batcher will silently fall back to PARTITION_KEY mode.

Method Detail

values

public static BatchMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BatchMode c : BatchMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BatchMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null