org.apache.kudu.client

Interface SessionConfiguration

All Known Implementing Classes:

AsyncKuduSession, KuduSession

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public interface SessionConfiguration

Interface that defines the methods used to configure a session. It also exposes ways to query its state.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SessionConfiguration.FlushMode

Method Summary

Modifier and Type	Method and Description
int	countPendingErrors() Return the number of errors which are pending.
SessionConfiguration.FlushMode	getFlushMode() Get the current flush mode.
RowErrorsAndOverflowStatus	getPendingErrors() Return any errors from previous calls.
long	getTimeoutMillis() Get the current timeout.
boolean	hasPendingOperations() Check if there are operations that haven't been completely applied.
boolean	isClosed() Returns true if this session has already been closed.
boolean	isIgnoreAllDuplicateRows() Tells if the session is currently ignoring row errors when the whole list returned by a tablet server is of the AlreadyPresent type.
void	setExternalConsistencyMode(ExternalConsistencyMode consistencyMode) Set the new external consistency mode for this session.
void	setFlushInterval(int interval) Set the flush interval, which will be used for the next scheduling decision.
void	setFlushMode(SessionConfiguration.FlushMode flushMode) Set the new flush mode for this session.
void	setIgnoreAllDuplicateRows(boolean ignoreAllDuplicateRows) Configures the option to ignore all the row errors if they are all of the AlreadyPresent type.
void	setMutationBufferLowWatermark(float mutationBufferLowWatermarkPercentage) Set the low watermark for this session.
void	setMutationBufferSpace(int size) Set the number of operations that can be buffered.
void	setTimeoutMillis(long timeout) Sets the timeout for the next applied operations.

Method Detail

getFlushMode

SessionConfiguration.FlushMode getFlushMode()

Get the current flush mode.

Returns:

flush mode, AUTO_FLUSH_SYNC by default

setFlushMode

void setFlushMode(SessionConfiguration.FlushMode flushMode)

Set the new flush mode for this session.

Parameters:

flushMode - new flush mode, can be the same as the previous one.

Throws:

IllegalArgumentException - if the buffer isn't empty.

setMutationBufferSpace

void setMutationBufferSpace(int size)

Set the number of operations that can be buffered.

Parameters:

size - number of ops.

Throws:

IllegalArgumentException - if the buffer isn't empty.

setMutationBufferLowWatermark

void setMutationBufferLowWatermark(float mutationBufferLowWatermarkPercentage)

Set the low watermark for this session. The default is set to half the mutation buffer space. For example, a buffer space of 1000 with a low watermark set to 50% (0.5) will start randomly sending PleaseRetryExceptions once there's an outstanding flush and the buffer is over 500. As the buffer gets fuller, it becomes likelier to hit the exception.

Parameters:

mutationBufferLowWatermarkPercentage - a new low watermark as a percentage, has to be between 0 and 1 (inclusive). A value of 1 disables the low watermark since it's the same as the high one

Throws:

IllegalArgumentException - if the buffer isn't empty or if the watermark isn't between 0 and 1

setFlushInterval

void setFlushInterval(int interval)

Set the flush interval, which will be used for the next scheduling decision.

Parameters:

interval - interval in milliseconds.

getTimeoutMillis

long getTimeoutMillis()

Get the current timeout.

Returns:

operation timeout in milliseconds, 0 if none was configured.

setTimeoutMillis

void setTimeoutMillis(long timeout)

Sets the timeout for the next applied operations. The default timeout is 0, which disables the timeout functionality.

Parameters:

timeout - Timeout in milliseconds.

isClosed

boolean isClosed()

Returns true if this session has already been closed.

hasPendingOperations

boolean hasPendingOperations()

Check if there are operations that haven't been completely applied.

Returns:

true if operations are pending, else false.

setExternalConsistencyMode

void setExternalConsistencyMode(ExternalConsistencyMode consistencyMode)

Set the new external consistency mode for this session.

Parameters:

consistencyMode - new external consistency mode, can the same as the previous one.

Throws:

IllegalArgumentException - if the buffer isn't empty.

isIgnoreAllDuplicateRows

boolean isIgnoreAllDuplicateRows()

Tells if the session is currently ignoring row errors when the whole list returned by a tablet server is of the AlreadyPresent type.

Returns:

true if the session is enforcing this, else false

setIgnoreAllDuplicateRows

void setIgnoreAllDuplicateRows(boolean ignoreAllDuplicateRows)

Configures the option to ignore all the row errors if they are all of the AlreadyPresent type. This can be needed when facing KUDU-568. The effect of enabling this is that operation responses that match this pattern will be cleared of their row errors, meaning that we consider them successful.

Disabled by default.

Parameters:

ignoreAllDuplicateRows - true if this session should enforce this, else false

countPendingErrors

int countPendingErrors()

Return the number of errors which are pending. Errors may accumulate when using AUTO_FLUSH_BACKGROUND mode.

Returns:

a count of errors

getPendingErrors

RowErrorsAndOverflowStatus getPendingErrors()

Return any errors from previous calls. If there were more errors than could be held in the session's error storage, the overflow state is set to true.

Clears the pending errors.

Returns:

an object that contains the errors and the overflow status