org.apache.kudu.client

Enum SessionConfiguration.FlushMode

java.lang.Object

java.lang.Enum<SessionConfiguration.FlushMode>

org.apache.kudu.client.SessionConfiguration.FlushMode

All Implemented Interfaces:

Serializable, Comparable<SessionConfiguration.FlushMode>

Enclosing interface:

SessionConfiguration

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public static enum SessionConfiguration.FlushMode
extends Enum<SessionConfiguration.FlushMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_FLUSH_BACKGROUND KuduSession.apply() calls will return immediately, but the writes will be sent in the background, potentially batched together with other writes from the same session.
AUTO_FLUSH_SYNC Each KuduSession.apply() call will return only after being flushed to the server automatically.
MANUAL_FLUSH KuduSession.apply() calls will return immediately, but the writes will not be sent until the user calls KuduSession.flush().

Method Summary

Modifier and Type	Method and Description
static SessionConfiguration.FlushMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SessionConfiguration.FlushMode[]	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

AUTO_FLUSH_SYNC

public static final SessionConfiguration.FlushMode AUTO_FLUSH_SYNC

Each KuduSession.apply() call will return only after being flushed to the server automatically. No batching will occur.

In this mode, the KuduSession.flush() call never has any effect, since each KuduSession.apply() has already flushed the buffer before returning.

This is the default flush mode.

AUTO_FLUSH_BACKGROUND

public static final SessionConfiguration.FlushMode AUTO_FLUSH_BACKGROUND

KuduSession.apply() calls will return immediately, but the writes will be sent in the background, potentially batched together with other writes from the same session. If there is not sufficient buffer space, then KuduSession.apply() may block for buffer space to be available.

Because writes are applied in the background, any errors will be stored in a session-local buffer. Call countPendingErrors() or getPendingErrors() to retrieve them.

Note: The AUTO_FLUSH_BACKGROUND mode may result in out-of-order writes to Kudu. This is because in this mode multiple write operations may be sent to the server in parallel. See KUDU-1767 for more information.

The KuduSession.flush() call can be used to block until the buffer is empty.

MANUAL_FLUSH

public static final SessionConfiguration.FlushMode MANUAL_FLUSH

KuduSession.apply() calls will return immediately, but the writes will not be sent until the user calls KuduSession.flush(). If the buffer runs past the configured space limit, then KuduSession.apply() will return an error.

Method Detail

values

public static SessionConfiguration.FlushMode[] 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 (SessionConfiguration.FlushMode c : SessionConfiguration.FlushMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static SessionConfiguration.FlushMode 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