Package org.apache.hadoop.hbase.filter
package org.apache.hadoop.hbase.filter
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.
-
ClassDescriptionorg.apache.hadoop.hbase.filter.BigDecimalComparatorA BigDecimal comparator which numerical compares against the specified byte arrayorg.apache.hadoop.hbase.filter.BinaryComparatorA binary comparator which lexicographically compares against the specified byte array using
Bytes.compareTo(byte[], byte[])
.org.apache.hadoop.hbase.filter.BinaryComponentComparatorA comparator which compares against a specified byte array, but only compares specific portion of the byte array.org.apache.hadoop.hbase.filter.BinaryPrefixComparatorA comparator which compares against a specified byte array, but only compares up to the length of this byte array.org.apache.hadoop.hbase.filter.BitComparatorA bit comparator which performs the specified bitwise operation on each of the bytes with the specified byte array.org.apache.hadoop.hbase.filter.BitComparator.BitwiseOpBit operators.org.apache.hadoop.hbase.filter.ByteArrayComparableBase class for byte array comparatorsorg.apache.hadoop.hbase.filter.ColumnCountGetFilterSimple filter that returns first N columns on row only.org.apache.hadoop.hbase.filter.ColumnPaginationFilterA filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset.org.apache.hadoop.hbase.filter.ColumnPrefixFilterThis filter is used for selecting only those keys with columns that matches a particular prefix.org.apache.hadoop.hbase.filter.ColumnRangeFilterThis filter is used for selecting only those keys with columns that are between minColumn to maxColumn.org.apache.hadoop.hbase.filter.ColumnValueFilterDifferent fromSingleColumnValueFilter
which returns an entire row when specified condition is matched,ColumnValueFilter
return the matched cell only.org.apache.hadoop.hbase.filter.CompareFilterThis is a generic filter to be used to filter by comparison.org.apache.hadoop.hbase.filter.CompareFilter.CompareOpDeprecated.since 2.0.0.org.apache.hadoop.hbase.filter.DependentColumnFilterA 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 filteringorg.apache.hadoop.hbase.filter.FamilyFilterThis filter is used to filter based on the column family.org.apache.hadoop.hbase.filter.FilterInterface for row and column filters directly applied within the regionserver.org.apache.hadoop.hbase.filter.Filter.ReturnCodeReturn codes for filterValue().org.apache.hadoop.hbase.filter.FilterBaseAbstract base class to help you implement new Filters.org.apache.hadoop.hbase.filter.FilterListImplementation ofFilter
that represents an ordered List of Filters which will be evaluated with a specified boolean operatorFilterList.Operator.MUST_PASS_ALL
(AND
) orFilterList.Operator.MUST_PASS_ONE
(OR
).org.apache.hadoop.hbase.filter.FilterList.Operatorset operatororg.apache.hadoop.hbase.filter.FilterListBaseBase class for FilterList.org.apache.hadoop.hbase.filter.FilterListWithANDFilterListWithAND represents an ordered list of filters which will be evaluated with an AND operator.org.apache.hadoop.hbase.filter.FilterListWithORFilterListWithOR represents an ordered list of filters which will be evaluated with an OR operator.org.apache.hadoop.hbase.filter.FilterWrapperThis is a Filter wrapper class which is used in the server side.org.apache.hadoop.hbase.filter.FilterWrapper.FilterRowRetCodeorg.apache.hadoop.hbase.filter.FirstKeyOnlyFilterA filter that will only return the first KV from each row.org.apache.hadoop.hbase.filter.FirstKeyValueMatchingQualifiersFilterDeprecated.Deprecated in 2.0.0 and will be removed in 3.0.0.org.apache.hadoop.hbase.filter.FuzzyRowFilterThis is optimized version of a standard FuzzyRowFilter Filters data based on fuzzy row key.org.apache.hadoop.hbase.filter.InclusiveStopFilterA Filter that stops after the given row.org.apache.hadoop.hbase.filter.IncompatibleFilterExceptionUsed to indicate a filter incompatibilityorg.apache.hadoop.hbase.filter.InvalidRowFilterExceptionUsed to indicate an invalid RowFilter.org.apache.hadoop.hbase.filter.KeyOnlyFilterA filter that will only return the key component of each KV (the value will be rewritten as empty).org.apache.hadoop.hbase.filter.LongComparatorA long comparator which numerical compares against the specified byte arrayorg.apache.hadoop.hbase.filter.MultipleColumnPrefixFilterThis filter is used for selecting only those keys with columns that matches a particular prefix.org.apache.hadoop.hbase.filter.MultiRowRangeFilterFilter to support scan multiple row key ranges.org.apache.hadoop.hbase.filter.MultiRowRangeFilter.RowRangeorg.apache.hadoop.hbase.filter.NullComparatorA binary comparator which lexicographically compares against the specified byte array usingBytes.compareTo(byte[], byte[])
.org.apache.hadoop.hbase.filter.PageFilterImplementation of Filter interface that limits results to a specific page size.org.apache.hadoop.hbase.filter.ParseConstantsParseConstants holds a bunch of constants related to parsing Filter Strings Used byParseFilter
org.apache.hadoop.hbase.filter.ParseFilterThis class allows a user to specify a filter via a string The string is parsed using the methods of this class and a filter object is constructed.org.apache.hadoop.hbase.filter.PrefixFilterPass results that have same row prefix.org.apache.hadoop.hbase.filter.QualifierFilterThis filter is used to filter based on the column qualifier.org.apache.hadoop.hbase.filter.RandomRowFilterA filter that includes rows based on a chance.org.apache.hadoop.hbase.filter.RegexStringComparatorThis comparator is for use withCompareFilter
implementations, such asRowFilter
,QualifierFilter
, andValueFilter
, for filtering based on the value of a given column.org.apache.hadoop.hbase.filter.RegexStringComparator.EngineTypeEngine implementation type (default=JAVA)org.apache.hadoop.hbase.filter.RowFilterThis filter is used to filter based on the key.org.apache.hadoop.hbase.filter.SingleColumnValueExcludeFilterAFilter
that checks a single column value, but does not emit the tested column.org.apache.hadoop.hbase.filter.SingleColumnValueFilterThis filter is used to filter cells based on value.org.apache.hadoop.hbase.filter.SkipFilterA wrapper filter that filters an entire row if any of the Cell checks do not pass.org.apache.hadoop.hbase.filter.SubstringComparatorThis comparator is for use with SingleColumnValueFilter, for filtering based on the value of a given column.org.apache.hadoop.hbase.filter.TimestampsFilterFilter that returns only cells whose timestamp (version) is in the specified list of timestamps (versions).org.apache.hadoop.hbase.filter.ValueFilterThis filter is used to filter based on column value.org.apache.hadoop.hbase.filter.WhileMatchFilterA wrapper filter that returns true fromWhileMatchFilter.filterAllRemaining()
as soon as the wrapped filtersFilter.filterRowKey(byte[], int, int)
,Filter.filterCell(org.apache.hadoop.hbase.Cell)
,Filter.filterRow()
orFilter.filterAllRemaining()
methods returns true.