Description and usage of DeleteHBaseCells processor:
This processor allows the user to delete individual HBase cells by specifying one or more lines in the flowfile content that are a sequence composed of row ID, column family, column qualifier and associated visibility labels if visibility labels are enabled and in use. A user-defined separator is used to separate each of these pieces of data on each line, with :::: being the default separator.
Tags:
hbase, delete, cell, cells, visibility
Properties:
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the Expression Language Guide.
Name |
Default Value |
Allowable Values |
Description |
HBase Client Service |
Controller Service API: HBaseClientService Implementations: HBase_1_1_2_ClientService HBase_2_ClientService |
Specifies the Controller Service to use for accessing HBase. | |
Table Name |
The name of the HBase Table. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
||
Separator |
:::: |
Each line of the flowfile content is separated into components for building a delete using this separator. It should be something other than a single colon or a comma because these are values that are associated with columns and visibility labels respectively. To delete a row with ID xyz, column family abc, column qualifier def and visibility label PII&PHI, one would specify xyz::::abc::::def::::PII&PHI given the default value Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Relationships:
Name |
Description |
success | A FlowFile is routed to this relationship after it has been successfully stored in HBase |
failure | A FlowFile is routed to this relationship if it cannot be sent to HBase |
Reads Attributes:
None specified.
Writes Attributes:
Name |
Description |
error.line | The line number of the error. |
error.msg | The message explaining the error. |
State management:
This component does not store state.
Restricted:
This component is not restricted.
Input requirement:
This component requires an incoming relationship.
System Resource Considerations:
None specified.
Summary
This processor provides the ability to do deletes against one or more HBase cells, without having to delete the entire row. It should be used as the primary delete method when visibility labels are in use and the cells have different visibility labels. Each line in the flowfile body is a fully qualified cell (row id, column family, column qualifier and visibility labels if applicable). The separator that separates each piece of the fully qualified cell is configurable, but :::: is the default value.
Example FlowFile
row1::::user::::name<br/>
row1::::user::::address::::PII<br/>
row1::::user::::billing_code_1::::PII&&BILLING