co.cask.cdap.data2.increment.hbase

Class IncrementHandlerState

java.lang.Object

co.cask.cdap.data2.increment.hbase.IncrementHandlerState

public class IncrementHandlerState
extends Object

Common state and utilities shared by the HBase version-specific IncrementHandler coprocessor implementations. This common implementation cannot go into a shared base class, as each coprocessor needs to derive from the HBase version's BaseRegionObserver class, in order to avoid being broken by API changes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BATCH_UNLIMITED
static int	DELTA_FULL_LENGTH
static byte[]	DELTA_MAGIC_PREFIX
static org.apache.commons.logging.Log	LOG
static long	MAX_TS_PER_MS
static String	PROPERTY_TRANSACTIONAL Property set for HColumnDescriptor to indicate if increment is transactional.
protected Map<byte[],Long>	ttlByFamily
protected Set<byte[]>	txnlFamilies

Constructor Summary

Constructors

Constructor and Description
IncrementHandlerState(Configuration conf, org.apache.hadoop.hbase.HTableDescriptor hTableDescriptor, HTableNameConverter hTableNameConverter)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsTransactionalFamily(Set<byte[]> familyNames)
long	getCompactionBound(byte[] columnFamily) Returns the upper bound beyond which we can compact any increment deltas into a new sum.
long	getFamilyTTL(byte[] familyName) Returns the time-to-live (in milliseconds) for the given column family, transformed into the same precision used in assigning unique timestamps.
long	getOldestVisibleTimestamp(byte[] familyName) Returns the oldest timestamp that will be visible for a given column family, after the column family's configured time-to-live is applied.
protected com.google.common.base.Supplier<co.cask.tephra.coprocessor.TransactionStateCache>	getTransactionStateCacheSupplier(org.apache.hadoop.hbase.HTableDescriptor htd, Configuration conf)
long	getUniqueTimestamp() Returns a unique timestamp for the current operation.
void	initFamily(byte[] familyName, Map<byte[],byte[]> familyValues)
void	setTimestampOracle(TimestampOracle timeOracle)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_TRANSACTIONAL

public static final String PROPERTY_TRANSACTIONAL

Property set for HColumnDescriptor to indicate if increment is transactional. Default: "true", i.e. transactional.

See Also:

Constant Field Values

MAX_TS_PER_MS

public static final long MAX_TS_PER_MS

See Also:

Constant Field Values

DELTA_MAGIC_PREFIX

public static final byte[] DELTA_MAGIC_PREFIX

DELTA_FULL_LENGTH

public static final int DELTA_FULL_LENGTH

BATCH_UNLIMITED

public static final int BATCH_UNLIMITED

See Also:

Constant Field Values

LOG

public static final org.apache.commons.logging.Log LOG

txnlFamilies

protected final Set<byte[]> txnlFamilies

ttlByFamily

protected Map<byte[],Long> ttlByFamily

Constructor Detail

IncrementHandlerState

public IncrementHandlerState(Configuration conf,
                     org.apache.hadoop.hbase.HTableDescriptor hTableDescriptor,
                     HTableNameConverter hTableNameConverter)

Method Detail

setTimestampOracle

public void setTimestampOracle(TimestampOracle timeOracle)

getTransactionStateCacheSupplier

protected com.google.common.base.Supplier<co.cask.tephra.coprocessor.TransactionStateCache> getTransactionStateCacheSupplier(org.apache.hadoop.hbase.HTableDescriptor htd,
                                                                                                                 Configuration conf)

initFamily

public void initFamily(byte[] familyName,
              Map<byte[],byte[]> familyValues)

containsTransactionalFamily

public boolean containsTransactionalFamily(Set<byte[]> familyNames)

getUniqueTimestamp

public long getUniqueTimestamp()

Returns a unique timestamp for the current operation.

Returns:

a new timestamp guaranteed to be unique within the scope of usage

getCompactionBound

public long getCompactionBound(byte[] columnFamily)

Returns the upper bound beyond which we can compact any increment deltas into a new sum.

Parameters:

columnFamily - the column family name

Returns:

the newest timestamp beyond which can compact delta increments

getFamilyTTL

public long getFamilyTTL(byte[] familyName)

Returns the time-to-live (in milliseconds) for the given column family, transformed into the same precision used in assigning unique timestamps.

Parameters:

familyName - the column family name

Returns:

the time-to-live value

getOldestVisibleTimestamp

public long getOldestVisibleTimestamp(byte[] familyName)

Returns the oldest timestamp that will be visible for a given column family, after the column family's configured time-to-live is applied.

Parameters:

familyName - the name of the column family

Returns:

the oldest timestamp value that will be visible