[HBASE-7115] [shell] Provide a way to register custom filters with the Filter Language Parser

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Abandoned
• Affects Version/s: 0.95.2
• Component/s: Filters, shell
• Assignee: Unassigned
• Reporter: Aditya Kishore
• Created: 07/Nov/12 21:18
• Updated: 15/Jun/22 00:17
• Resolved: 14/Jun/22 22:36

Description

HBASE-5428 added this capability to thrift interface but the configuration parameter name is "thrift" specific.

This patch introduces a more generic parameter "hbase.user.filters" using which the user defined custom filters can be specified in the configuration and loaded in any client that needs to use the filter language parser.

The patch then uses this new parameter to register any user specified filters while invoking the HBase shell.

Example usage: Let's say I have written a couple of custom filters with class names org.apache.hadoop.hbase.filter.custom.SuperDuperFilter and org.apache.hadoop.hbase.filter.custom.SilverBulletFilter and I want to use them from HBase shell using the filter language.

To do that, I would add the following configuration to hbase-site.xml

<property>
  <name>hbase.user.filters</name>
  <value>SuperDuperFilter:org.apache.hadoop.hbase.filter.custom.SuperDuperFilter,SilverBulletFilter:org.apache.hadoop.hbase.filter.custom.SilverBulletFilter</value>
</property>

Once this is configured, I can launch HBase shell and use these filters in my get or scan just the way I would use a built-in filter.

hbase(main):001:0> scan 't', {FILTER => "SuperDuperFilter(true) AND SilverBulletFilter(42)"}
ROW                                                          COLUMN+CELL
 status                                                      column=cf:a, timestamp=304385520000, value=world_peace
1 row(s) in 0.0000 seconds

To use this feature in any client, the client needs to make the following function call as part of its initialization.

ParseFilter.registerUserFilters(configuration);

Issue Links

• is related to: HBASE-5428 Allow for custom filters to be registered within the Thrift interface