BufferedMutatorImpl (Apache HBase

java.lang.Object
- org.apache.hadoop.hbase.client.BufferedMutatorImpl

所有已实现的接口:

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.

从以下版本开始:

1.0.0

另请参阅:
ConnectionFactory, Connection

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.hadoop.hbase.client.BufferedMutator
  BufferedMutator.ExceptionListener

字段概要

字段
限定符和类型	字段和说明
`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.

方法概要

方法
限定符和类型	方法和说明
`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()` 已过时。 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 `Mutation`s 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)` 已过时。 Going away when we drop public support for `HTableInterface`.
`void`	`validatePut(Put put)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - 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.
    
    另请参阅:
    常量字段值
  - ap
```
protected org.apache.hadoop.hbase.client.AsyncProcess ap
```
- 方法详细资料
  - getName
```
public TableName getName()
```
    从接口复制的说明: BufferedMutator
    
    Gets the fully qualified table name instance of the table that this BufferedMutator writes to.
    
    指定者:
    
    getName 在接口中 BufferedMutator
  - getConfiguration
```
public org.apache.hadoop.conf.Configuration getConfiguration()
```
    从接口复制的说明: 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.
    
    指定者:
    
    getConfiguration 在接口中 BufferedMutator
  - mutate
```
public void mutate(Mutation m)
            throws InterruptedIOException,
                   RetriesExhaustedWithDetailsException
```
    从接口复制的说明: 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.
    
    指定者:
    
    mutate 在接口中 BufferedMutator
    
    参数:
    m - The data to send.
    
    抛出:
    
    InterruptedIOException
    
    RetriesExhaustedWithDetailsException
  - mutate
```
public void mutate(List<? extends Mutation> ms)
            throws InterruptedIOException,
                   RetriesExhaustedWithDetailsException
```
    从接口复制的说明: 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.
    
    指定者:
    
    mutate 在接口中 BufferedMutator
    
    参数:
    ms - The data to send.
    
    抛出:
    
    InterruptedIOException
    
    RetriesExhaustedWithDetailsException
  - getExecutedWriteBufferPeriodicFlushes
```
protected long getExecutedWriteBufferPeriodicFlushes()
```
  - validatePut
```
public void validatePut(Put put)
                 throws IllegalArgumentException
```
    抛出:
    
    IllegalArgumentException
  - close
```
public void close()
           throws IOException
```
    从接口复制的说明: BufferedMutator
    
    Performs a BufferedMutator.flush() and releases any resources held.
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 BufferedMutator
    
    抛出:
    
    IOException - if a remote or network exception occurs.
  - flush
```
public void flush()
           throws InterruptedIOException,
                  RetriesExhaustedWithDetailsException
```
    从接口复制的说明: BufferedMutator
    
    Executes all the buffered, asynchronous Mutation operations and waits until they are done.
    
    指定者:
    
    flush 在接口中 BufferedMutator
    
    抛出:
    
    InterruptedIOException
    
    RetriesExhaustedWithDetailsException
  - setWriteBufferSize
```
@Deprecated
public void setWriteBufferSize(long writeBufferSize)
                        throws RetriesExhaustedWithDetailsException,
                               InterruptedIOException
```
    已过时。 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.
    
    抛出:
    
    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.
    
    指定者:
    
    getWriteBufferSize 在接口中 BufferedMutator
    
    返回:
    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.
    
    参数:
    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.
    
    参数:
    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.
    
    返回:
    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.
    
    返回:
    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()
```
    已过时。 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.

类 BufferedMutatorImpl

嵌套类概要

从接口继承的嵌套类/接口 org.apache.hadoop.hbase.client.BufferedMutator

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

connection

MIN_WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS

ap

方法详细资料

getName

getConfiguration

mutate

mutate

getExecutedWriteBufferPeriodicFlushes

validatePut

close

flush

setWriteBufferSize

getWriteBufferSize

setWriteBufferPeriodicFlush

disableWriteBufferPeriodicFlush

setWriteBufferPeriodicFlush

getWriteBufferPeriodicFlushTimeoutMs

getWriteBufferPeriodicFlushTimerTickMs

setRpcTimeout

setOperationTimeout

getWriteBuffer