Package org.apache.hadoop.hbase.client

Class AsyncBufferedMutatorBuilderImpl

java.lang.Object

org.apache.hadoop.hbase.client.AsyncBufferedMutatorBuilderImpl

All Implemented Interfaces:

AsyncBufferedMutatorBuilder

@Private
class AsyncBufferedMutatorBuilderImpl
extends Object
implements AsyncBufferedMutatorBuilder

The implementation of AsyncBufferedMutatorBuilder.

Field Summary

Fields

Modifier and Type	Field	Description
private int	maxKeyValueSize
private int	maxMutations
private final org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer	periodicalFlushTimer
private long	periodicFlushTimeoutNs
private final AsyncTableBuilder<?>	tableBuilder
private long	writeBufferSize

Constructor Summary

Constructors

Constructor	Description
AsyncBufferedMutatorBuilderImpl(AsyncConnectionConfiguration connConf, AsyncTableBuilder<?> tableBuilder, org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer periodicalFlushTimer)

Method Summary

Modifier and Type	Method	Description
AsyncBufferedMutator	build()	Create the AsyncBufferedMutator instance.
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.
AsyncBufferedMutatorBuilder	setMaxMutations(int maxMutations)	Set the maximum number of mutations that this buffered mutator will buffer before flushing them.
AsyncBufferedMutatorBuilder	setOperationTimeout(long timeout, TimeUnit unit)	Set timeout for the background flush operation.
AsyncBufferedMutatorBuilder	setRequestAttribute(String key, byte[] value)	Set a rpc request attribute.
AsyncBufferedMutatorBuilder	setRequestAttributes(Map<String,byte[]> requestAttributes)	Set multiple rpc request attributes.
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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.client.AsyncBufferedMutatorBuilder

disableWriteBufferPeriodicFlush, setMaxRetries

Field Details

periodicalFlushTimer

private final org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer periodicalFlushTimer

tableBuilder

private final AsyncTableBuilder<?> tableBuilder

writeBufferSize

private long writeBufferSize

periodicFlushTimeoutNs

private long periodicFlushTimeoutNs

maxKeyValueSize

private int maxKeyValueSize

maxMutations

private int maxMutations

Constructor Details

AsyncBufferedMutatorBuilderImpl

public AsyncBufferedMutatorBuilderImpl(AsyncConnectionConfiguration connConf,
 AsyncTableBuilder<?> tableBuilder,
 org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer periodicalFlushTimer)

Method Details

setOperationTimeout

public AsyncBufferedMutatorBuilder setOperationTimeout(long timeout,
 TimeUnit unit)

Description copied from interface: AsyncBufferedMutatorBuilder

Set timeout for the background flush operation.

Specified by:

setOperationTimeout in interface AsyncBufferedMutatorBuilder

setRpcTimeout

public AsyncBufferedMutatorBuilder setRpcTimeout(long timeout,
 TimeUnit unit)

Description copied from interface: AsyncBufferedMutatorBuilder

Set timeout for each rpc request when doing background flush.

Specified by:

setRpcTimeout in interface AsyncBufferedMutatorBuilder

setRetryPause

public AsyncBufferedMutatorBuilder setRetryPause(long pause,
 TimeUnit unit)

Description copied from interface: AsyncBufferedMutatorBuilder

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

Specified by:

setRetryPause in interface AsyncBufferedMutatorBuilder

setMaxAttempts

public AsyncBufferedMutatorBuilder setMaxAttempts(int maxAttempts)

Description copied from interface: AsyncBufferedMutatorBuilder

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.

Specified by:

setMaxAttempts in interface AsyncBufferedMutatorBuilder

See Also:

• AsyncBufferedMutatorBuilder.setMaxRetries(int)
• AsyncBufferedMutatorBuilder.setOperationTimeout(long, TimeUnit)

setStartLogErrorsCnt

public AsyncBufferedMutatorBuilder setStartLogErrorsCnt(int startLogErrorsCnt)

Description copied from interface: AsyncBufferedMutatorBuilder

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

Specified by:

setStartLogErrorsCnt in interface AsyncBufferedMutatorBuilder

setRequestAttribute

public AsyncBufferedMutatorBuilder setRequestAttribute(String key,
 byte[] value)

Description copied from interface: AsyncBufferedMutatorBuilder

Set a rpc request attribute.

Specified by:

setRequestAttribute in interface AsyncBufferedMutatorBuilder

setRequestAttributes

public AsyncBufferedMutatorBuilder setRequestAttributes(Map<String,byte[]> requestAttributes)

Description copied from interface: AsyncBufferedMutatorBuilder

Set multiple rpc request attributes.

Specified by:

setRequestAttributes in interface AsyncBufferedMutatorBuilder

setWriteBufferSize

public AsyncBufferedMutatorBuilder setWriteBufferSize(long writeBufferSize)

Description copied from interface: AsyncBufferedMutatorBuilder

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

Specified by:

setWriteBufferSize in interface AsyncBufferedMutatorBuilder

setWriteBufferPeriodicFlush

public AsyncBufferedMutatorBuilder setWriteBufferPeriodicFlush(long timeout,
 TimeUnit unit)

Description copied from interface: AsyncBufferedMutatorBuilder

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'.

Specified by:

setWriteBufferPeriodicFlush in interface AsyncBufferedMutatorBuilder

setMaxKeyValueSize

public AsyncBufferedMutatorBuilder setMaxKeyValueSize(int maxKeyValueSize)

Description copied from interface: AsyncBufferedMutatorBuilder

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

Specified by:

setMaxKeyValueSize in interface AsyncBufferedMutatorBuilder

setMaxMutations

public AsyncBufferedMutatorBuilder setMaxMutations(int maxMutations)

Description copied from interface: AsyncBufferedMutatorBuilder

Set the maximum number of mutations that this buffered mutator will buffer before flushing them. If you are talking to a cluster that uses hbase.rpc.rows.size.threshold.reject to reject large Multi requests, you may need this setting to avoid rejections. Default is no limit.

Specified by:

setMaxMutations in interface AsyncBufferedMutatorBuilder

build

public AsyncBufferedMutator build()

Description copied from interface: AsyncBufferedMutatorBuilder

Create the AsyncBufferedMutator instance.

Specified by:

build in interface AsyncBufferedMutatorBuilder