Package org.apache.hadoop.hbase.filter

Provides row-level filters applied to HRegion scan results during calls to ResultScanner.next().

See:
          Description

Interface Summary
Filter Interface for row and column filters directly applied within the regionserver.
 

Class Summary
BinaryComparator A binary comparator which lexicographically compares against the specified byte array using Bytes.compareTo(byte[], byte[]).
BinaryPrefixComparator A comparator which compares against a specified byte array, but only compares up to the length of this byte array.
ColumnCountGetFilter Simple filter that returns first N columns on row only.
ColumnPaginationFilter A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset.
ColumnPrefixFilter This filter is used for selecting only those keys with columns that matches a particular prefix.
CompareFilter This is a generic filter to be used to filter by comparison.
DependentColumnFilter A filter for adding inter-column timestamp matching Only cells with a correspondingly timestamped entry in the target column will be retained Not compatible with Scan.setBatch as operations need full rows for correct filtering
FamilyFilter This filter is used to filter based on the column family.
FilterBase Abstract base class to help you implement new Filters.
FilterList Implementation of Filter that represents an ordered List of Filters which will be evaluated with a specified boolean operator FilterList.Operator.MUST_PASS_ALL (!AND) or FilterList.Operator.MUST_PASS_ONE (!OR).
FirstKeyOnlyFilter A filter that will only return the first KV from each row.
InclusiveStopFilter A Filter that stops after the given row.
KeyOnlyFilter A filter that will only return the key component of each KV (the value will be rewritten as empty).
PageFilter Implementation of Filter interface that limits results to a specific page size.
PrefixFilter Pass results that have same row prefix.
QualifierFilter This filter is used to filter based on the column qualifier.
RegexStringComparator This comparator is for use with CompareFilter implementations, such as RowFilter, QualifierFilter, and ValueFilter, for filtering based on the value of a given column.
RowFilter This filter is used to filter based on the key.
SingleColumnValueExcludeFilter A Filter that checks a single column value, but does not emit the tested column.
SingleColumnValueFilter This filter is used to filter cells based on value.
SkipFilter A wrapper filter that filters an entire row if any of the KeyValue checks do not pass.
SubstringComparator This comparator is for use with ColumnValueFilter, for filtering based on the value of a given column.
TimestampsFilter Filter that returns only cells whose timestamp (version) is in the specified list of timestamps (versions).
ValueFilter This filter is used to filter based on column value.
WhileMatchFilter A wrapper filter that returns true from WhileMatchFilter.filterAllRemaining() as soon as the wrapped filters Filter.filterRowKey(byte[], int, int), Filter.filterKeyValue(org.apache.hadoop.hbase.KeyValue), Filter.filterRow() or Filter.filterAllRemaining() methods returns true.
WritableByteArrayComparable Base class, combines Comparable and Writable.
 

Enum Summary
CompareFilter.CompareOp Comparison operators.
Filter.ReturnCode Return codes for filterValue().
FilterList.Operator set operator
 

Exception Summary
IncompatibleFilterException Used to indicate a filter incompatibility
InvalidRowFilterException Used to indicate an invalid RowFilter.
 

Package org.apache.hadoop.hbase.filter Description

Provides row-level filters applied to HRegion scan results during calls to ResultScanner.next().

Filters run the extent of a table unless you wrap your filter in a WhileMatchFilter. The latter returns as soon as the filter stops matching.

Do not rely on filters carrying state across rows; its not reliable in current hbase as we have no handlers in place for when regions split, close or server crashes.



Copyright © 2011 The Apache Software Foundation. All Rights Reserved.