co.cask.tephra.hbase10.coprocessor

Class TransactionVisibilityFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

co.cask.tephra.hbase10.coprocessor.TransactionVisibilityFilter

public class TransactionVisibilityFilter
extends org.apache.hadoop.hbase.filter.FilterBase

Applies filtering of data based on transactional visibility (HBase 1.0+ specific version). Note: this is intended for server-side use only, as additional properties need to be set on any Scan or Get operation performed.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.Filter.ReturnCode

Field Summary

Fields inherited from class org.apache.hadoop.hbase.filter.Filter

reversed

Constructor Summary

Constructors

Constructor and Description
TransactionVisibilityFilter(Transaction tx, Map<byte[],Long> ttlByFamily, boolean allowEmptyValues, org.apache.hadoop.hbase.regionserver.ScanType scanType) Creates a new Filter for returning data only from visible transactions.
TransactionVisibilityFilter(Transaction tx, Map<byte[],Long> ttlByFamily, boolean allowEmptyValues, org.apache.hadoop.hbase.regionserver.ScanType scanType, org.apache.hadoop.hbase.filter.Filter cellFilter) Creates a new Filter for returning data only from visible transactions.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.hadoop.hbase.filter.Filter.ReturnCode	filterKeyValue(org.apache.hadoop.hbase.Cell cell)
void	reset()
byte[]	toByteArray()

Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase

createFilterFromArguments, filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, toString, transform, transformCell

Methods inherited from class org.apache.hadoop.hbase.filter.Filter

isReversed, parseFrom, setReversed

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionVisibilityFilter

public TransactionVisibilityFilter(Transaction tx,
                           Map<byte[],Long> ttlByFamily,
                           boolean allowEmptyValues,
                           org.apache.hadoop.hbase.regionserver.ScanType scanType)

Creates a new Filter for returning data only from visible transactions.

Parameters:

tx - the current transaction to apply. Only data visible to this transaction will be returned.

ttlByFamily - map of time-to-live (TTL) (in milliseconds) by column family name

allowEmptyValues - if true cells with empty byte[] values will be returned, if false these will be interpreted as "delete" markers and the column will be filtered out

scanType - the type of scan operation being performed

TransactionVisibilityFilter

public TransactionVisibilityFilter(Transaction tx,
                           Map<byte[],Long> ttlByFamily,
                           boolean allowEmptyValues,
                           org.apache.hadoop.hbase.regionserver.ScanType scanType,
                           @Nullable
                           org.apache.hadoop.hbase.filter.Filter cellFilter)

Creates a new Filter for returning data only from visible transactions.

Parameters:

tx - the current transaction to apply. Only data visible to this transaction will be returned.

ttlByFamily - map of time-to-live (TTL) (in milliseconds) by column family name

allowEmptyValues - if true cells with empty byte[] values will be returned, if false these will be interpreted as "delete" markers and the column will be filtered out

scanType - the type of scan operation being performed

cellFilter - if non-null, this filter will be applied to all cells visible to the current transaction, by calling Filter.filterKeyValue(org.apache.hadoop.hbase.Cell). If null, then Filter.ReturnCode#INCLUDE_AND_NEXT_COL will be returned instead.

Method Detail

filterKeyValue

public org.apache.hadoop.hbase.filter.Filter.ReturnCode filterKeyValue(org.apache.hadoop.hbase.Cell cell)
                                                                throws IOException

Specified by:

filterKeyValue in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

reset

public void reset()

Overrides:

reset in class org.apache.hadoop.hbase.filter.FilterBase

toByteArray

public byte[] toByteArray()
                   throws IOException

Overrides:

toByteArray in class org.apache.hadoop.hbase.filter.FilterBase

Throws:

IOException