Package org.apache.hadoop.hbase.client

Class AsyncBufferedMutatorImpl

java.lang.Object

org.apache.hadoop.hbase.client.AsyncBufferedMutatorImpl

All Implemented Interfaces:

Closeable, AutoCloseable, AsyncBufferedMutator

@Private
class AsyncBufferedMutatorImpl
extends Object
implements AsyncBufferedMutator

The implementation of AsyncBufferedMutator. Simply wrap an AsyncTable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AsyncBufferedMutatorImpl.Batch

Field Summary

Fields

Modifier and Type	Field	Description
private long	bufferedSize
private boolean	closed
private ArrayList<CompletableFuture<Void>>	futures
private static final int	INITIAL_CAPACITY
(package private) final ReentrantLock	lock
private static final org.slf4j.Logger	LOG
private final int	maxKeyValueSize
private final int	maxMutations
private ArrayList<Mutation>	mutations
private final org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer	periodicalFlushTimer
(package private) org.apache.hbase.thirdparty.io.netty.util.Timeout	periodicFlushTask
private final long	periodicFlushTimeoutNs
private final AsyncTable<?>	table
private final long	writeBufferSize

Constructor Summary

Constructors

Constructor	Description
AsyncBufferedMutatorImpl(org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer periodicalFlushTimer, AsyncTable<?> table, long writeBufferSize, long periodicFlushTimeoutNs, int maxKeyValueSize, int maxMutations)

Method Summary

Modifier and Type	Method	Description
void	close()	Performs a AsyncBufferedMutator.flush() and releases any resources held.
protected AsyncBufferedMutatorImpl.Batch	drainBatch()	Atomically drains the current buffered mutations and futures under lock and prepares this mutator to accept a new batch.
void	flush()	Executes all the buffered, asynchronous operations.
private void	flushOrClose(boolean close)
org.apache.hadoop.conf.Configuration	getConfiguration()	Returns the Configuration object used by this instance.
int	getMaxMutations()	The maximum number of mutations that this buffered mutator will buffer before flushing them
TableName	getName()	Gets the fully qualified table name instance of the table that this AsyncBufferedMutator writes to.
long	getPeriodicalFlushTimeout(TimeUnit unit)	Returns the periodical flush interval, 0 means disabled.
Map<String,byte[]>	getRequestAttributes()	Returns the rpc request attributes.
long	getWriteBufferSize()	Returns the maximum size in bytes of the write buffer.
List<CompletableFuture<Void>>	mutate(List<? extends Mutation> mutations)	Send some Mutations to the table.
private void	sendBatch(AsyncBufferedMutatorImpl.Batch batch)	Sends a previously drained AsyncBufferedMutatorImpl.Batch and wires the user-visible completion futures to the underlying results returned by AsyncTable.batch(List).

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

mutate

Field Details

LOG

private static final org.slf4j.Logger LOG

INITIAL_CAPACITY

private static final int INITIAL_CAPACITY

See Also:

• Constant Field Values

periodicalFlushTimer

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

table

private final AsyncTable<?> table

writeBufferSize

private final long writeBufferSize

periodicFlushTimeoutNs

private final long periodicFlushTimeoutNs

maxKeyValueSize

private final int maxKeyValueSize

maxMutations

private final int maxMutations

mutations

private ArrayList<Mutation> mutations

futures

private ArrayList<CompletableFuture<Void>> futures

bufferedSize

private long bufferedSize

closed

private volatile boolean closed

periodicFlushTask

org.apache.hbase.thirdparty.io.netty.util.Timeout periodicFlushTask

lock

final ReentrantLock lock

Constructor Details

AsyncBufferedMutatorImpl

AsyncBufferedMutatorImpl(org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer periodicalFlushTimer,
 AsyncTable<?> table,
 long writeBufferSize,
 long periodicFlushTimeoutNs,
 int maxKeyValueSize,
 int maxMutations)

Method Details

getName

public TableName getName()

Description copied from interface: AsyncBufferedMutator

Gets the fully qualified table name instance of the table that this AsyncBufferedMutator writes to.

Specified by:

getName in interface AsyncBufferedMutator

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

Description copied from interface: AsyncBufferedMutator

Returns the Configuration object used by this instance.

The reference returned is not a copy, so any change made to it will affect this instance.

Specified by:

getConfiguration in interface AsyncBufferedMutator

drainBatch

protected AsyncBufferedMutatorImpl.Batch drainBatch()

Atomically drains the current buffered mutations and futures under lock and prepares this mutator to accept a new batch.

The lock must be acquired before calling this method. Cancels any pending periodicFlushTask to avoid a redundant flush for the data we are about to send. Swaps the shared mutations and futures lists into a returned AsyncBufferedMutatorImpl.Batch, replaces them with fresh lists, and resets bufferedSize to zero.

If there is nothing buffered, returns null so callers can skip sending work.

Protected for being overridden in tests.

Returns:

a AsyncBufferedMutatorImpl.Batch containing drained mutations and futures, or null if empty

sendBatch

private void sendBatch(AsyncBufferedMutatorImpl.Batch batch)

Sends a previously drained AsyncBufferedMutatorImpl.Batch and wires the user-visible completion futures to the underlying results returned by AsyncTable.batch(List).

Preserves the one-to-one, in-order mapping between mutations and their corresponding futures.

Parameters:

batch - the drained batch to send; may be null

mutate

public List<CompletableFuture<Void>> mutate(List<? extends Mutation> mutations)

Description copied from interface: AsyncBufferedMutator

Send some Mutations to the table. The mutations will be buffered and sent over the wire as part of a batch. There is no guarantee of sending entire content of mutations in a single batch, the implementations are free to break it up according to the write buffer capacity.

Specified by:

mutate in interface AsyncBufferedMutator

Parameters:

mutations - The data to send.

flushOrClose

private void flushOrClose(boolean close)

flush

public void flush()

Description copied from interface: AsyncBufferedMutator

Executes all the buffered, asynchronous operations.

Specified by:

flush in interface AsyncBufferedMutator

close

public void close()

Description copied from interface: AsyncBufferedMutator

Performs a AsyncBufferedMutator.flush() and releases any resources held.

Specified by:

close in interface AsyncBufferedMutator

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getWriteBufferSize

public long getWriteBufferSize()

Description copied from interface: AsyncBufferedMutator

Returns the maximum size in bytes of the write buffer.

The default value comes from the configuration parameter hbase.client.write.buffer.

Specified by:

getWriteBufferSize in interface AsyncBufferedMutator

Returns:

The size of the write buffer in bytes.

getPeriodicalFlushTimeout

public long getPeriodicalFlushTimeout(TimeUnit unit)

Description copied from interface: AsyncBufferedMutator

Returns the periodical flush interval, 0 means disabled.

Specified by:

getPeriodicalFlushTimeout in interface AsyncBufferedMutator

getMaxMutations

public int getMaxMutations()

Description copied from interface: AsyncBufferedMutator

The maximum number of mutations that this buffered mutator will buffer before flushing them

Specified by:

getMaxMutations in interface AsyncBufferedMutator

getRequestAttributes

public Map<String,byte[]> getRequestAttributes()

Description copied from interface: AsyncBufferedMutator

Returns the rpc request attributes.

Specified by:

getRequestAttributes in interface AsyncBufferedMutator