org.apache.hadoop.hbase.client

Class AsyncBufferedMutatorImpl

java.lang.Object

org.apache.hadoop.hbase.client.AsyncBufferedMutatorImpl

All Implemented Interfaces:

Closeable, AutoCloseable, AsyncBufferedMutator

@InterfaceAudience.Private
class AsyncBufferedMutatorImpl
extends Object
implements AsyncBufferedMutator

The implementation of AsyncBufferedMutator. Simply wrap an AsyncTable.

Field Summary

Fields

Modifier and Type	Field and Description
private long	bufferedSize
private boolean	closed
private List<CompletableFuture<Void>>	futures
private List<Mutation>	mutations
private org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer	periodicalFlushTimer
(package private) org.apache.hbase.thirdparty.io.netty.util.Timeout	periodicFlushTask
private long	periodicFlushTimeoutNs
private AsyncTable<?>	table
private long	writeBufferSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Performs a AsyncBufferedMutator.flush() and releases any resources held.
void	flush() Executes all the buffered, asynchronous operations.
org.apache.hadoop.conf.Configuration	getConfiguration() Returns the Configuration object used by this instance.
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.
long	getWriteBufferSize() Returns the maximum size in bytes of the write buffer.
protected void	internalFlush()
List<CompletableFuture<Void>>	mutate(List<? extends Mutation> mutations) Send some Mutations to the table.

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 Detail

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

mutations

private List<Mutation> mutations

futures

private List<CompletableFuture<Void>> futures

bufferedSize

private long bufferedSize

closed

private boolean closed

periodicFlushTask

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

Constructor Detail

AsyncBufferedMutatorImpl

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

Method Detail

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

internalFlush

protected void internalFlush()

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.

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 Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AsyncBufferedMutator

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