-
KeyOnlyFilter
Description: This filter doesn’t take any arguments. It returns only the key component of each key-value.
Syntax: KeyOnlyFilter ()
Example: "KeyOnlyFilter ()"
-
FirstKeyOnlyFilter
Description: This filter doesn’t take any arguments. It returns only the first key-value from each row.
Syntax: FirstKeyOnlyFilter ()
Example: "FirstKeyOnlyFilter ()"
-
PrefixFilter
Description: This filter takes one argument – a prefix of a row key. It returns only those key-values present in a row that starts with the specified row prefix
Syntax: PrefixFilter (‘’)
Example: "PrefixFilter (‘Row’)"
-
ColumnPrefixFilter
Description: This filter takes one argument – a column prefix. It returns only those key-values present in a column that starts with the specified column prefix. The column prefix must be of the form: “qualifier”
Syntax:ColumnPrefixFilter(‘’)
Example: "ColumnPrefixFilter(‘Col’)"
-
MultipleColumnPrefixFilter
Description: This filter takes a list of column prefixes. It returns key-values that are present in a column that starts with any of the specified column prefixes. Each of the column prefixes must be of the form: “qualifier”
Syntax:MultipleColumnPrefixFilter(‘’, ‘’, …, ‘’)
Example: "MultipleColumnPrefixFilter(‘Col1’, ‘Col2’)"
-
ColumnCountGetFilter
Description: This filter takes one argument – a limit. It returns the first limit number of columns in the table
Syntax: ColumnCountGetFilter (‘’)
Example: "ColumnCountGetFilter (4)"
-
PageFilter
Description: This filter takes one argument – a page size. It returns page size number of rows from the table.
Syntax: PageFilter (‘’)
Example: "PageFilter (2)"
-
ColumnPaginationFilter
Description: This filter takes two arguments – a limit and offset. It returns limit number of columns after offset number of columns. It does this for all the rows
Syntax: ColumnPaginationFilter(‘’, ‘’)
Example: "ColumnPaginationFilter (3, 5)"
-
InclusiveStopFilter
Description: This filter takes one argument – a row key on which to stop scanning. It returns all key-values present in rows up to and including the specified row
Syntax: InclusiveStopFilter(‘’)
Example: "InclusiveStopFilter ('Row2')"
-
TimeStampsFilter
Description: This filter takes a list of timestamps. It returns those key-values whose timestamps matches any of the specified timestamps
Syntax: TimeStampsFilter (, , ... ,)
Example: "TimeStampsFilter (5985489, 48895495, 58489845945)"
-
RowFilter
Description: This filter takes a compare operator and a comparator. It compares each row key with the comparator using the compare operator and if the comparison returns true, it returns all the key-values in that row
Syntax: RowFilter (, ‘’)
Example: "RowFilter (<=, ‘xyz)"
-
Family Filter
Description: This filter takes a compare operator and a comparator. It compares each qualifier name with the comparator using the compare operator and if the comparison returns true, it returns all the key-values in that column
Syntax: QualifierFilter (, ‘’)
Example: "QualifierFilter (=, ‘Column1’)"
-
QualifierFilter
Description: This filter takes a compare operator and a comparator. It compares each qualifier name with the comparator using the compare operator and if the comparison returns true, it returns all the key-values in that column
Syntax: QualifierFilter (,‘’)
Example: "QualifierFilter (=,‘Column1’)"
-
ValueFilter
Description: This filter takes a compare operator and a comparator. It compares each value with the comparator using the compare operator and if the comparison returns true, it returns that key-value
Syntax: ValueFilter (,‘’)
Example: "ValueFilter (!=, ‘Value’)"
-
DependentColumnFilter
Description: This filter takes two arguments – a family and a qualifier. It tries to locate this column in each row and returns all key-values in that row that have the same timestamp. If the row doesn’t contain the specified column – none of the key-values in that row will be returned.
The filter can also take an optional boolean argument – dropDependentColumn. If set to true, the column we were depending on doesn’t get returned.
The filter can also take two more additional optional arguments – a compare operator and a value comparator, which are further checks in addition to the family and qualifier. If the dependent column is found, its value should also pass the value check and then only is its timestamp taken into consideration
Syntax: DependentColumnFilter (‘’, ‘’, , , ‘
Syntax: DependentColumnFilter (‘’, ‘’, )
Syntax: DependentColumnFilter (‘’, ‘’)
Example: "DependentColumnFilter (‘conf’, ‘blacklist’, false, >=, ‘zebra’)"
Example: "DependentColumnFilter (‘conf’, 'blacklist', true)"
Example: "DependentColumnFilter (‘conf’, 'blacklist')"
-
SingleColumnValueFilter
Description: This filter takes a column family, a qualifier, a compare operator and a comparator. If the specified column is not found – all the columns of that row will be emitted. If the column is found and the comparison with the comparator returns true, all the columns of the row will be emitted. If the condition fails, the row will not be emitted.
This filter also takes two additional optional boolean arguments – filterIfColumnMissing and setLatestVersionOnly
If the filterIfColumnMissing flag is set to true the columns of the row will not be emitted if the specified column to check is not found in the row. The default value is false.
If the setLatestVersionOnly flag is set to false, it will test previous versions (timestamps) too. The default value is true.
These flags are optional and if you must set neither or both
Syntax: SingleColumnValueFilter(, ‘’, ‘’, ‘’,, )
Syntax: SingleColumnValueFilter(, ‘’, ‘’, ‘)
Example: "SingleColumnValueFilter (<=, ‘abc’,‘FamilyA’, ‘Column1’, true, false)"
Example: "SingleColumnValueFilter (<=, ‘abc’,‘FamilyA’, ‘Column1’)"
-
SingleColumnValueExcludeFilter
Description: This filter takes the same arguments and behaves same as SingleColumnValueFilter – however, if the column is found and the condition passes, all the columns of the row will be emitted except for the tested column value.
Syntax: SingleColumnValueExcludeFilter(, '', '', '',, )
Syntax: SingleColumnValueExcludeFilter(, '', '', '')
Example: "SingleColumnValueExcludeFilter (‘<=’, ‘abc’,‘FamilyA’, ‘Column1’, ‘false’, ‘true’)"
Example: "SingleColumnValueExcludeFilter (‘<=’, ‘abc’, ‘FamilyA’, ‘Column1’)"
-
ColumnRangeFilter
Description: This filter is used for selecting only those keys with columns that are between minColumn and maxColumn. It also takes two boolean variables to indicate whether to include the minColumn and maxColumn or not.
If you don’t want to set the minColumn or the maxColumn – you can pass in an empty argument.
Syntax: ColumnRangeFilter (‘’, , ‘’, )
Example: "ColumnRangeFilter (‘abc’, true, ‘xyz’, false)"