org.apache.hadoop.hbase.client

Interface AsyncBufferedMutatorBuilder

All Known Implementing Classes:

AsyncBufferedMutatorBuilderImpl

@InterfaceAudience.Public
public interface AsyncBufferedMutatorBuilder

For creating AsyncBufferedMutator.

Method Summary

Modifier and Type	Method and Description
AsyncBufferedMutator	build() Create the AsyncBufferedMutator instance.
default AsyncBufferedMutatorBuilder	disableWriteBufferPeriodicFlush() Disable the periodical flush, i.e, set the timeout to 0.
AsyncBufferedMutatorBuilder	setMaxAttempts(int maxAttempts) Set the max attempt times for an operation.
AsyncBufferedMutatorBuilder	setMaxKeyValueSize(int maxKeyValueSize) Override the maximum key-value size specified by the provided AsyncConnection's Configuration instance, via the configuration key hbase.client.keyvalue.maxsize.
default AsyncBufferedMutatorBuilder	setMaxRetries(int maxRetries) Set the max retry times for an operation.
AsyncBufferedMutatorBuilder	setOperationTimeout(long timeout, TimeUnit unit) Set timeout for the background flush operation.
AsyncBufferedMutatorBuilder	setRetryPause(long pause, TimeUnit unit) Set the base pause time for retrying.
AsyncBufferedMutatorBuilder	setRpcTimeout(long timeout, TimeUnit unit) Set timeout for each rpc request when doing background flush.
AsyncBufferedMutatorBuilder	setStartLogErrorsCnt(int startLogErrorsCnt) Set the number of retries that are allowed before we start to log.
default AsyncBufferedMutatorBuilder	setWriteBufferPeriodicFlush(long timeout, TimeUnit unit) Set the periodical flush interval.
AsyncBufferedMutatorBuilder	setWriteBufferSize(long writeBufferSize) Override the write buffer size specified by the provided AsyncConnection's Configuration instance, via the configuration key hbase.client.write.buffer.

Method Detail

setOperationTimeout

AsyncBufferedMutatorBuilder setOperationTimeout(long timeout,
                                                TimeUnit unit)

Set timeout for the background flush operation.

setRpcTimeout

AsyncBufferedMutatorBuilder setRpcTimeout(long timeout,
                                          TimeUnit unit)

Set timeout for each rpc request when doing background flush.

setRetryPause

AsyncBufferedMutatorBuilder setRetryPause(long pause,
                                          TimeUnit unit)

Set the base pause time for retrying. We use an exponential policy to generate sleep time when retrying.

setWriteBufferPeriodicFlush

default AsyncBufferedMutatorBuilder setWriteBufferPeriodicFlush(long timeout,
                                                                TimeUnit unit)

Set the periodical flush interval. If the data in the buffer has not been flush for a long time, i.e, reach this timeout limit, we will flush it automatically.

Notice that, set the timeout to 0 or a negative value means disable periodical flush, not 'flush immediately'. If you want to flush immediately then you should not use this class, as it is designed to be 'buffered'.

disableWriteBufferPeriodicFlush

default AsyncBufferedMutatorBuilder disableWriteBufferPeriodicFlush()

Disable the periodical flush, i.e, set the timeout to 0.

setMaxRetries

default AsyncBufferedMutatorBuilder setMaxRetries(int maxRetries)

Set the max retry times for an operation. Usually it is the max attempt times minus 1.

Operation timeout and max attempt times(or max retry times) are both limitations for retrying, we will stop retrying when we reach any of the limitations.

See Also:

setMaxAttempts(int), setOperationTimeout(long, TimeUnit)

setMaxAttempts

AsyncBufferedMutatorBuilder setMaxAttempts(int maxAttempts)

Set the max attempt times for an operation. Usually it is the max retry times plus 1. Operation timeout and max attempt times(or max retry times) are both limitations for retrying, we will stop retrying when we reach any of the limitations.

See Also:

setMaxRetries(int), setOperationTimeout(long, TimeUnit)

setStartLogErrorsCnt

AsyncBufferedMutatorBuilder setStartLogErrorsCnt(int startLogErrorsCnt)

Set the number of retries that are allowed before we start to log.

setWriteBufferSize

AsyncBufferedMutatorBuilder setWriteBufferSize(long writeBufferSize)

Override the write buffer size specified by the provided AsyncConnection's Configuration instance, via the configuration key hbase.client.write.buffer.

setMaxKeyValueSize

AsyncBufferedMutatorBuilder setMaxKeyValueSize(int maxKeyValueSize)

Override the maximum key-value size specified by the provided AsyncConnection's Configuration instance, via the configuration key hbase.client.keyvalue.maxsize.

build

AsyncBufferedMutator build()

Create the AsyncBufferedMutator instance.