org.apache.hadoop.hbase.client

Class BufferedMutatorImpl

java.lang.Object

org.apache.hadoop.hbase.client.BufferedMutatorImpl

All Implemented Interfaces:

Closeable, AutoCloseable, BufferedMutator

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class BufferedMutatorImpl
extends Object
implements BufferedMutator

Used to communicate with a single HBase table similar to HTable but meant for batched, potentially asynchronous puts. Obtain an instance from a Connection and call close() afterwards.

While this can be used accross threads, great care should be used when doing so. Errors are global to the buffered mutator and the Exceptions can be thrown on any thread that causes the flush for requests.

Since:

1.0.0

See Also:

ConnectionFactory, Connection

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.client.BufferedMutator

BufferedMutator.ExceptionListener

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.hadoop.hbase.client.AsyncProcess	ap
protected ClusterConnection	connection
static long	MIN_WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS Having the timer tick run more often that once every 100ms is needless and will probably cause too many timer events firing having a negative impact on performance.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Performs a BufferedMutator.flush() and releases any resources held.
void	disableWriteBufferPeriodicFlush() Disable periodic flushing of the write buffer.
void	flush() Executes all the buffered, asynchronous Mutation operations and waits until they are done.
org.apache.hadoop.conf.Configuration	getConfiguration() Returns the Configuration object used by this instance.
protected long	getExecutedWriteBufferPeriodicFlushes()
TableName	getName() Gets the fully qualified table name instance of the table that this BufferedMutator writes to.
List<Row>	getWriteBuffer() Deprecated. Going away when we drop public support for HTableInterface. Ó
long	getWriteBufferPeriodicFlushTimeoutMs() Returns the current periodic flush timeout value in milliseconds.
long	getWriteBufferPeriodicFlushTimerTickMs() Returns the current periodic flush timertick interval in milliseconds.
long	getWriteBufferSize() Returns the maximum size in bytes of the write buffer for this HTable.
void	mutate(List<? extends Mutation> ms) Send some Mutations to the table.
void	mutate(Mutation m) Sends a Mutation to the table.
void	setOperationTimeout(int operationTimeout)
void	setRpcTimeout(int writeRpcTimeout)
void	setWriteBufferPeriodicFlush(long timeoutMs) Sets the maximum time before the buffer is automatically flushed checking once per second.
void	setWriteBufferPeriodicFlush(long timeoutMs, long timerTickMs) Sets the maximum time before the buffer is automatically flushed.
void	setWriteBufferSize(long writeBufferSize) Deprecated. Going away when we drop public support for HTableInterface.
void	validatePut(Put put)

Methods inherited from class java.lang.Object

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

Field Detail

connection

protected ClusterConnection connection

MIN_WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS

public static final long MIN_WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS

Having the timer tick run more often that once every 100ms is needless and will probably cause too many timer events firing having a negative impact on performance.

See Also:

Constant Field Values

ap

protected org.apache.hadoop.hbase.client.AsyncProcess ap

Method Detail

getName

public TableName getName()

Description copied from interface: BufferedMutator

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

Specified by:

getName in interface BufferedMutator

getConfiguration

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

Description copied from interface: BufferedMutator

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 BufferedMutator

mutate

public void mutate(Mutation m)
            throws InterruptedIOException,
                   RetriesExhaustedWithDetailsException

Description copied from interface: BufferedMutator

Sends a Mutation to the table. The mutations will be buffered and sent over the wire as part of a batch. Currently only supports Put and Delete mutations.

Specified by:

mutate in interface BufferedMutator

Parameters:

m - The data to send.

Throws:

InterruptedIOException

RetriesExhaustedWithDetailsException

mutate

public void mutate(List<? extends Mutation> ms)
            throws InterruptedIOException,
                   RetriesExhaustedWithDetailsException

Description copied from interface: BufferedMutator

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; it will be broken up according to the write buffer capacity.

Specified by:

mutate in interface BufferedMutator

Parameters:

ms - The data to send.

Throws:

InterruptedIOException

RetriesExhaustedWithDetailsException

getExecutedWriteBufferPeriodicFlushes

protected long getExecutedWriteBufferPeriodicFlushes()

validatePut

public void validatePut(Put put)
                 throws IllegalArgumentException

Throws:

IllegalArgumentException

close

public void close()
           throws IOException

Description copied from interface: BufferedMutator

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BufferedMutator

Throws:

IOException - if a remote or network exception occurs.

flush

public void flush()
           throws InterruptedIOException,
                  RetriesExhaustedWithDetailsException

Description copied from interface: BufferedMutator

Executes all the buffered, asynchronous Mutation operations and waits until they are done.

Specified by:

flush in interface BufferedMutator

Throws:

InterruptedIOException

RetriesExhaustedWithDetailsException

setWriteBufferSize

@Deprecated
public void setWriteBufferSize(long writeBufferSize)
                        throws RetriesExhaustedWithDetailsException,
                               InterruptedIOException

Deprecated. Going away when we drop public support for HTableInterface.

This is used for legacy purposes in HTable.setWriteBufferSize(long) only. This ought not be called for production uses.

Throws:

RetriesExhaustedWithDetailsException

InterruptedIOException

getWriteBufferSize

public long getWriteBufferSize()

Returns the maximum size in bytes of the write buffer for this HTable.

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

Specified by:

getWriteBufferSize in interface BufferedMutator

Returns:

The size of the write buffer in bytes.

setWriteBufferPeriodicFlush

public void setWriteBufferPeriodicFlush(long timeoutMs,
                               long timerTickMs)

Sets the maximum time before the buffer is automatically flushed.

Parameters:

timeoutMs - The maximum number of milliseconds how long records may be buffered before they are flushed. Set to 0 to disable.

timerTickMs - The number of milliseconds between each check if the timeout has been exceeded. Must be 100ms (as defined in MIN_WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS) or larger to avoid performance problems.

disableWriteBufferPeriodicFlush

public void disableWriteBufferPeriodicFlush()

Disable periodic flushing of the write buffer.

setWriteBufferPeriodicFlush

public void setWriteBufferPeriodicFlush(long timeoutMs)

Sets the maximum time before the buffer is automatically flushed checking once per second.

Parameters:

timeoutMs - The maximum number of milliseconds how long records may be buffered before they are flushed. Set to 0 to disable.

getWriteBufferPeriodicFlushTimeoutMs

public long getWriteBufferPeriodicFlushTimeoutMs()

Returns the current periodic flush timeout value in milliseconds.

Returns:

The maximum number of milliseconds how long records may be buffered before they are flushed. The value 0 means this is disabled.

getWriteBufferPeriodicFlushTimerTickMs

public long getWriteBufferPeriodicFlushTimerTickMs()

Returns the current periodic flush timertick interval in milliseconds.

Returns:

The number of milliseconds between each check if the timeout has been exceeded. This value only has a real meaning if the timeout has been set to > 0

setRpcTimeout

public void setRpcTimeout(int writeRpcTimeout)

setOperationTimeout

public void setOperationTimeout(int operationTimeout)

getWriteBuffer

@Deprecated
public List<Row> getWriteBuffer()

Deprecated. Going away when we drop public support for HTableInterface. Ó

This is used for legacy purposes in HTable.getWriteBuffer() only. This should not beÓ called from production uses.