KuduSession

java.lang.Object
- org.apache.kudu.client.KuduSession

All Implemented Interfaces:

SessionConfiguration
```
@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class KuduSession
extends Object
implements SessionConfiguration
```
Synchronous version of AsyncKuduSession. Offers the same API but with blocking methods.
This class is not thread-safe.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.kudu.client.SessionConfiguration
  SessionConfiguration.FlushMode

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`OperationResponse`	`apply(Operation operation)` Apply a given `Operation` to Kudu as part of this session.
`List<OperationResponse>`	`close()` Blocking call that flushes the buffers (see `flush()`) and closes the sessions.
`int`	`countPendingErrors()` Return the number of errors which are pending.
`List<OperationResponse>`	`flush()` Blocking call that force flushes this session's buffers.
`SessionConfiguration.FlushMode`	`getFlushMode()` Get the current flush mode.
`RowErrorsAndOverflowStatus`	`getPendingErrors()` Return any errors from previous calls.
`long`	`getTimeoutMillis()` Get the current timeout.
`ResourceMetrics`	`getWriteOpMetrics()` Return cumulative write operation metrics since the beginning of the session.
`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.
`boolean`	`isIgnoreAllNotFoundRows()` Tells if the session is currently ignoring row errors when the whole list returned by a tablet server is of the NotFound type.
`void`	`setErrorCollectorSpace(int size)` Set the number of errors that can be collected.
`void`	`setExternalConsistencyMode(ExternalConsistencyMode consistencyMode)` Set the new external consistency mode for this session.
`void`	`setFlushInterval(int intervalMillis)` 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`	`setIgnoreAllNotFoundRows(boolean ignoreAllNotFoundRows)` Configures the option to ignore all the row errors if they are all of the NotFound type.
`void`	`setMutationBufferLowWatermark(float mutationBufferLowWatermarkPercentage)` Deprecated.
`void`	`setMutationBufferSpace(int numOps, long maxSize)` Set the number and the maximum byte size of operations that can be buffered.
`void`	`setTimeoutMillis(long timeout)` Sets the timeout for the next applied operations.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.kudu.client.SessionConfiguration
setMutationBufferSpace

- Method Detail
  - apply
```
public OperationResponse apply(Operation operation)
                        throws KuduException
```
    Apply a given Operation to Kudu as part of this session.
    This is a blocking call that has different behavior based on the configured flush mode:
    - AUTO_FLUSH_SYNC: the call returns when the operation is persisted, else it throws an exception.
    - AUTO_FLUSH_BACKGROUND: the call returns when the operation has been added to the buffer. This call should normally perform only fast in-memory operations but it may have to wait when the buffer is full and there's another buffer being flushed. Row errors can be checked by calling countPendingErrors() and can be retrieved by calling getPendingErrors().
    - MANUAL_FLUSH: the call returns when the operation has been added to the buffer, else it throws a KuduException if the buffer is full.
    Note: PleaseThrottleException is handled by this method and will not be thrown, unlike with AsyncKuduSession.apply().
    Parameters:
    
    operation - operation to apply
    
    Returns:
    
    an OperationResponse for the applied Operation
    
    Throws:
    
    KuduException - if anything went wrong
    
    See Also:
    
    FlushMode
  - flush
```
public List<OperationResponse> flush()
                              throws KuduException
```
    Blocking call that force flushes this session's buffers. Data is persisted when this call returns, else it will throw an exception.
    
    Returns:
    
    a list of OperationResponse, one per operation that was flushed
    
    Throws:
    
    KuduException - if anything went wrong
  - close
```
public List<OperationResponse> close()
                              throws KuduException
```
    Blocking call that flushes the buffers (see flush()) and closes the sessions.
    
    Returns:
    
    List of OperationResponse, one per operation that was flushed
    
    Throws:
    
    KuduException - if anything went wrong
  - getFlushMode
```
public SessionConfiguration.FlushMode getFlushMode()
```
    Description copied from interface: SessionConfiguration
    
    Get the current flush mode.
    
    Specified by:
    
    getFlushMode in interface SessionConfiguration
    
    Returns:
    
    flush mode, AUTO_FLUSH_SYNC by default
  - setFlushMode
```
public void setFlushMode(SessionConfiguration.FlushMode flushMode)
```
    Description copied from interface: SessionConfiguration
    
    Set the new flush mode for this session.
    
    Specified by:
    
    setFlushMode in interface SessionConfiguration
    
    Parameters:
    
    flushMode - new flush mode, can be the same as the previous one.
  - setMutationBufferSpace
```
public void setMutationBufferSpace(int numOps,
                                   long maxSize)
```
    Description copied from interface: SessionConfiguration
    
    Set the number and the maximum byte size of operations that can be buffered.
    
    Specified by:
    
    setMutationBufferSpace in interface SessionConfiguration
    
    Parameters:
    
    numOps - number of ops.
    
    maxSize - max byte size of ops.
  - setErrorCollectorSpace
```
public void setErrorCollectorSpace(int size)
```
    Description copied from interface: SessionConfiguration
    
    Set the number of errors that can be collected.
    
    Specified by:
    
    setErrorCollectorSpace in interface SessionConfiguration
    
    Parameters:
    
    size - number of errors.
  - setMutationBufferLowWatermark
```
@Deprecated
public void setMutationBufferLowWatermark(float mutationBufferLowWatermarkPercentage)
```
    Deprecated.
    
    Description copied from interface: SessionConfiguration
    
    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.
    
    Specified by:
    
    setMutationBufferLowWatermark in interface SessionConfiguration
    
    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
  - setFlushInterval
```
public void setFlushInterval(int intervalMillis)
```
    Description copied from interface: SessionConfiguration
    
    Set the flush interval, which will be used for the next scheduling decision.
    
    Specified by:
    
    setFlushInterval in interface SessionConfiguration
    
    Parameters:
    
    intervalMillis - interval in milliseconds.
  - getTimeoutMillis
```
public long getTimeoutMillis()
```
    Description copied from interface: SessionConfiguration
    
    Get the current timeout.
    
    Specified by:
    
    getTimeoutMillis in interface SessionConfiguration
    
    Returns:
    
    operation timeout in milliseconds, 0 if none was configured.
  - setTimeoutMillis
```
public void setTimeoutMillis(long timeout)
```
    Description copied from interface: SessionConfiguration
    
    Sets the timeout for the next applied operations. The default timeout is 0, which disables the timeout functionality.
    
    Specified by:
    
    setTimeoutMillis in interface SessionConfiguration
    
    Parameters:
    
    timeout - Timeout in milliseconds.
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: SessionConfiguration
    
    Returns true if this session has already been closed.
    
    Specified by:
    
    isClosed in interface SessionConfiguration
  - hasPendingOperations
```
public boolean hasPendingOperations()
```
    Description copied from interface: SessionConfiguration
    
    Check if there are operations that haven't been completely applied.
    
    Specified by:
    
    hasPendingOperations in interface SessionConfiguration
    
    Returns:
    
    true if operations are pending, else false.
  - setExternalConsistencyMode
```
public void setExternalConsistencyMode(ExternalConsistencyMode consistencyMode)
```
    Description copied from interface: SessionConfiguration
    
    Set the new external consistency mode for this session.
    
    Specified by:
    
    setExternalConsistencyMode in interface SessionConfiguration
    
    Parameters:
    
    consistencyMode - new external consistency mode, can the same as the previous one.
  - isIgnoreAllDuplicateRows
```
public boolean isIgnoreAllDuplicateRows()
```
    Description copied from interface: SessionConfiguration
    
    Tells if the session is currently ignoring row errors when the whole list returned by a tablet server is of the AlreadyPresent type.
    
    Specified by:
    
    isIgnoreAllDuplicateRows in interface SessionConfiguration
    
    Returns:
    
    true if the session is enforcing this, else false
  - setIgnoreAllDuplicateRows
```
public void setIgnoreAllDuplicateRows(boolean ignoreAllDuplicateRows)
```
    Description copied from interface: SessionConfiguration
    
    Configures the option to ignore all the row errors if they are all of the AlreadyPresent type. This can be useful when it is possible for INSERT operations to be retried and fail. 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. TODO(KUDU-1563): Implement server side ignore capabilities to improve performance and reliability of INSERT ignore operations.
    Disabled by default.
    
    Specified by:
    
    setIgnoreAllDuplicateRows in interface SessionConfiguration
    
    Parameters:
    
    ignoreAllDuplicateRows - true if this session should enforce this, else false
  - isIgnoreAllNotFoundRows
```
public boolean isIgnoreAllNotFoundRows()
```
    Description copied from interface: SessionConfiguration
    
    Tells if the session is currently ignoring row errors when the whole list returned by a tablet server is of the NotFound type.
    
    Specified by:
    
    isIgnoreAllNotFoundRows in interface SessionConfiguration
    
    Returns:
    
    true if the session is enforcing this, else false
  - setIgnoreAllNotFoundRows
```
public void setIgnoreAllNotFoundRows(boolean ignoreAllNotFoundRows)
```
    Description copied from interface: SessionConfiguration
    
    Configures the option to ignore all the row errors if they are all of the NotFound type. This can be useful when it is possible for DELETE operations to be retried and fail. 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. TODO(KUDU-1563): Implement server side ignore capabilities to improve performance and reliability of DELETE ignore operations.
    Disabled by default.
    
    Specified by:
    
    setIgnoreAllNotFoundRows in interface SessionConfiguration
    
    Parameters:
    
    ignoreAllNotFoundRows - true if this session should enforce this, else false
  - countPendingErrors
```
public int countPendingErrors()
```
    Description copied from interface: SessionConfiguration
    
    Return the number of errors which are pending. Errors may accumulate when using AUTO_FLUSH_BACKGROUND mode.
    
    Specified by:
    
    countPendingErrors in interface SessionConfiguration
    
    Returns:
    
    a count of errors
  - getPendingErrors
```
public RowErrorsAndOverflowStatus getPendingErrors()
```
    Description copied from interface: SessionConfiguration
    
    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.
    
    Specified by:
    
    getPendingErrors in interface SessionConfiguration
    
    Returns:
    
    an object that contains the errors and the overflow status
  - getWriteOpMetrics
```
public ResourceMetrics getWriteOpMetrics()
```
    Description copied from interface: SessionConfiguration
    
    Return cumulative write operation metrics since the beginning of the session.
    
    Specified by:
    
    getWriteOpMetrics in interface SessionConfiguration
    
    Returns:
    
    cumulative write operation metrics since the beginning of the session.

Class KuduSession

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kudu.client.SessionConfiguration

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.kudu.client.SessionConfiguration

Method Detail

apply

flush

close

getFlushMode

setFlushMode

setMutationBufferSpace

setErrorCollectorSpace

setMutationBufferLowWatermark

setFlushInterval

getTimeoutMillis

setTimeoutMillis

isClosed

hasPendingOperations

setExternalConsistencyMode

isIgnoreAllDuplicateRows

setIgnoreAllDuplicateRows

isIgnoreAllNotFoundRows

setIgnoreAllNotFoundRows

countPendingErrors

getPendingErrors

getWriteOpMetrics