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.
-
ClassDescriptionA BigDecimal comparator which numerical compares against the specified byte arrayA binary comparator which lexicographically compares against the specified byte array using
Bytes.compareTo(byte[], byte[])
.A comparator which compares against a specified byte array, but only compares specific portion of the byte array.A comparator which compares against a specified byte array, but only compares up to the length of this byte array.A bit comparator which performs the specified bitwise operation on each of the bytes with the specified byte array.Bit operators.Base class for byte array comparatorsSimple filter that returns first N columns on row only.A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset.This filter is used for selecting only those keys with columns that matches a particular prefix.This filter is used for selecting only those keys with columns that are between minColumn to maxColumn.Different fromSingleColumnValueFilter
which returns an entire row when specified condition is matched,ColumnValueFilter
return the matched cell only.This is a generic filter to be used to filter by comparison.Deprecated.since 2.0.0.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 filteringThis filter is used to filter based on the column family.Interface for row and column filters directly applied within the regionserver.Return codes for filterValue().Abstract base class to help you implement new Filters.Implementation 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
).set operatorBase class for FilterList.FilterListWithAND represents an ordered list of filters which will be evaluated with an AND operator.FilterListWithOR represents an ordered list of filters which will be evaluated with an OR operator.This is a Filter wrapper class which is used in the server side.A filter that will only return the first KV from each row.Deprecated.Deprecated in 2.0.0 and will be removed in 3.0.0.This is optimized version of a standard FuzzyRowFilter Filters data based on fuzzy row key.Abstracts directional comparisons based on scan direction.A Filter that stops after the given row.Used to indicate a filter incompatibilityUsed to indicate an invalid RowFilter.A filter that will only return the key component of each KV (the value will be rewritten as empty).A long comparator which numerical compares against the specified byte arrayThis filter is used for selecting only those keys with columns that matches a particular prefix.Filter to support scan multiple row key ranges.Abstraction over the ranges of rows to return from this filter, regardless of forward or reverse scans being used.Internal RowRange that reverses the sort-order to handle reverse scans.A binary comparator which lexicographically compares against the specified byte array usingBytes.compareTo(byte[], byte[])
.Implementation of Filter interface that limits results to a specific page size.ParseConstants holds a bunch of constants related to parsing Filter Strings Used byParseFilter
This 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.Pass results that have same row prefix.This filter is used to filter based on the column qualifier.A filter that includes rows based on a chance.This comparator is for use withCompareFilter
implementations, such asRowFilter
,QualifierFilter
, andValueFilter
, for filtering based on the value of a given column.This is an internal interface for abstracting access to different regular expression matching engines.Engine implementation type (default=JAVA)Implementation of the Engine interface using Java's Pattern.Implementation of the Engine interface using Jruby's joni regex engine.This filter is used to filter based on the key.AFilter
that checks a single column value, but does not emit the tested column.This filter is used to filter cells based on value.A wrapper filter that filters an entire row if any of the Cell checks do not pass.This comparator is for use with SingleColumnValueFilter, for filtering based on the value of a given column.Filter that returns only cells whose timestamp (version) is in the specified list of timestamps (versions).This filter is used to filter based on column value.A 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.