org.apache.tephra.hbase.coprocessor

Class TransactionVisibilityFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.tephra.hbase.coprocessor.TransactionVisibilityFilter

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

Applies filtering of data based on transactional visibility (HBase 1.1+ 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
protected org.apache.hadoop.hbase.filter.Filter.ReturnCode	determineReturnCode(org.apache.hadoop.hbase.filter.Filter.ReturnCode txFilterCode, org.apache.hadoop.hbase.filter.Filter.ReturnCode subFilterCode) Determines the return code of TransactionVisibilityFilter based on sub-filter's return code.
boolean	filterAllRemaining()
org.apache.hadoop.hbase.filter.Filter.ReturnCode	filterKeyValue(org.apache.hadoop.hbase.Cell cell)
boolean	filterRow()
void	filterRowCells(List<org.apache.hadoop.hbase.Cell> kvs)
boolean	filterRowKey(byte[] buffer, int offset, int length)
org.apache.hadoop.hbase.Cell	getNextCellHint(org.apache.hadoop.hbase.Cell currentKV)
org.apache.hadoop.hbase.KeyValue	getNextKeyHint(org.apache.hadoop.hbase.KeyValue currentKV)
boolean	hasFilterRow()
boolean	isFamilyEssential(byte[] name)
void	reset()
org.apache.hadoop.hbase.Cell	transformCell(org.apache.hadoop.hbase.Cell cell)

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

createFilterFromArguments, toByteArray, toString, transform

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

determineReturnCode

protected org.apache.hadoop.hbase.filter.Filter.ReturnCode determineReturnCode(org.apache.hadoop.hbase.filter.Filter.ReturnCode txFilterCode,
                                                                   org.apache.hadoop.hbase.filter.Filter.ReturnCode subFilterCode)

Determines the return code of TransactionVisibilityFilter based on sub-filter's return code. Sub-filter can only exclude cells included by TransactionVisibilityFilter, i.e., sub-filter's INCLUDE will be ignored. This behavior makes sure that sub-filter only sees cell versions valid for the given transaction. If sub-filter needs to see older versions of cell, then this method can be overridden.

Parameters:

txFilterCode - return code from TransactionVisibilityFilter

subFilterCode - return code from sub-filter

Returns:

final return code

filterRow

public boolean filterRow()
                  throws IOException

Overrides:

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

Throws:

IOException

transformCell

public org.apache.hadoop.hbase.Cell transformCell(org.apache.hadoop.hbase.Cell cell)
                                           throws IOException

Overrides:

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

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

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

Throws:

IOException

filterRowKey

public boolean filterRowKey(byte[] buffer,
                   int offset,
                   int length)
                     throws IOException

Overrides:

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

Throws:

IOException

filterAllRemaining

public boolean filterAllRemaining()
                           throws IOException

Overrides:

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

Throws:

IOException

filterRowCells

public void filterRowCells(List<org.apache.hadoop.hbase.Cell> kvs)
                    throws IOException

Overrides:

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

Throws:

IOException

hasFilterRow

public boolean hasFilterRow()

Overrides:

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

getNextKeyHint

public org.apache.hadoop.hbase.KeyValue getNextKeyHint(org.apache.hadoop.hbase.KeyValue currentKV)
                                                throws IOException

Overrides:

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

Throws:

IOException

getNextCellHint

public org.apache.hadoop.hbase.Cell getNextCellHint(org.apache.hadoop.hbase.Cell currentKV)
                                             throws IOException

Overrides:

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

Throws:

IOException

isFamilyEssential

public boolean isFamilyEssential(byte[] name)
                          throws IOException

Overrides:

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

Throws:

IOException