You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by mi...@apache.org on 2017/03/21 16:36:34 UTC
[38/52] [partial] hbase-site git commit: Published site at
1cfd22bf43c9b64afae35d9bf16f764d0da80cab.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/22cff34f/apidocs/org/apache/hadoop/hbase/client/Scan.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/client/Scan.html b/apidocs/org/apache/hadoop/hbase/client/Scan.html
index 767c23c..a06d3ee 100644
--- a/apidocs/org/apache/hadoop/hbase/client/Scan.html
+++ b/apidocs/org/apache/hadoop/hbase/client/Scan.html
@@ -18,7 +18,7 @@
catch(err) {
}
//-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":42,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":42,"i61":42,"i62":42,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":42,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":42,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":42,"i61":42,"i62":42,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -400,7 +400,13 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.hbase.client.metrics.ScanMetrics</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getScanMetrics--">getScanMetrics</a></span>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getScanMetrics--">getScanMetrics</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#getScanMetrics--"><code>ResultScanner.getScanMetrics()</code></a> instead. And notice that, please do not
+ use this method and <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#getScanMetrics--"><code>ResultScanner.getScanMetrics()</code></a> together, the metrics
+ will be messed up.</span></div>
+</div>
+</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
@@ -472,8 +478,8 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setAllowPartialResults-boolean-">setAllowPartialResults</a></span>(boolean allowPartialResults)</code>
-<div class="block">Setting whether the caller wants to see the partial results that may be returned from the
- server.</div>
+<div class="block">Setting whether the caller wants to see the partial results when server returns
+ less-than-expected cells.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
@@ -496,7 +502,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setBatch-int-">setBatch</a></span>(int batch)</code>
-<div class="block">Set the maximum number of values to return for each call to next().</div>
+<div class="block">Set the maximum number of cells to return for each call to next().</div>
</td>
</tr>
<tr id="i37" class="rowColor">
@@ -816,7 +822,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</h4>
-<pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.156">HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></pre>
+<pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.155">HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></pre>
<div class="block">Parameter name for client scanner sync/async prefetch toggle.
When using async scanner, prefetching data from the server is done at the background.
The parameter currently won't have any effect in the case that the user has set
@@ -833,7 +839,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</h4>
-<pre>public static final boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.162">DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></pre>
+<pre>public static final boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.161">DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></pre>
<div class="block">Default value of <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#HBASE_CLIENT_SCANNER_ASYNC_PREFETCH"><code>HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
@@ -855,7 +861,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/
<ul class="blockList">
<li class="blockList">
<h4>Scan</h4>
-<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.194">Scan</a>()</pre>
+<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.193">Scan</a>()</pre>
<div class="block">Create a Scan operation across all rows.</div>
</li>
</ul>
@@ -866,7 +872,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/
<li class="blockList">
<h4>Scan</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
-public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.200">Scan</a>(byte[] startRow,
+public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.199">Scan</a>(byte[] startRow,
<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <code>new Scan().withStartRow(startRow).setFilter(filter)</code> instead.</span></div>
</li>
@@ -878,7 +884,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<li class="blockList">
<h4>Scan</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
-public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.214">Scan</a>(byte[] startRow)</pre>
+public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.213">Scan</a>(byte[] startRow)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <code>new Scan().withStartRow(startRow)</code> instead.</span></div>
<div class="block">Create a Scan operation starting at the specified row.
<p>
@@ -897,7 +903,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<li class="blockList">
<h4>Scan</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
-public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.225">Scan</a>(byte[] startRow,
+public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.224">Scan</a>(byte[] startRow,
byte[] stopRow)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <code>new Scan().withStartRow(startRow).withStopRow(stopRow)</code> instead.</span></div>
<div class="block">Create a Scan operation for the range of rows specified.</div>
@@ -914,7 +920,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>Scan</h4>
-<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.236">Scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)
+<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.235">Scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a new instance of this class while copying all values.</div>
<dl>
@@ -931,7 +937,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockListLast">
<li class="blockList">
<h4>Scan</h4>
-<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.284">Scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</pre>
+<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.283">Scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</pre>
<div class="block">Builds a scan object with the same specs as get.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -953,7 +959,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>isGetScan</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.310">isGetScan</a>()</pre>
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.309">isGetScan</a>()</pre>
</li>
</ul>
<a name="addFamily-byte:A-">
@@ -962,7 +968,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>addFamily</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.325">addFamily</a>(byte[] family)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.324">addFamily</a>(byte[] family)</pre>
<div class="block">Get all columns from the specified family.
<p>
Overrides previous calls to addColumn for this family.</div>
@@ -980,7 +986,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>addColumn</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.339">addColumn</a>(byte[] family,
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.338">addColumn</a>(byte[] family,
byte[] qualifier)</pre>
<div class="block">Get the column from the specified family with the specified qualifier.
<p>
@@ -1000,7 +1006,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>setTimeRange</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.364">setTimeRange</a>(long minStamp,
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.363">setTimeRange</a>(long minStamp,
long maxStamp)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Set versions of columns only within the specified timestamp range,
@@ -1029,7 +1035,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>setTimeRange</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.373">setTimeRange</a>(<a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a> tr)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.372">setTimeRange</a>(<a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a> tr)</pre>
<div class="block">Set versions of columns only within the specified timestamp range,</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
@@ -1047,7 +1053,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>setTimeStamp</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.387">setTimeStamp</a>(long timestamp)
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.386">setTimeStamp</a>(long timestamp)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Get versions of columns with the specified timestamp. Note, default maximum
versions to return is 1. If your time range spans more than one version
@@ -1072,7 +1078,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>setColumnFamilyTimeRange</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.400">setColumnFamilyTimeRange</a>(byte[] cf,
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.399">setColumnFamilyTimeRange</a>(byte[] cf,
long minStamp,
long maxStamp)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setColumnFamilyTimeRange-byte:A-long-long-">Query</a></code></span></div>
@@ -1099,7 +1105,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<ul class="blockList">
<li class="blockList">
<h4>setColumnFamilyTimeRange</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.405">setColumnFamilyTimeRange</a>(byte[] cf,
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.404">setColumnFamilyTimeRange</a>(byte[] cf,
<a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a> tr)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
@@ -1114,7 +1120,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan
<li class="blockList">
<h4>setStartRow</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
-public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.422">setStartRow</a>(byte[] startRow)</pre>
+public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.421">setStartRow</a>(byte[] startRow)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#withStartRow-byte:A-"><code>withStartRow(byte[])</code></a> instead. This method may change the inclusive of
the stop row to keep compatible with the old behavior.</span></div>
<div class="block">Set the start row of the scan.
@@ -1138,7 +1144,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>withStartRow</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.441">withStartRow</a>(byte[] startRow)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.440">withStartRow</a>(byte[] startRow)</pre>
<div class="block">Set the start row of the scan.
<p>
If the specified row does not exist, the Scanner will start from the next closest row after the
@@ -1160,7 +1166,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>withStartRow</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.456">withStartRow</a>(byte[] startRow,
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.455">withStartRow</a>(byte[] startRow,
boolean inclusive)</pre>
<div class="block">Set the start row of the scan.
<p>
@@ -1185,7 +1191,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<li class="blockList">
<h4>setStopRow</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
-public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.482">setStopRow</a>(byte[] stopRow)</pre>
+public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.481">setStopRow</a>(byte[] stopRow)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#withStartRow-byte:A-"><code>withStartRow(byte[])</code></a> instead. This method may change the inclusive of
the stop row to keep compatible with the old behavior.</span></div>
<div class="block">Set the stop row of the scan.
@@ -1212,7 +1218,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>withStopRow</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.504">withStopRow</a>(byte[] stopRow)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.503">withStopRow</a>(byte[] stopRow)</pre>
<div class="block">Set the stop row of the scan.
<p>
The scan will include rows that are lexicographically less than the provided stopRow.
@@ -1237,7 +1243,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>withStopRow</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.519">withStopRow</a>(byte[] stopRow,
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.518">withStopRow</a>(byte[] stopRow,
boolean inclusive)</pre>
<div class="block">Set the stop row of the scan.
<p>
@@ -1261,7 +1267,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setRowPrefixFilter</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.540">setRowPrefixFilter</a>(byte[] rowPrefix)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.539">setRowPrefixFilter</a>(byte[] rowPrefix)</pre>
<div class="block"><p>Set a filter (using stopRow and startRow) so the result set only contains rows where the
rowKey starts with the specified prefix.</p>
<p>This is a utility method that converts the desired rowPrefix into the appropriate values
@@ -1283,7 +1289,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setMaxVersions</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.597">setMaxVersions</a>()</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.596">setMaxVersions</a>()</pre>
<div class="block">Get all available versions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1297,7 +1303,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setMaxVersions</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.607">setMaxVersions</a>(int maxVersions)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.606">setMaxVersions</a>(int maxVersions)</pre>
<div class="block">Get up to the specified number of versions of each column.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1313,16 +1319,17 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setBatch</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.622">setBatch</a>(int batch)</pre>
-<div class="block">Set the maximum number of values to return for each call to next().
- Callers should be aware that invoking this method with any value
- is equivalent to calling <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setAllowPartialResults-boolean-"><code>setAllowPartialResults(boolean)</code></a>
- with a value of <code>true</code>; partial results may be returned if
- this method is called. Use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setMaxResultSize-long-"><code>setMaxResultSize(long)</code></a>} to
- limit the size of a Scan's Results instead.</div>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.620">setBatch</a>(int batch)</pre>
+<div class="block">Set the maximum number of cells to return for each call to next(). Callers should be aware
+ that this is not equivalent to calling <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setAllowPartialResults-boolean-"><code>setAllowPartialResults(boolean)</code></a>.
+ If you don't allow partial results, the number of cells in each Result must equal to your
+ batch setting unless it is the last Result for current row. So this method is helpful in paging
+ queries. If you just want to prevent OOM at client, use setAllowPartialResults(true) is better.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>batch</code> - the maximum number of values</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/hadoop/hbase/client/Result.html#mayHaveMoreCellsInRow--"><code>Result.mayHaveMoreCellsInRow()</code></a></dd>
</dl>
</li>
</ul>
@@ -1332,7 +1339,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setMaxResultsPerColumnFamily</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.636">setMaxResultsPerColumnFamily</a>(int limit)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.634">setMaxResultsPerColumnFamily</a>(int limit)</pre>
<div class="block">Set the maximum number of values to return per row per Column Family</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1346,7 +1353,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setRowOffsetPerColumnFamily</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.645">setRowOffsetPerColumnFamily</a>(int offset)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.643">setRowOffsetPerColumnFamily</a>(int offset)</pre>
<div class="block">Set offset for the row per Column Family.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1360,7 +1367,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setCaching</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.657">setCaching</a>(int caching)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.655">setCaching</a>(int caching)</pre>
<div class="block">Set the number of rows for caching that will be passed to scanners.
If not set, the Configuration setting <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.HBASE_CLIENT_SCANNER_CACHING</code></a> will
apply.
@@ -1377,7 +1384,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getMaxResultSize</h4>
-<pre>public long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.665">getMaxResultSize</a>()</pre>
+<pre>public long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.663">getMaxResultSize</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum result size in bytes. See <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setMaxResultSize-long-"><code>setMaxResultSize(long)</code></a></dd>
@@ -1390,7 +1397,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setMaxResultSize</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.676">setMaxResultSize</a>(long maxResultSize)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.674">setMaxResultSize</a>(long maxResultSize)</pre>
<div class="block">Set the maximum result size. The default is -1; this means that no specific
maximum result size will be set for this scan, and the global configured
value will be used instead. (Defaults to unlimited).</div>
@@ -1406,10 +1413,10 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setFilter</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.682">setFilter</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.680">setFilter</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setFilter-org.apache.hadoop.hbase.filter.Filter-">Query</a></code></span></div>
<div class="block">Apply the specified server-side filter when performing the Query.
- Only <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> is called AFTER all tests
+ Only <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(org.apache.hadoop.hbase.Cell)</code></a> is called AFTER all tests
for ttl, column match, deletes and max versions have been run.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
@@ -1427,7 +1434,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setFamilyMap</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.692">setFamilyMap</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><byte[],<a href="http://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a><byte[]>> familyMap)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.690">setFamilyMap</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><byte[],<a href="http://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a><byte[]>> familyMap)</pre>
<div class="block">Setting the familyMap</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -1443,7 +1450,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getFamilyMap</h4>
-<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><byte[],<a href="http://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a><byte[]>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.701">getFamilyMap</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><byte[],<a href="http://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a><byte[]>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.699">getFamilyMap</a>()</pre>
<div class="block">Getting the familyMap</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1457,7 +1464,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>numFamilies</h4>
-<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.708">numFamilies</a>()</pre>
+<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.706">numFamilies</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of families in familyMap</dd>
@@ -1470,7 +1477,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>hasFamilies</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.718">hasFamilies</a>()</pre>
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.716">hasFamilies</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if familyMap is non empty, false otherwise</dd>
@@ -1483,7 +1490,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getFamilies</h4>
-<pre>public byte[][] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.725">getFamilies</a>()</pre>
+<pre>public byte[][] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.723">getFamilies</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the keys of the familyMap</dd>
@@ -1496,7 +1503,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getStartRow</h4>
-<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.735">getStartRow</a>()</pre>
+<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.733">getStartRow</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the startrow</dd>
@@ -1509,7 +1516,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>includeStartRow</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.742">includeStartRow</a>()</pre>
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.740">includeStartRow</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if we should include start row when scan</dd>
@@ -1522,7 +1529,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getStopRow</h4>
-<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.749">getStopRow</a>()</pre>
+<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.747">getStopRow</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the stoprow</dd>
@@ -1535,7 +1542,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>includeStopRow</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.756">includeStopRow</a>()</pre>
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.754">includeStopRow</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if we should include stop row when scan</dd>
@@ -1548,7 +1555,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getMaxVersions</h4>
-<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.763">getMaxVersions</a>()</pre>
+<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.761">getMaxVersions</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the max number of versions to fetch</dd>
@@ -1561,7 +1568,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getBatch</h4>
-<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.770">getBatch</a>()</pre>
+<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.768">getBatch</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximum number of values to return for a single call to next()</dd>
@@ -1574,7 +1581,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getMaxResultsPerColumnFamily</h4>
-<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.777">getMaxResultsPerColumnFamily</a>()</pre>
+<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.775">getMaxResultsPerColumnFamily</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>maximum number of values to return per row per CF</dd>
@@ -1587,7 +1594,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getRowOffsetPerColumnFamily</h4>
-<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.786">getRowOffsetPerColumnFamily</a>()</pre>
+<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.784">getRowOffsetPerColumnFamily</a>()</pre>
<div class="block">Method for retrieving the scan's offset per row per column
family (#kvs to be skipped)</div>
<dl>
@@ -1602,7 +1609,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getCaching</h4>
-<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.793">getCaching</a>()</pre>
+<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.791">getCaching</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>caching the number of rows fetched when calling next on a scanner</dd>
@@ -1615,7 +1622,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.801">getFilter</a>()</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.799">getFilter</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getFilter--">getFilter</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
@@ -1630,7 +1637,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>hasFilter</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.808">hasFilter</a>()</pre>
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.806">hasFilter</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true is a filter has been specified, false if not</dd>
@@ -1643,7 +1650,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setCacheBlocks</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.822">setCacheBlocks</a>(boolean cacheBlocks)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.820">setCacheBlocks</a>(boolean cacheBlocks)</pre>
<div class="block">Set whether blocks should be cached for this Scan.
<p>
This is true by default. When true, default settings of the table and
@@ -1662,7 +1669,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getCacheBlocks</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.832">getCacheBlocks</a>()</pre>
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.830">getCacheBlocks</a>()</pre>
<div class="block">Get whether blocks should be cached for this Scan.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1677,7 +1684,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setReversed</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.844">setReversed</a>(boolean reversed)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.842">setReversed</a>(boolean reversed)</pre>
<div class="block">Set whether this scan is a reversed one
<p>
This is false by default which means forward(normal) scan.</div>
@@ -1695,7 +1702,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>isReversed</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.853">isReversed</a>()</pre>
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.851">isReversed</a>()</pre>
<div class="block">Get whether this scan is a reversed one.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1709,15 +1716,19 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setAllowPartialResults</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.864">setAllowPartialResults</a>(boolean allowPartialResults)</pre>
-<div class="block">Setting whether the caller wants to see the partial results that may be returned from the
- server. By default this value is false and the complete results will be assembled client side
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.865">setAllowPartialResults</a>(boolean allowPartialResults)</pre>
+<div class="block">Setting whether the caller wants to see the partial results when server returns
+ less-than-expected cells. It is helpful while scanning a huge row to prevent OOM at client.
+ By default this value is false and the complete results will be assembled client side
before being delivered to the caller.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowPartialResults</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/hadoop/hbase/client/Result.html#mayHaveMoreCellsInRow--"><code>Result.mayHaveMoreCellsInRow()</code></a>,
+<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setBatch-int-"><code>setBatch(int)</code></a></dd>
</dl>
</li>
</ul>
@@ -1727,7 +1738,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getAllowPartialResults</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.874">getAllowPartialResults</a>()</pre>
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.875">getAllowPartialResults</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true when the constructor of this scan understands that the results they will see may
@@ -1742,7 +1753,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>setLoadColumnFamiliesOnDemand</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.878">setLoadColumnFamiliesOnDemand</a>(boolean value)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.879">setLoadColumnFamiliesOnDemand</a>(boolean value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setLoadColumnFamiliesOnDemand-boolean-">Query</a></code></span></div>
<div class="block">Set the value indicating whether loading CFs on demand should be allowed (cluster
default is false). On-demand CF loading doesn't load column families until necessary, e.g.
@@ -1770,7 +1781,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>getFingerprint</h4>
-<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.889">getFingerprint</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.890">getFingerprint</a>()</pre>
<div class="block">Compile the table and column family (i.e. schema) information
into a String. Useful for parsing and aggregation by debugging,
logging, and administration tools.</div>
@@ -1788,7 +1799,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti
<ul class="blockList">
<li class="blockList">
<h4>toMap</h4>
-<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.913">toMap</a>(int maxCols)</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.914">toMap</a>(int maxCols)</pre>
<div class="block">Compile the details beyond the scope of getFingerprint (row, columns,
timestamps, etc.) into a Map along with the fingerprinted information.
Useful for debugging, logging, and administration tools.</div>
@@ -2063,7 +2074,11 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas
<ul class="blockList">
<li class="blockList">
<h4>getScanMetrics</h4>
-<pre>public org.apache.hadoop.hbase.client.metrics.ScanMetrics <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1085">getScanMetrics</a>()</pre>
+<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
+public org.apache.hadoop.hbase.client.metrics.ScanMetrics <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1089">getScanMetrics</a>()</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#getScanMetrics--"><code>ResultScanner.getScanMetrics()</code></a> instead. And notice that, please do not
+ use this method and <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#getScanMetrics--"><code>ResultScanner.getScanMetrics()</code></a> together, the metrics
+ will be messed up.</span></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Metrics on this Scan, if metrics were enabled.</dd>
@@ -2078,7 +2093,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas
<ul class="blockList">
<li class="blockList">
<h4>isAsyncPrefetch</h4>
-<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1091">isAsyncPrefetch</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1095">isAsyncPrefetch</a>()</pre>
</li>
</ul>
<a name="setAsyncPrefetch-boolean-">
@@ -2087,7 +2102,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas
<ul class="blockList">
<li class="blockList">
<h4>setAsyncPrefetch</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1095">setAsyncPrefetch</a>(boolean asyncPrefetch)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1099">setAsyncPrefetch</a>(boolean asyncPrefetch)</pre>
</li>
</ul>
<a name="getLimit--">
@@ -2096,7 +2111,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas
<ul class="blockList">
<li class="blockList">
<h4>getLimit</h4>
-<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1103">getLimit</a>()</pre>
+<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1107">getLimit</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the limit of rows for this scan</dd>
@@ -2109,7 +2124,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas
<ul class="blockList">
<li class="blockList">
<h4>setLimit</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1117">setLimit</a>(int limit)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1121">setLimit</a>(int limit)</pre>
<div class="block">Set the limit of rows for this scan. We will terminate the scan if the number of returned rows
reaches this value.
<p>
@@ -2130,7 +2145,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas
<ul class="blockList">
<li class="blockList">
<h4>setOneRowLimit</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1127">setOneRowLimit</a>()</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1131">setOneRowLimit</a>()</pre>
<div class="block">Call this when you only want to get one row. It will set <code>limit</code> to <code>1</code>, and also
set <code>readType</code> to <a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html#PREAD"><code>Scan.ReadType.PREAD</code></a>.</div>
<dl>
@@ -2145,7 +2160,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas
<ul class="blockList">
<li class="blockList">
<h4>getReadType</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1140">getReadType</a>()</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1144">getReadType</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the read type for this scan</dd>
@@ -2158,7 +2173,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas
<ul class="blockListLast">
<li class="blockList">
<h4>setReadType</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1151">setReadType</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a> readType)</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1155">setReadType</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a> readType)</pre>
<div class="block">Set the read type for this scan.
<p>
Notice that we may choose to use pread even if you specific <a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html#STREAM"><code>Scan.ReadType.STREAM</code></a> here. For
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/22cff34f/apidocs/org/apache/hadoop/hbase/client/ScanResultConsumer.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/client/ScanResultConsumer.html b/apidocs/org/apache/hadoop/hbase/client/ScanResultConsumer.html
index a9fe429..b36712b 100644
--- a/apidocs/org/apache/hadoop/hbase/client/ScanResultConsumer.html
+++ b/apidocs/org/apache/hadoop/hbase/client/ScanResultConsumer.html
@@ -18,8 +18,8 @@
catch(err) {
}
//-->
-var methods = {"i0":6,"i1":6,"i2":6};
-var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
+var methods = {"i0":6,"i1":6,"i2":6,"i3":18};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab";
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/client/ScannerTimeoutException.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/hadoop/hbase/client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/hadoop/hbase/client/ShortCircuitMasterConnection.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/ScanResultConsumer.html" target="_top">Frames</a></li>
@@ -103,7 +103,7 @@ var activeTableTab = "activeTableTab";
<br>
<pre>@InterfaceAudience.Public
@InterfaceStability.Unstable
-public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html#line.28">ScanResultConsumer</a></pre>
+public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html#line.29">ScanResultConsumer</a></pre>
<div class="block">Receives <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a> for an asynchronous scan.</div>
</li>
</ul>
@@ -118,7 +118,7 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
@@ -139,6 +139,14 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html#onNext-org.apache.hadoop.hbase.client.Result-">onNext</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a> result)</code> </td>
</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>default void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html#onScanMetricsCreated-org.apache.hadoop.hbase.client.metrics.ScanMetrics-">onScanMetricsCreated</a></span>(org.apache.hadoop.hbase.client.metrics.ScanMetrics scanMetrics)</code>
+<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.</div>
+</td>
+</tr>
</table>
</li>
</ul>
@@ -160,7 +168,7 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client
<ul class="blockList">
<li class="blockList">
<h4>onNext</h4>
-<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html#line.34">onNext</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a> result)</pre>
+<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html#line.35">onNext</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a> result)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>result</code> - the data fetched from HBase service.</dd>
@@ -175,7 +183,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/ScanResultConsumer.html#line.41">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/ScanResultConsumer.html#line.42">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/ScanResultConsumer.html#onComplete--"><code>onComplete()</code></a> after calling <a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html#onError-java.lang.Throwable-"><code>onError(Throwable)</code></a>.</div>
@@ -184,13 +192,26 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client
<a name="onComplete--">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>onComplete</h4>
-<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html#line.46">onComplete</a>()</pre>
+<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html#line.47">onComplete</a>()</pre>
<div class="block">Indicate that the scan operation is completed normally.</div>
</li>
</ul>
+<a name="onScanMetricsCreated-org.apache.hadoop.hbase.client.metrics.ScanMetrics-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>onScanMetricsCreated</h4>
+<pre>default void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/ScanResultConsumer.html#line.55">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
+ store it somewhere to get the metrics at any time if you want.</div>
+</li>
+</ul>
</li>
</ul>
</li>
@@ -220,7 +241,7 @@ public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/client
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/client/ScannerTimeoutException.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/hadoop/hbase/client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/hadoop/hbase/client/ShortCircuitMasterConnection.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/client/ScanResultConsumer.html" target="_top">Frames</a></li>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/22cff34f/apidocs/org/apache/hadoop/hbase/client/SnapshotDescription.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/client/SnapshotDescription.html b/apidocs/org/apache/hadoop/hbase/client/SnapshotDescription.html
index b175d8b..3f84540 100644
--- a/apidocs/org/apache/hadoop/hbase/client/SnapshotDescription.html
+++ b/apidocs/org/apache/hadoop/hbase/client/SnapshotDescription.html
@@ -49,7 +49,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/hadoop/hbase/client/ShortCircuitMasterConnection.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/client/SnapshotType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
@@ -507,7 +507,7 @@ public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.h
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/hadoop/hbase/client/ScanResultConsumer.html" title="interface in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/hadoop/hbase/client/ShortCircuitMasterConnection.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/client/SnapshotType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/22cff34f/apidocs/org/apache/hadoop/hbase/client/class-use/Append.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/client/class-use/Append.html b/apidocs/org/apache/hadoop/hbase/client/class-use/Append.html
index e4a83fb..a2cc235 100644
--- a/apidocs/org/apache/hadoop/hbase/client/class-use/Append.html
+++ b/apidocs/org/apache/hadoop/hbase/client/class-use/Append.html
@@ -174,14 +174,14 @@
</tr>
<tbody>
<tr class="altColor">
-<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></td>
-<td class="colLast"><span class="typeNameLabel">AsyncTableBase.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#append-org.apache.hadoop.hbase.client.Append-">append</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client">Append</a> append)</code>
+<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></code></td>
+<td class="colLast"><span class="typeNameLabel">Table.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#append-org.apache.hadoop.hbase.client.Append-">append</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client">Append</a> append)</code>
<div class="block">Appends values to one or more columns within a single row.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></code></td>
-<td class="colLast"><span class="typeNameLabel">Table.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#append-org.apache.hadoop.hbase.client.Append-">append</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client">Append</a> append)</code>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></td>
+<td class="colLast"><span class="typeNameLabel">AsyncTableBase.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/AsyncTableBase.html#append-org.apache.hadoop.hbase.client.Append-">append</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Append.html" title="class in org.apache.hadoop.hbase.client">Append</a> append)</code>
<div class="block">Appends values to one or more columns within a single row.</div>
</td>
</tr>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/22cff34f/apidocs/org/apache/hadoop/hbase/client/class-use/AsyncConnection.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/client/class-use/AsyncConnection.html b/apidocs/org/apache/hadoop/hbase/client/class-use/AsyncConnection.html
index ecabfac..bd9935d 100644
--- a/apidocs/org/apache/hadoop/hbase/client/class-use/AsyncConnection.html
+++ b/apidocs/org/apache/hadoop/hbase/client/class-use/AsyncConnection.html
@@ -98,27 +98,27 @@
</a>
<h3>Uses of <a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a> in <a href="../../../../../../org/apache/hadoop/hbase/client/package-summary.html">org.apache.hadoop.hbase.client</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
-<caption><span>Methods in <a href="../../../../../../org/apache/hadoop/hbase/client/package-summary.html">org.apache.hadoop.hbase.client</a> that return <a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a></span><span class="tabEnd"> </span></caption>
+<caption><span>Methods in <a href="../../../../../../org/apache/hadoop/hbase/client/package-summary.html">org.apache.hadoop.hbase.client</a> that return types with arguments of type <a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a></span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a></code></td>
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>></code></td>
<td class="colLast"><span class="typeNameLabel">ConnectionFactory.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection--">createAsyncConnection</a></span>()</code>
<div class="block">Call <a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-"><code>ConnectionFactory.createAsyncConnection(Configuration)</code></a> using default HBaseConfiguration.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a></code></td>
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>></code></td>
<td class="colLast"><span class="typeNameLabel">ConnectionFactory.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-">createAsyncConnection</a></span>(org.apache.hadoop.conf.Configuration conf)</code>
<div class="block">Call <a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-"><code>ConnectionFactory.createAsyncConnection(Configuration, User)</code></a> using the given <code>conf</code> and a
User object created by <code>UserProvider</code>.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a></code></td>
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a><<a href="../../../../../../org/apache/hadoop/hbase/client/AsyncConnection.html" title="interface in org.apache.hadoop.hbase.client">AsyncConnection</a>></code></td>
<td class="colLast"><span class="typeNameLabel">ConnectionFactory.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionFactory.html#createAsyncConnection-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.security.User-">createAsyncConnection</a></span>(org.apache.hadoop.conf.Configuration conf,
<a href="../../../../../../org/apache/hadoop/hbase/security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user)</code>
<div class="block">Create a new AsyncConnection instance using the passed <code>conf</code> and <code>user</code>.</div>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/22cff34f/apidocs/org/apache/hadoop/hbase/client/class-use/Consistency.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/client/class-use/Consistency.html b/apidocs/org/apache/hadoop/hbase/client/class-use/Consistency.html
index a7520f0..4c3092f 100644
--- a/apidocs/org/apache/hadoop/hbase/client/class-use/Consistency.html
+++ b/apidocs/org/apache/hadoop/hbase/client/class-use/Consistency.html
@@ -150,15 +150,15 @@ the order they are declared.</div>
<td class="colLast"><span class="typeNameLabel">Scan.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/Scan.html#setConsistency-org.apache.hadoop.hbase.client.Consistency-">setConsistency</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client">Consistency</a> consistency)</code> </td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a></code></td>
-<td class="colLast"><span class="typeNameLabel">Get.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/Get.html#setConsistency-org.apache.hadoop.hbase.client.Consistency-">setConsistency</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client">Consistency</a> consistency)</code> </td>
-</tr>
-<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></td>
<td class="colLast"><span class="typeNameLabel">Query.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/Query.html#setConsistency-org.apache.hadoop.hbase.client.Consistency-">setConsistency</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client">Consistency</a> consistency)</code>
<div class="block">Sets the consistency level for this operation</div>
</td>
</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a></code></td>
+<td class="colLast"><span class="typeNameLabel">Get.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/Get.html#setConsistency-org.apache.hadoop.hbase.client.Consistency-">setConsistency</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client">Consistency</a> consistency)</code> </td>
+</tr>
</tbody>
</table>
</li>