<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScanHBase</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;">ScanHBase</h1><h2>Description: </h2><p>Scans and fetches rows from an HBase table. This processor may be used to fetch rows from hbase table by specifying a range of rowkey values (start and/or end ),by time range, by filter expression, or any combination of them. Order of records can be controlled by a property ReversedNumber of rows retrieved by the processor can be limited.</p><h3>Tags: </h3><p>hbase, scan, fetch, get</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>scanhbase-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>scanhbase-table-name</td><td></td><td id="allowable-values"></td><td id="description">The name of the HBase Table to fetch from.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Authorizations</td><td>hbase-fetch-row-authorizations</td><td></td><td id="allowable-values"></td><td id="description">The list of authorizations to pass to the scanner. This will be ignored if cell visibility labels are not in use.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Start rowkey</td><td>scanhbase-start-rowkey</td><td></td><td id="allowable-values"></td><td id="description">The rowkey to start scan from.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">End rowkey</td><td>scanhbase-end-rowkey</td><td></td><td id="allowable-values"></td><td id="description">The row key to end scan by.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Time range min</td><td>scanhbase-time-range-min</td><td></td><td id="allowable-values"></td><td id="description">Time range min value. Both min and max values for time range should be either blank or provided.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Time range max</td><td>scanhbase-time-range-max</td><td></td><td id="allowable-values"></td><td id="description">Time range max value. Both min and max values for time range should be either blank or provided.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Limit rows</td><td>scanhbase-limit</td><td></td><td id="allowable-values"></td><td id="description">Limit number of rows retrieved by scan.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Reversed order</td><td>scanhbase-reversed-order</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Set whether this scan is a reversed one. This is false by default which means forward(normal) scan.</td></tr><tr><td id="name">Max rows per flow file</td><td>scanhbase-bulk-size</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Limits number of rows in single flow file content. Set to 0 to avoid multiple flow files.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Filter expression</td><td>scanhbase-filter-expression</td><td></td><td id="allowable-values"></td><td id="description">An HBase filter expression that will be applied to the scan. This property can not be used when also using the Columns property. Example: "ValueFilter( =, 'binaryprefix:commit' )"<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Columns</td><td>scanhbase-columns</td><td></td><td id="allowable-values"></td><td id="description">An optional comma-separated list of "&lt;colFamily&gt;:&lt;colQualifier&gt;" pairs to fetch. To return all columns for a given family, leave off the qualifier such as "&lt;colFamily1&gt;,&lt;colFamily2&gt;".<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>JSON Format</strong></td><td>scanhbase-json-format</td><td id="default-value">full-row</td><td id="allowable-values"><ul><li>full-row <img src="../../../../../html/images/iconInfo.png" alt="Creates a JSON document with the format: {&quot;row&quot;:&lt;row-id&gt;, &quot;cells&quot;:[{&quot;fam&quot;:&lt;col-fam&gt;, &quot;qual&quot;:&lt;col-val&gt;, &quot;val&quot;:&lt;value&gt;, &quot;ts&quot;:&lt;timestamp&gt;}]}." title="Creates a JSON document with the format: {&quot;row&quot;:&lt;row-id&gt;, &quot;cells&quot;:[{&quot;fam&quot;:&lt;col-fam&gt;, &quot;qual&quot;:&lt;col-val&gt;, &quot;val&quot;:&lt;value&gt;, &quot;ts&quot;:&lt;timestamp&gt;}]}."></img></li><li>col-qual-and-val <img src="../../../../../html/images/iconInfo.png" alt="Creates a JSON document with the format: {&quot;&lt;col-qual&gt;&quot;:&quot;&lt;value&gt;&quot;, &quot;&lt;col-qual&gt;&quot;:&quot;&lt;value&gt;&quot;." title="Creates a JSON document with the format: {&quot;&lt;col-qual&gt;&quot;:&quot;&lt;value&gt;&quot;, &quot;&lt;col-qual&gt;&quot;:&quot;&lt;value&gt;&quot;."></img></li></ul></td><td id="description">Specifies how to represent the HBase row as a JSON document.</td></tr><tr><td id="name"><strong>Encode Character Set</strong></td><td>scanhbase-encode-charset</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The character set used to encode the JSON representation of the row.</td></tr><tr><td id="name"><strong>Decode Character Set</strong></td><td>scanhbase-decode-charset</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The character set used to decode data from HBase.</td></tr><tr><td id="name"><strong>Block Cache</strong></td><td>block-cache</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">The Block Cache to enable/disable block cache on HBase scan.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All successful fetches are routed to this relationship.</td></tr><tr><td>failure</td><td>All failed fetches are routed to this relationship.</td></tr><tr><td>original</td><td>The original input file will be routed to this destination, even if no rows are retrieved based on provided conditions.</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>hbase.table</td><td>The name of the HBase table that the row was fetched from</td></tr><tr><td>mime.type</td><td>Set to application/json when using a Destination of flowfile-content, not set or modified otherwise</td></tr><tr><td>hbase.rows.count</td><td>Number of rows in the content of given flow file</td></tr><tr><td>scanhbase.results.found</td><td>Indicates whether at least one row has been found in given hbase table with provided conditions. Could be null (not present) if transfered to FAILURE</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>