| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteHBaseRow</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DeleteHBaseRow</h1><h2>Description: </h2><p>Delete HBase records individually or in batches. The input can be a single row ID in the flowfile content, one ID per line, row IDs separated by a configurable separator character (default is a comma). </p><h3>Tags: </h3><p>delete, hbase</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>HBase Client Service</strong></td><td>HBase Client Service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>HBaseClientService<br/><strong>Implementations: </strong><a href="../../../nifi-hbase_2-client-service-nar/1.19.1/org.apache.nifi.hbase.HBase_2_ClientService/index.html">HBase_2_ClientService</a><br/><a href="../../../nifi-hbase_1_1_2-client-service-nar/1.19.1/org.apache.nifi.hbase.HBase_1_1_2_ClientService/index.html">HBase_1_1_2_ClientService</a></td><td id="description">Specifies the Controller Service to use for accessing HBase.</td></tr><tr><td id="name"><strong>Table Name</strong></td><td>Table Name</td><td></td><td id="allowable-values"></td><td id="description">The name of the HBase Table.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Row Identifier</td><td>Row Identifier</td><td></td><td id="allowable-values"></td><td id="description">Specifies the Row ID to use when deleting data into HBase<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Row ID Location</strong></td><td>delete-hb-row-id-location</td><td id="default-value">FlowFile content</td><td id="allowable-values"><ul><li>FlowFile content <img src="../../../../../html/images/iconInfo.png" alt="Get the row key(s) from the flowfile content." title="Get the row key(s) from the flowfile content."></img></li><li>FlowFile attributes <img src="../../../../../html/images/iconInfo.png" alt="Get the row key from an expression language statement." title="Get the row key from an expression language statement."></img></li></ul></td><td id="description">The location of the row ID to use for building the delete. Can be from the content or an expression language statement.</td></tr><tr><td id="name"><strong>Flowfile Fetch Count</strong></td><td>delete-hb-flowfile-fetch-count</td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">The number of flowfiles to fetch per run.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td>delete-hb-batch-size</td><td id="default-value">50</td><td id="allowable-values"></td><td id="description">The number of deletes to send per batch.</td></tr><tr><td id="name"><strong>Delete Row Key Separator</strong></td><td>delete-hb-separator</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">The separator character(s) that separate multiple row keys when multiple row keys are provided in the flowfile content<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Visibility Label</td><td>delete-visibility-label</td><td></td><td id="allowable-values"></td><td id="description">If visibility labels are enabled, a row cannot be deleted without supplying its visibility label(s) in the delete request. Note: this visibility label will be applied to all cells within the row that is specified. If some cells have different visibility labels, they will not be deleted. When that happens, the failure to delete will be considered a success because HBase does not report it as a failure.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td>delete-char-set</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The character set used to encode the row key for HBase.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship after it has been successfully stored in HBase</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it cannot be sent to HBase</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>restart.index</td><td>If a delete batch fails, 'restart.index' attribute is added to the FlowFile and sent to 'failure' relationship, so that this processor can retry from there when the same FlowFile is routed again.</td></tr><tr><td>rowkey.start</td><td>The first rowkey in the flowfile. Only written when using the flowfile's content for the row IDs.</td></tr><tr><td>rowkey.end</td><td>The last rowkey in the flowfile. Only written when using the flowfile's content for the row IDs.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |