http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html b/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html index fbf7f4d..1f9ef0b 100644 --- a/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html +++ b/apidocs/org/apache/hadoop/hbase/client/RawScanResultConsumer.html @@ -170,8 +170,8 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client <tr id="i2" class="altColor"> <td class="colFirst"><code>default void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onHeartbeat-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-">onHeartbeat</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a> controller)</code> -<div class="block">Indicate that there is an heartbeat message but we have not cumulated enough cells to call - onNext.</div> +<div class="block">Indicate that there is a heartbeat message but we have not cumulated enough cells to call + <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a>.</div> </td> </tr> <tr id="i3" class="rowColor"> @@ -228,9 +228,16 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client <ul class="blockList"> <li class="blockList"> <h4>onHeartbeat</h4> -<pre>default void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.106">onHeartbeat</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a> controller)</pre> -<div class="block">Indicate that there is an heartbeat message but we have not cumulated enough cells to call - onNext. +<pre>default void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.113">onHeartbeat</a>(<a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a> controller)</pre> +<div class="block">Indicate that there is a heartbeat message but we have not cumulated enough cells to call + <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a>. + <p> + Note that this method will always be called when RS returns something to us but we do not have + enough cells to call <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"><code>onNext(Result[], ScanController)</code></a>. Sometimes it may not be a + 'heartbeat' message for RS, for example, we have a large row with many cells and size limit is + exceeded before sending all the cells for this row. For RS it does send some data to us and the + time limit has not been reached, but we can not return the data to client so here we call this + method to tell client we have already received something. <p> This method give you a chance to terminate a slow scan operation.</div> <dl> @@ -247,7 +254,7 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client <ul class="blockList"> <li class="blockList"> <h4>onError</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.114">onError</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> error)</pre> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.121">onError</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> error)</pre> <div class="block">Indicate that we hit an unrecoverable error and the scan operation is terminated. <p> We will not call <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onComplete--"><code>onComplete()</code></a> after calling <a href="../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onError-java.lang.Throwable-"><code>onError(Throwable)</code></a>.</div> @@ -259,7 +266,7 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client <ul class="blockList"> <li class="blockList"> <h4>onComplete</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.119">onComplete</a>()</pre> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.126">onComplete</a>()</pre> <div class="block">Indicate that the scan operation is completed normally.</div> </li> </ul> @@ -269,7 +276,7 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client <ul class="blockListLast"> <li class="blockList"> <h4>onScanMetricsCreated</h4> -<pre>default void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.127">onScanMetricsCreated</a>(org.apache.hadoop.hbase.client.metrics.ScanMetrics scanMetrics)</pre> +<pre>default void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html#line.134">onScanMetricsCreated</a>(org.apache.hadoop.hbase.client.metrics.ScanMetrics scanMetrics)</pre> <div class="block">If <code>scan.isScanMetricsEnabled()</code> returns true, then this method will be called prior to all other methods in this interface to give you the <code>ScanMetrics</code> instance for this scan operation. The <code>ScanMetrics</code> instance will be updated on-the-fly during the scan, you can
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/apidocs/org/apache/hadoop/hbase/client/class-use/RawScanResultConsumer.ScanController.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/class-use/RawScanResultConsumer.ScanController.html b/apidocs/org/apache/hadoop/hbase/client/class-use/RawScanResultConsumer.ScanController.html index 939469e..f5d80c8 100644 --- a/apidocs/org/apache/hadoop/hbase/client/class-use/RawScanResultConsumer.ScanController.html +++ b/apidocs/org/apache/hadoop/hbase/client/class-use/RawScanResultConsumer.ScanController.html @@ -107,8 +107,8 @@ <tr class="altColor"> <td class="colFirst"><code>default void</code></td> <td class="colLast"><span class="typeNameLabel">RawScanResultConsumer.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onHeartbeat-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-">onHeartbeat</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanController.html" title="interface in org.apache.hadoop.hbase.client">RawScanResultConsumer.ScanController</a> controller)</code> -<div class="block">Indicate that there is an heartbeat message but we have not cumulated enough cells to call - onNext.</div> +<div class="block">Indicate that there is a heartbeat message but we have not cumulated enough cells to call + <a href="../../../../../../org/apache/hadoop/hbase/client/RawScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result:A-org.apache.hadoop.hbase.client.RawScanResultConsumer.ScanController-"><code>RawScanResultConsumer.onNext(Result[], ScanController)</code></a>.</div> </td> </tr> <tr class="rowColor"> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/apidocs/org/apache/hadoop/hbase/client/class-use/TableDescriptor.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/class-use/TableDescriptor.html b/apidocs/org/apache/hadoop/hbase/client/class-use/TableDescriptor.html index cba3174..fbce224 100644 --- a/apidocs/org/apache/hadoop/hbase/client/class-use/TableDescriptor.html +++ b/apidocs/org/apache/hadoop/hbase/client/class-use/TableDescriptor.html @@ -124,7 +124,7 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></span></code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">As of release 2.0.0, this will be removed in HBase 3.0.0. - use <a href="../../../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><code>TableDescriptorBuilder</code></a> to build <a href="../../../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HTableDescriptor</code></a>.</span></div> + Use <a href="../../../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><code>TableDescriptorBuilder</code></a> to build <a href="../../../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HTableDescriptor</code></a>.</span></div> </div> </td> </tr> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/apidocs/org/apache/hadoop/hbase/package-use.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/package-use.html b/apidocs/org/apache/hadoop/hbase/package-use.html index 956b47c..500c87b 100644 --- a/apidocs/org/apache/hadoop/hbase/package-use.html +++ b/apidocs/org/apache/hadoop/hbase/package-use.html @@ -212,7 +212,7 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <td class="colOne"><a href="../../../../org/apache/hadoop/hbase/class-use/HTableDescriptor.html#org.apache.hadoop.hbase">HTableDescriptor</a> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">As of release 2.0.0, this will be removed in HBase 3.0.0. - use <a href="../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><code>TableDescriptorBuilder</code></a> to build <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HTableDescriptor</code></a>.</span></div> + Use <a href="../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><code>TableDescriptorBuilder</code></a> to build <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HTableDescriptor</code></a>.</span></div> </div> </td> </tr> @@ -330,7 +330,7 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <td class="colOne"><a href="../../../../org/apache/hadoop/hbase/class-use/HTableDescriptor.html#org.apache.hadoop.hbase.client">HTableDescriptor</a> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">As of release 2.0.0, this will be removed in HBase 3.0.0. - use <a href="../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><code>TableDescriptorBuilder</code></a> to build <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HTableDescriptor</code></a>.</span></div> + Use <a href="../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><code>TableDescriptorBuilder</code></a> to build <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HTableDescriptor</code></a>.</span></div> </div> </td> </tr> @@ -628,7 +628,7 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <td class="colOne"><a href="../../../../org/apache/hadoop/hbase/class-use/HTableDescriptor.html#org.apache.hadoop.hbase.rest.client">HTableDescriptor</a> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">As of release 2.0.0, this will be removed in HBase 3.0.0. - use <a href="../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><code>TableDescriptorBuilder</code></a> to build <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HTableDescriptor</code></a>.</span></div> + Use <a href="../../../../org/apache/hadoop/hbase/client/TableDescriptorBuilder.html" title="class in org.apache.hadoop.hbase.client"><code>TableDescriptorBuilder</code></a> to build <a href="../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase"><code>HTableDescriptor</code></a>.</span></div> </div> </td> </tr>
