http://git-wip-us.apache.org/repos/asf/hbase-site/blob/62e361eb/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 323ac7e..767c23c 100644 --- a/apidocs/org/apache/hadoop/hbase/client/Scan.html +++ b/apidocs/org/apache/hadoop/hbase/client/Scan.html @@ -18,8 +18,8 @@ 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":10,"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}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +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 tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/RpcRetryingCaller.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/ScannerTimeoutException.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/Scan.ReadType.html" title="enum 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/Scan.html" target="_top">Frames</a></li> @@ -74,7 +74,7 @@ var activeTableTab = "activeTableTab"; <div> <ul class="subNavList"> <li>Summary: </li> -<li>Nested | </li> +<li><a href="#nested.class.summary">Nested</a> | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> @@ -130,48 +130,73 @@ var activeTableTab = "activeTableTab"; <br> <pre>@InterfaceAudience.Public @InterfaceStability.Stable -public class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.84">Scan</a> +public class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.91">Scan</a> extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></pre> <div class="block">Used to perform Scan operations. <p> - All operations are identical to <a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client"><code>Get</code></a> with the exception of - instantiation. Rather than specifying a single row, an optional startRow - and stopRow may be defined. If rows are not specified, the Scanner will - iterate over all rows. + All operations are identical to <a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client"><code>Get</code></a> with the exception of instantiation. Rather than + specifying a single row, an optional startRow and stopRow may be defined. If rows are not + specified, the Scanner will iterate over all rows. <p> To get all columns from all rows of a Table, create an instance with no constraints; use the - <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#Scan--"><code>Scan()</code></a> constructor. To constrain the scan to specific column families, - call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#addFamily-byte:A-"><code>addFamily</code></a> for each family to retrieve on your Scan instance. + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#Scan--"><code>Scan()</code></a> constructor. To constrain the scan to specific column families, call + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#addFamily-byte:A-"><code>addFamily</code></a> for each family to retrieve on your Scan instance. <p> - To get specific columns, call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#addColumn-byte:A-byte:A-"><code>addColumn</code></a> - for each column to retrieve. + To get specific columns, call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#addColumn-byte:A-byte:A-"><code>addColumn</code></a> for each column to + retrieve. <p> - To only retrieve columns within a specific range of version timestamps, - call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setTimeRange-long-long-"><code>setTimeRange</code></a>. + To only retrieve columns within a specific range of version timestamps, call + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setTimeRange-long-long-"><code>setTimeRange</code></a>. <p> - To only retrieve columns with a specific timestamp, call - <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setTimeStamp-long-"><code>setTimestamp</code></a>. + To only retrieve columns with a specific timestamp, call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setTimeStamp-long-"><code>setTimestamp</code></a> + . <p> - To limit the number of versions of each column to be returned, call - <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setMaxVersions-int-"><code>setMaxVersions</code></a>. + To limit the number of versions of each column to be returned, call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setMaxVersions-int-"><code>setMaxVersions</code></a>. <p> - To limit the maximum number of values returned for each call to next(), - call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setBatch-int-"><code>setBatch</code></a>. + To limit the maximum number of values returned for each call to next(), call + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setBatch-int-"><code>setBatch</code></a>. <p> To add a filter, call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setFilter-org.apache.hadoop.hbase.filter.Filter-"><code>setFilter</code></a>. <p> - Expert: To explicitly disable server-side block caching for this scan, - execute <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setCacheBlocks-boolean-"><code>setCacheBlocks(boolean)</code></a>. - <p><em>Note:</em> Usage alters Scan instances. Internally, attributes are updated as the Scan - runs and if enabled, metrics accumulate in the Scan instance. Be aware this is the case when - you go to clone a Scan instance or if you go to reuse a created Scan instance; safer is create - a Scan instance per usage.</div> + For small scan, it is deprecated in 2.0.0. Now we have a <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setLimit-int-"><code>setLimit(int)</code></a> method in Scan + object which is used to tell RS how many rows we want. If the rows return reaches the limit, the + RS will close the RegionScanner automatically. And we will also fetch data when openScanner in + the new implementation, this means we can also finish a scan operation in one rpc call. And we + have also introduced a <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setReadType-org.apache.hadoop.hbase.client.Scan.ReadType-"><code>setReadType(ReadType)</code></a> method. You can use this method to tell RS + to use pread explicitly. + <p> + Expert: To explicitly disable server-side block caching for this scan, execute + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setCacheBlocks-boolean-"><code>setCacheBlocks(boolean)</code></a>. + <p> + <em>Note:</em> Usage alters Scan instances. Internally, attributes are updated as the Scan runs + and if enabled, metrics accumulate in the Scan instance. Be aware this is the case when you go to + clone a Scan instance or if you go to reuse a created Scan instance; safer is create a Scan + instance per usage.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a></span></code> </td> +</tr> +</table> +</li> +</ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> @@ -249,18 +274,26 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#Scan-byte:A-">Scan</a></span>(byte[] startRow)</code> -<div class="block">Create a Scan operation starting at the specified row.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <code>new Scan().withStartRow(startRow)</code> instead.</span></div> +</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#Scan-byte:A-byte:A-">Scan</a></span>(byte[] startRow, byte[] stopRow)</code> -<div class="block">Create a Scan operation for the range of rows specified.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <code>new Scan().withStartRow(startRow).withStopRow(stopRow)</code> instead.</span></div> +</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#Scan-byte:A-org.apache.hadoop.hbase.filter.Filter-">Scan</a></span>(byte[] startRow, - <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</code> </td> + <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <code>new Scan().withStartRow(startRow).setFilter(filter)</code> instead.</span></div> +</div> +</td> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#Scan-org.apache.hadoop.hbase.client.Get-">Scan</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</code> @@ -282,7 +315,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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> @@ -339,128 +372,146 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title </td> </tr> <tr id="i10" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getLimit--">getLimit</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getMaxResultSize--">getMaxResultSize</a></span>()</code> </td> </tr> -<tr id="i11" class="rowColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getMaxResultsPerColumnFamily--">getMaxResultsPerColumnFamily</a></span>()</code> </td> </tr> -<tr id="i12" class="altColor"> +<tr id="i13" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getMaxVersions--">getMaxVersions</a></span>()</code> </td> </tr> -<tr id="i13" class="rowColor"> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getReadType--">getReadType</a></span>()</code> </td> +</tr> +<tr id="i15" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getRowOffsetPerColumnFamily--">getRowOffsetPerColumnFamily</a></span>()</code> <div class="block">Method for retrieving the scan's offset per row per column family (#kvs to be skipped)</div> </td> </tr> -<tr id="i14" class="altColor"> +<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> </tr> -<tr id="i15" class="rowColor"> +<tr id="i17" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getStartRow--">getStartRow</a></span>()</code> </td> </tr> -<tr id="i16" class="altColor"> +<tr id="i18" class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getStopRow--">getStopRow</a></span>()</code> </td> </tr> -<tr id="i17" class="rowColor"> +<tr id="i19" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#hasFamilies--">hasFamilies</a></span>()</code> </td> </tr> -<tr id="i18" class="altColor"> +<tr id="i20" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#hasFilter--">hasFilter</a></span>()</code> </td> </tr> -<tr id="i19" class="rowColor"> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#includeStartRow--">includeStartRow</a></span>()</code> </td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#includeStopRow--">includeStopRow</a></span>()</code> </td> +</tr> +<tr id="i23" class="rowColor"> <td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#isAsyncPrefetch--">isAsyncPrefetch</a></span>()</code> </td> </tr> -<tr id="i20" class="altColor"> +<tr id="i24" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#isGetScan--">isGetScan</a></span>()</code> </td> </tr> -<tr id="i21" class="rowColor"> +<tr id="i25" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#isRaw--">isRaw</a></span>()</code> </td> </tr> -<tr id="i22" class="altColor"> +<tr id="i26" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#isReversed--">isReversed</a></span>()</code> <div class="block">Get whether this scan is a reversed one.</div> </td> </tr> -<tr id="i23" class="rowColor"> +<tr id="i27" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#isScanMetricsEnabled--">isScanMetricsEnabled</a></span>()</code> </td> </tr> -<tr id="i24" class="altColor"> +<tr id="i28" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#isSmall--">isSmall</a></span>()</code> -<div class="block">Get whether this scan is a small scan</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 2.0.0. See the comment of <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setSmall-boolean-"><code>setSmall(boolean)</code></a></span></div> +</div> </td> </tr> -<tr id="i25" class="rowColor"> +<tr id="i29" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#numFamilies--">numFamilies</a></span>()</code> </td> </tr> -<tr id="i26" class="altColor"> +<tr id="i30" 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#setACL-java.util.Map-">setACL</a></span>(<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>,org.apache.hadoop.hbase.security.access.Permission> perms)</code> </td> </tr> -<tr id="i27" class="rowColor"> +<tr id="i31" class="rowColor"> <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#setACL-java.lang.String-org.apache.hadoop.hbase.security.access.Permission-">setACL</a></span>(<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> user, org.apache.hadoop.hbase.security.access.Permission perms)</code> </td> </tr> -<tr id="i28" class="altColor"> +<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> </td> </tr> -<tr id="i29" class="rowColor"> +<tr id="i33" class="rowColor"> <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#setAsyncPrefetch-boolean-">setAsyncPrefetch</a></span>(boolean asyncPrefetch)</code> </td> </tr> -<tr id="i30" class="altColor"> +<tr id="i34" 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#setAttribute-java.lang.String-byte:A-">setAttribute</a></span>(<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> name, byte[] value)</code> <div class="block">Sets an attribute.</div> </td> </tr> -<tr id="i31" class="rowColor"> +<tr id="i35" class="rowColor"> <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#setAuthorizations-org.apache.hadoop.hbase.security.visibility.Authorizations-">setAuthorizations</a></span>(org.apache.hadoop.hbase.security.visibility.Authorizations authorizations)</code> <div class="block">Sets the authorizations to be used by this Query</div> </td> </tr> -<tr id="i32" class="altColor"> +<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> </td> </tr> -<tr id="i33" class="rowColor"> +<tr id="i37" class="rowColor"> <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#setCacheBlocks-boolean-">setCacheBlocks</a></span>(boolean cacheBlocks)</code> <div class="block">Set whether blocks should be cached for this Scan.</div> </td> </tr> -<tr id="i34" class="altColor"> +<tr id="i38" 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#setCaching-int-">setCaching</a></span>(int caching)</code> <div class="block">Set the number of rows for caching that will be passed to scanners.</div> </td> </tr> -<tr id="i35" class="rowColor"> +<tr id="i39" class="rowColor"> <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#setColumnFamilyTimeRange-byte:A-long-long-">setColumnFamilyTimeRange</a></span>(byte[] cf, long minStamp, @@ -469,128 +520,157 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title [minStamp, maxStamp) on a per CF bases.</div> </td> </tr> -<tr id="i36" class="altColor"> +<tr id="i40" 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#setColumnFamilyTimeRange-byte:A-org.apache.hadoop.hbase.io.TimeRange-">setColumnFamilyTimeRange</a></span>(byte[] cf, <a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a> tr)</code> </td> </tr> -<tr id="i37" class="rowColor"> +<tr id="i41" class="rowColor"> <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#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 id="i38" class="altColor"> +<tr id="i42" 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#setFamilyMap-java.util.Map-">setFamilyMap</a></span>(<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)</code> <div class="block">Setting the familyMap</div> </td> </tr> -<tr id="i39" class="rowColor"> +<tr id="i43" class="rowColor"> <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#setFilter-org.apache.hadoop.hbase.filter.Filter-">setFilter</a></span>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</code> <div class="block">Apply the specified server-side filter when performing the Query.</div> </td> </tr> -<tr id="i40" class="altColor"> +<tr id="i44" 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#setId-java.lang.String-">setId</a></span>(<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> id)</code> <div class="block">This method allows you to set an identifier on an operation.</div> </td> </tr> -<tr id="i41" class="rowColor"> +<tr id="i45" class="rowColor"> <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#setIsolationLevel-org.apache.hadoop.hbase.client.IsolationLevel-">setIsolationLevel</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/IsolationLevel.html" title="enum in org.apache.hadoop.hbase.client">IsolationLevel</a> level)</code> <div class="block">Set the isolation level for this query.</div> </td> </tr> -<tr id="i42" class="altColor"> +<tr id="i46" 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#setLimit-int-">setLimit</a></span>(int limit)</code> +<div class="block">Set the limit of rows for this scan.</div> +</td> +</tr> +<tr id="i47" class="rowColor"> <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#setLoadColumnFamiliesOnDemand-boolean-">setLoadColumnFamiliesOnDemand</a></span>(boolean value)</code> <div class="block">Set the value indicating whether loading CFs on demand should be allowed (cluster default is false).</div> </td> </tr> -<tr id="i43" class="rowColor"> +<tr id="i48" 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#setMaxResultSize-long-">setMaxResultSize</a></span>(long maxResultSize)</code> <div class="block">Set the maximum result size.</div> </td> </tr> -<tr id="i44" class="altColor"> +<tr id="i49" class="rowColor"> <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#setMaxResultsPerColumnFamily-int-">setMaxResultsPerColumnFamily</a></span>(int limit)</code> <div class="block">Set the maximum number of values to return per row per Column Family</div> </td> </tr> -<tr id="i45" class="rowColor"> +<tr id="i50" 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#setMaxVersions--">setMaxVersions</a></span>()</code> <div class="block">Get all available versions.</div> </td> </tr> -<tr id="i46" class="altColor"> +<tr id="i51" class="rowColor"> <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#setMaxVersions-int-">setMaxVersions</a></span>(int maxVersions)</code> <div class="block">Get up to the specified number of versions of each column.</div> </td> </tr> -<tr id="i47" class="rowColor"> +<tr id="i52" 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#setOneRowLimit--">setOneRowLimit</a></span>()</code> +<div class="block">Call this when you only want to get one row.</div> +</td> +</tr> +<tr id="i53" class="rowColor"> <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#setRaw-boolean-">setRaw</a></span>(boolean raw)</code> <div class="block">Enable/disable "raw" mode for this scan.</div> </td> </tr> -<tr id="i48" class="altColor"> +<tr id="i54" 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#setReadType-org.apache.hadoop.hbase.client.Scan.ReadType-">setReadType</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a> readType)</code> +<div class="block">Set the read type for this scan.</div> +</td> +</tr> +<tr id="i55" class="rowColor"> <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#setReplicaId-int-">setReplicaId</a></span>(int Id)</code> <div class="block">Specify region replica id where Query will fetch data from.</div> </td> </tr> -<tr id="i49" class="rowColor"> +<tr id="i56" 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#setReversed-boolean-">setReversed</a></span>(boolean reversed)</code> <div class="block">Set whether this scan is a reversed one</div> </td> </tr> -<tr id="i50" class="altColor"> +<tr id="i57" class="rowColor"> <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#setRowOffsetPerColumnFamily-int-">setRowOffsetPerColumnFamily</a></span>(int offset)</code> <div class="block">Set offset for the row per Column Family.</div> </td> </tr> -<tr id="i51" class="rowColor"> +<tr id="i58" 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#setRowPrefixFilter-byte:A-">setRowPrefixFilter</a></span>(byte[] rowPrefix)</code> <div class="block">Set a filter (using stopRow and startRow) so the result set only contains rows where the rowKey starts with the specified prefix.</div> </td> </tr> -<tr id="i52" class="altColor"> +<tr id="i59" class="rowColor"> <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#setScanMetricsEnabled-boolean-">setScanMetricsEnabled</a></span>(boolean enabled)</code> <div class="block">Enable collection of <code>ScanMetrics</code>.</div> </td> </tr> -<tr id="i53" class="rowColor"> +<tr id="i60" 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#setSmall-boolean-">setSmall</a></span>(boolean small)</code> -<div class="block">Set whether this scan is a small scan</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 2.0.0. Use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setLimit-int-"><code>setLimit(int)</code></a> and <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setReadType-org.apache.hadoop.hbase.client.Scan.ReadType-"><code>setReadType(ReadType)</code></a> instead. + And for the one rpc optimization, now we will also fetch data when openScanner, and + if the number of rows reaches the limit then we will close the scanner + automatically which means we will fall back to one rpc.</span></div> +</div> </td> </tr> -<tr id="i54" class="altColor"> +<tr id="i61" class="rowColor"> <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#setStartRow-byte:A-">setStartRow</a></span>(byte[] startRow)</code> -<div class="block">Set the start row of the scan.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><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> </td> </tr> -<tr id="i55" class="rowColor"> +<tr id="i62" 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#setStopRow-byte:A-">setStopRow</a></span>(byte[] stopRow)</code> -<div class="block">Set the stop row of the scan.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><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> </td> </tr> -<tr id="i56" class="altColor"> +<tr id="i63" class="rowColor"> <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#setTimeRange-long-long-">setTimeRange</a></span>(long minStamp, long maxStamp)</code> @@ -598,25 +678,51 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title [minStamp, maxStamp).</div> </td> </tr> -<tr id="i57" class="rowColor"> +<tr id="i64" 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#setTimeRange-org.apache.hadoop.hbase.io.TimeRange-">setTimeRange</a></span>(<a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a> tr)</code> <div class="block">Set versions of columns only within the specified timestamp range,</div> </td> </tr> -<tr id="i58" class="altColor"> +<tr id="i65" class="rowColor"> <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#setTimeStamp-long-">setTimeStamp</a></span>(long timestamp)</code> <div class="block">Get versions of columns with the specified timestamp.</div> </td> </tr> -<tr id="i59" class="rowColor"> +<tr id="i66" class="altColor"> <td class="colFirst"><code><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>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#toMap-int-">toMap</a></span>(int maxCols)</code> <div class="block">Compile the details beyond the scope of getFingerprint (row, columns, timestamps, etc.) into a Map along with the fingerprinted information.</div> </td> </tr> +<tr id="i67" class="rowColor"> +<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#withStartRow-byte:A-">withStartRow</a></span>(byte[] startRow)</code> +<div class="block">Set the start row of the scan.</div> +</td> +</tr> +<tr id="i68" 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#withStartRow-byte:A-boolean-">withStartRow</a></span>(byte[] startRow, + boolean inclusive)</code> +<div class="block">Set the start row of the scan.</div> +</td> +</tr> +<tr id="i69" class="rowColor"> +<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#withStopRow-byte:A-">withStopRow</a></span>(byte[] stopRow)</code> +<div class="block">Set the stop row of the scan.</div> +</td> +</tr> +<tr id="i70" 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#withStopRow-byte:A-boolean-">withStopRow</a></span>(byte[] stopRow, + boolean inclusive)</code> +<div class="block">Set the stop row of the scan.</div> +</td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.Query"> @@ -667,7 +773,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title <li class="blockList"> <h4>SCAN_ATTRIBUTES_METRICS_ENABLE</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 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.116">SCAN_ATTRIBUTES_METRICS_ENABLE</a></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.124">SCAN_ATTRIBUTES_METRICS_ENABLE</a></pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.0.0. Use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setScanMetricsEnabled-boolean-"><code>setScanMetricsEnabled(boolean)</code></a></span></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -682,7 +788,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <li class="blockList"> <h4>SCAN_ATTRIBUTES_METRICS_DATA</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 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.123">SCAN_ATTRIBUTES_METRICS_DATA</a></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.131">SCAN_ATTRIBUTES_METRICS_DATA</a></pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getScanMetrics--"><code>getScanMetrics()</code></a></div> <dl> @@ -697,7 +803,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockList"> <li class="blockList"> <h4>SCAN_ATTRIBUTES_TABLE_NAME</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.128">SCAN_ATTRIBUTES_TABLE_NAME</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.136">SCAN_ATTRIBUTES_TABLE_NAME</a></pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.SCAN_ATTRIBUTES_TABLE_NAME">Constant Field Values</a></dd> @@ -710,7 +816,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.148">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.156">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 @@ -727,7 +833,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.154">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.162">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> @@ -749,7 +855,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.176">Scan</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.194">Scan</a>()</pre> <div class="block">Create a Scan operation across all rows.</div> </li> </ul> @@ -759,8 +865,10 @@ 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.178">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> +<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, + <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> </ul> <a name="Scan-byte:A-"> @@ -769,11 +877,13 @@ 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.190">Scan</a>(byte[] startRow)</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 <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.214">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> - If the specified row does not exist, the Scanner will start from the - next closest row after the specified row.</div> + If the specified row does not exist, the Scanner will start from the next closest row after the + specified row.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>startRow</code> - row to start scanner at or after</dd> @@ -786,8 +896,10 @@ 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.199">Scan</a>(byte[] startRow, - byte[] stopRow)</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 <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.225">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> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -802,7 +914,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.212">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.236">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> @@ -819,7 +931,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockListLast"> <li class="blockList"> <h4>Scan</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.259">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.284">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> @@ -841,7 +953,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockList"> <li class="blockList"> <h4>isGetScan</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.284">isGetScan</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.310">isGetScan</a>()</pre> </li> </ul> <a name="addFamily-byte:A-"> @@ -850,7 +962,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.299">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.325">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> @@ -868,7 +980,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.313">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.339">addColumn</a>(byte[] family, byte[] qualifier)</pre> <div class="block">Get the column from the specified family with the specified qualifier. <p> @@ -888,7 +1000,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.338">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.364">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, @@ -917,7 +1029,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.347">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.373">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> @@ -935,7 +1047,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.361">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.387">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 @@ -960,7 +1072,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.374">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.400">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> @@ -987,7 +1099,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.379">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.405">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> @@ -1001,19 +1113,68 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockList"> <li class="blockList"> <h4>setStartRow</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.393">setStartRow</a>(byte[] startRow)</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 <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> +<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. + <p> + If the specified row does not exist, the Scanner will start from the next closest row after the + specified row.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>startRow</code> - row to start scanner at or after</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if startRow does not meet criteria for a row key (when length + exceeds <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd> +</dl> +</li> +</ul> +<a name="withStartRow-byte:A-"> +<!-- --> +</a> +<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> <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 specified row.</div> + If the specified row does not exist, the Scanner will start from the next closest row after the + specified row.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>startRow</code> - row to start scanner at or after</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if startRow does not meet criteria - for a row key (when length exceeds <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if startRow does not meet criteria for a row key (when length + exceeds <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd> +</dl> +</li> +</ul> +<a name="withStartRow-byte:A-boolean-"> +<!-- --> +</a> +<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, + boolean inclusive)</pre> +<div class="block">Set the start row of the scan. + <p> + If the specified row does not exist, or the <code>inclusive</code> is <code>false</code>, the Scanner + will start from the next closest row after the specified row.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>startRow</code> - row to start scanner at or after</dd> +<dd><code>inclusive</code> - whether we should include the start row when scan</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if startRow does not meet criteria for a row key (when length + exceeds <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd> </dl> </li> </ul> @@ -1023,22 +1184,74 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockList"> <li class="blockList"> <h4>setStopRow</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.417">setStopRow</a>(byte[] stopRow)</pre> -<div class="block">Set the stop row of the scan.</div> +<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> +<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. + <p> + The scan will include rows that are lexicographically less than the provided stopRow. + <p> + <b>Note:</b> When doing a filter for a rowKey <u>Prefix</u> use + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setRowPrefixFilter-byte:A-"><code>setRowPrefixFilter(byte[])</code></a>. The 'trailing 0' will not yield the desired result. + </p></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>stopRow</code> - row to end at (exclusive) +<dd><code>stopRow</code> - row to end at (exclusive)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if stopRow does not meet criteria for a row key (when length + exceeds <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd> +</dl> +</li> +</ul> +<a name="withStopRow-byte:A-"> +<!-- --> +</a> +<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> +<div class="block">Set the stop row of the scan. + <p> + The scan will include rows that are lexicographically less than the provided stopRow. + <p> + <b>Note:</b> When doing a filter for a rowKey <u>Prefix</u> use + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setRowPrefixFilter-byte:A-"><code>setRowPrefixFilter(byte[])</code></a>. The 'trailing 0' will not yield the desired result. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stopRow</code> - row to end at (exclusive)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if stopRow does not meet criteria for a row key (when length + exceeds <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd> +</dl> +</li> +</ul> +<a name="withStopRow-byte:A-boolean-"> +<!-- --> +</a> +<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, + boolean inclusive)</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. - <p><b>Note:</b> When doing a filter for a rowKey <u>Prefix</u> - use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setRowPrefixFilter-byte:A-"><code>setRowPrefixFilter(byte[])</code></a>. - The 'trailing 0' will not yield the desired result.</p></dd> + The scan will include rows that are lexicographically less than (or equal to if + <code>inclusive</code> is <code>true</code>) the provided stopRow.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stopRow</code> - row to end at</dd> +<dd><code>inclusive</code> - whether we should include the stop row when scan</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>this</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if stopRow does not meet criteria - for a row key (when length exceeds <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if stopRow does not meet criteria for a row key (when length + exceeds <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#MAX_ROW_LENGTH"><code>HConstants.MAX_ROW_LENGTH</code></a>)</dd> </dl> </li> </ul> @@ -1048,7 +1261,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.439">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.540">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 @@ -1070,7 +1283,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.496">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.597">setMaxVersions</a>()</pre> <div class="block">Get all available versions.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1084,7 +1297,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.506">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.607">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> @@ -1100,7 +1313,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.521">setBatch</a>(int batch)</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.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> @@ -1119,7 +1332,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.535">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.636">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> @@ -1133,7 +1346,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.544">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.645">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> @@ -1147,7 +1360,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.556">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.657">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. @@ -1164,7 +1377,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockList"> <li class="blockList"> <h4>getMaxResultSize</h4> -<pre>public long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.564">getMaxResultSize</a>()</pre> +<pre>public long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.665">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> @@ -1177,7 +1390,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.575">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.676">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> @@ -1193,7 +1406,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.581">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.682">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 @@ -1214,7 +1427,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.591">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.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> <div class="block">Setting the familyMap</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1230,7 +1443,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <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.600">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.701">getFamilyMap</a>()</pre> <div class="block">Getting the familyMap</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1244,7 +1457,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockList"> <li class="blockList"> <h4>numFamilies</h4> -<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.607">numFamilies</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.708">numFamilies</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the number of families in familyMap</dd> @@ -1257,7 +1470,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockList"> <li class="blockList"> <h4>hasFamilies</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.617">hasFamilies</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.718">hasFamilies</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if familyMap is non empty, false otherwise</dd> @@ -1270,7 +1483,7 @@ public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/ <ul class="blockList"> <li class="blockList"> <h4>getFamilies</h4> -<pre>public byte[][] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.624">getFamilies</a>()</pre> +<pre>public byte[][] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.725">getFamilies</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the keys of the familyMap</dd> @@ -1283,33 +1496,59 @@ public static final
<TRUNCATED>
