Package org.apache.hadoop.hbase.client

Class BufferedMutatorParams

java.lang.Object

org.apache.hadoop.hbase.client.BufferedMutatorParams

All Implemented Interfaces:

Cloneable

@Public
public class BufferedMutatorParams
extends Object
implements Cloneable

Parameters for instantiating a BufferedMutator.

Field Summary

Fields

Modifier and Type	Field	Description
private String	implementationClassName
private BufferedMutator.ExceptionListener	listener
private int	maxKeyValueSize
private int	maxMutations
private int	operationTimeout
private ExecutorService	pool
protected Map<String,byte[]>	requestAttributes
private int	rpcTimeout
private final TableName	tableName
(package private) static final int	UNSET
private long	writeBufferPeriodicFlushTimeoutMs
private long	writeBufferPeriodicFlushTimerTickMs
private long	writeBufferSize

Constructor Summary

Constructors

Constructor	Description
BufferedMutatorParams(TableName tableName)

Method Summary

Modifier and Type	Method	Description
BufferedMutatorParams	clone()
String	getImplementationClassName()	Deprecated. Since 3.0.0, will be removed in 4.0.0.
BufferedMutator.ExceptionListener	getListener()
int	getMaxKeyValueSize()
int	getMaxMutations()	The maximum number of mutations that this buffered mutator will buffer before flushing them
int	getOperationTimeout()
ExecutorService	getPool()	Deprecated. Since 3.0.0-alpha-2, will be removed in 4.0.0.
Map<String,byte[]>	getRequestAttributes()
int	getRpcTimeout()
TableName	getTableName()
long	getWriteBufferPeriodicFlushTimeoutMs()
long	getWriteBufferPeriodicFlushTimerTickMs()	Deprecated. Since 3.0.0, will be removed in 4.0.0.
long	getWriteBufferSize()
BufferedMutatorParams	implementationClassName(String implementationClassName)	Deprecated. Since 3.0.0, will be removed in 4.0.0.
BufferedMutatorParams	listener(BufferedMutator.ExceptionListener listener)	Override the default error handler.
BufferedMutatorParams	maxKeyValueSize(int maxKeyValueSize)	Override the maximum key-value size specified by the provided Connection's Configuration instance, via the configuration key hbase.client.keyvalue.maxsize.
BufferedMutatorParams	operationTimeout(int operationTimeout)
BufferedMutatorParams	opertationTimeout(int operationTimeout)	Deprecated. Since 2.3.0, will be removed in 4.0.0.
BufferedMutatorParams	pool(ExecutorService pool)	Deprecated. Since 3.0.0-alpha-2, will be removed in 4.0.0.
BufferedMutatorParams	rpcTimeout(int rpcTimeout)
BufferedMutatorParams	setMaxMutations(int maxMutations)	Set the maximum number of mutations that this buffered mutator will buffer before flushing them.
BufferedMutatorParams	setRequestAttribute(String key, byte[] value)
BufferedMutatorParams	setWriteBufferPeriodicFlushTimeoutMs(long timeoutMs)	Set the max timeout before the buffer is automatically flushed.
BufferedMutatorParams	setWriteBufferPeriodicFlushTimerTickMs(long timerTickMs)	Deprecated. Since 3.0.0, will be removed in 4.0.0.
BufferedMutatorParams	writeBufferSize(long writeBufferSize)	Override the write buffer size specified by the provided Connection's Configuration instance, via the configuration key hbase.client.write.buffer.

Methods inherited from class java.lang.Object

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

Field Details

UNSET

static final int UNSET

See Also:

• Constant Field Values

tableName

private final TableName tableName

writeBufferSize

private long writeBufferSize

writeBufferPeriodicFlushTimeoutMs

private long writeBufferPeriodicFlushTimeoutMs

writeBufferPeriodicFlushTimerTickMs

private long writeBufferPeriodicFlushTimerTickMs

maxKeyValueSize

private int maxKeyValueSize

pool

private ExecutorService pool

implementationClassName

private String implementationClassName

rpcTimeout

private int rpcTimeout

operationTimeout

private int operationTimeout

maxMutations

private int maxMutations

requestAttributes

protected Map<String,byte[]> requestAttributes

listener

private BufferedMutator.ExceptionListener listener

Constructor Details

BufferedMutatorParams

public BufferedMutatorParams(TableName tableName)

Method Details

getTableName

public TableName getTableName()

getWriteBufferSize

public long getWriteBufferSize()

rpcTimeout

public BufferedMutatorParams rpcTimeout(int rpcTimeout)

getRpcTimeout

public int getRpcTimeout()

operationTimeout

public BufferedMutatorParams operationTimeout(int operationTimeout)

opertationTimeout

@Deprecated
public BufferedMutatorParams opertationTimeout(int operationTimeout)

Deprecated.

Since 2.3.0, will be removed in 4.0.0. Use operationTimeout(int)

getOperationTimeout

public int getOperationTimeout()

setMaxMutations

public BufferedMutatorParams setMaxMutations(int maxMutations)

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.

getMaxMutations

public int getMaxMutations()

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

setRequestAttribute

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

getRequestAttributes

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

writeBufferSize

public BufferedMutatorParams writeBufferSize(long writeBufferSize)

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

getWriteBufferPeriodicFlushTimeoutMs

public long getWriteBufferPeriodicFlushTimeoutMs()

setWriteBufferPeriodicFlushTimeoutMs

public BufferedMutatorParams setWriteBufferPeriodicFlushTimeoutMs(long timeoutMs)

Set the max timeout before the buffer is automatically flushed.

getWriteBufferPeriodicFlushTimerTickMs

@Deprecated
public long getWriteBufferPeriodicFlushTimerTickMs()

Deprecated.

Since 3.0.0, will be removed in 4.0.0. We use a common timer in the whole client implementation so you can not set it any more.

setWriteBufferPeriodicFlushTimerTickMs

@Deprecated
public BufferedMutatorParams setWriteBufferPeriodicFlushTimerTickMs(long timerTickMs)

Deprecated.

Since 3.0.0, will be removed in 4.0.0. We use a common timer in the whole client implementation so you can not set it any more.

Set the TimerTick how often the buffer timeout if checked.

getMaxKeyValueSize

public int getMaxKeyValueSize()

maxKeyValueSize

public BufferedMutatorParams maxKeyValueSize(int maxKeyValueSize)

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

getPool

@Deprecated
public ExecutorService getPool()

Deprecated.

Since 3.0.0-alpha-2, will be removed in 4.0.0. You can not set it anymore. BufferedMutator will use Connection's ExecutorService.

pool

@Deprecated
public BufferedMutatorParams pool(ExecutorService pool)

Deprecated.

Since 3.0.0-alpha-2, will be removed in 4.0.0. You can not set it anymore. BufferedMutator will use Connection's ExecutorService.

Override the default executor pool defined by the hbase.htable.threads.* configuration values.

getImplementationClassName

@Deprecated
public String getImplementationClassName()

Deprecated.

Since 3.0.0, will be removed in 4.0.0. You can not set it any more as the implementation has to use too many internal stuffs in HBase.

Returns:

Name of the class we will use when we construct a BufferedMutator instance or null if default implementation.

implementationClassName

@Deprecated
public BufferedMutatorParams implementationClassName(String implementationClassName)

Deprecated.

Since 3.0.0, will be removed in 4.0.0. You can not set it any more as the implementation has to use too many internal stuffs in HBase.

Specify a BufferedMutator implementation other than the default.

Parameters:

implementationClassName - Name of the BufferedMutator implementation class

getListener

public BufferedMutator.ExceptionListener getListener()

listener

public BufferedMutatorParams listener(BufferedMutator.ExceptionListener listener)

Override the default error handler. Default handler simply rethrows the exception.

clone

public BufferedMutatorParams clone()

Overrides:

clone in class Object