http://git-wip-us.apache.org/repos/asf/hbase-site/blob/346adc37/devapidocs/org/apache/hadoop/hbase/client/Scan.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/Scan.html b/devapidocs/org/apache/hadoop/hbase/client/Scan.html index 9bc6240..2a20fad 100644 --- a/devapidocs/org/apache/hadoop/hbase/client/Scan.html +++ b/devapidocs/org/apache/hadoop/hbase/client/Scan.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"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":42,"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":42,"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":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":42,"i69":42,"i70":42,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"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":42,"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":42,"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":42,"i58":42,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":42,"i71":42,"i72":42,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -598,63 +598,75 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title <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="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#readAllVersions--">readAllVersions</a></span>()</code> +<div class="block">Get all available versions.</div> +</td> +</tr> +<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#readVersions-int-">readVersions</a></span>(int versions)</code> +<div class="block">Get up to the specified number of versions of each column.</div> +</td> +</tr> +<tr id="i36" class="altColor"> <td class="colFirst"><code>(package private) <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#resetMvccReadPoint--">resetMvccReadPoint</a></span>()</code> <div class="block">Set the mvcc read point to -1 which means do not use it.</div> </td> </tr> -<tr id="i35" 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#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>,<a href="../../../../../org/apache/hadoop/hbase/security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>> perms)</code> </td> </tr> -<tr id="i36" 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#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, <a href="../../../../../org/apache/hadoop/hbase/security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a> perms)</code> </td> </tr> -<tr id="i37" 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#setAllowPartialResults-boolean-">setAllowPartialResults</a></span>(boolean allowPartialResults)</code> <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="i38" 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#setAsyncPrefetch-boolean-">setAsyncPrefetch</a></span>(boolean asyncPrefetch)</code> </td> </tr> -<tr id="i39" 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#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="i40" 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#setAuthorizations-org.apache.hadoop.hbase.security.visibility.Authorizations-">setAuthorizations</a></span>(<a href="../../../../../org/apache/hadoop/hbase/security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a> authorizations)</code> <div class="block">Sets the authorizations to be used by this Query</div> </td> </tr> -<tr id="i41" 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#setBatch-int-">setBatch</a></span>(int batch)</code> <div class="block">Set the maximum number of cells to return for each call to next().</div> </td> </tr> -<tr id="i42" 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#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="i43" 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#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="i44" 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#setColumnFamilyTimeRange-byte:A-long-long-">setColumnFamilyTimeRange</a></span>(byte[] cf, long minStamp, @@ -663,145 +675,151 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title [minStamp, maxStamp) on a per CF bases.</div> </td> </tr> -<tr id="i45" class="rowColor"> +<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#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="i46" class="altColor"> +<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#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="i47" class="rowColor"> +<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#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="i48" class="altColor"> +<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#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="i49" class="rowColor"> +<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#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="i50" class="altColor"> +<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#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="i51" class="rowColor"> +<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#setLimit-int-">setLimit</a></span>(int limit)</code> <div class="block">Set the limit of rows for this scan.</div> </td> </tr> -<tr id="i52" 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#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="i53" class="rowColor"> +<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#setMaxResultSize-long-">setMaxResultSize</a></span>(long maxResultSize)</code> <div class="block">Set the maximum result size.</div> </td> </tr> -<tr id="i54" class="altColor"> +<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#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="i55" class="rowColor"> +<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#setMaxVersions--">setMaxVersions</a></span>()</code> -<div class="block">Get all available versions.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">It is easy to misunderstand with column family's max versions, so use + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readAllVersions--"><code>readAllVersions()</code></a> instead.</span></div> +</div> </td> </tr> -<tr id="i56" class="altColor"> +<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#setMaxVersions-int-">setMaxVersions</a></span>(int maxVersions)</code> -<div class="block">Get up to the specified number of versions of each column.</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">It is easy to misunderstand with column family's max versions, so use + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readVersions-int-"><code>readVersions(int)</code></a> instead.</span></div> +</div> </td> </tr> -<tr id="i57" class="rowColor"> +<tr id="i59" class="rowColor"> <td class="colFirst"><code>(package private) <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#setMvccReadPoint-long-">setMvccReadPoint</a></span>(long mvccReadPoint)</code> <div class="block">Set the mvcc read point used to open a scanner.</div> </td> </tr> -<tr id="i58" class="altColor"> +<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#setNeedCursorResult-boolean-">setNeedCursorResult</a></span>(boolean needCursorResult)</code> <div class="block">When the server is slow or we scan a table with many deleted data or we use a sparse filter, the server will response heartbeat to prevent timeout.</div> </td> </tr> -<tr id="i59" class="rowColor"> +<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#setOneRowLimit--">setOneRowLimit</a></span>()</code> <div class="block">Call this when you only want to get one row.</div> </td> </tr> -<tr id="i60" class="altColor"> +<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#setPriority-int-">setPriority</a></span>(int priority)</code> </td> </tr> -<tr id="i61" class="rowColor"> +<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#setRaw-boolean-">setRaw</a></span>(boolean raw)</code> <div class="block">Enable/disable "raw" mode for this scan.</div> </td> </tr> -<tr id="i62" class="altColor"> +<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#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="i63" class="rowColor"> +<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#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="i64" class="altColor"> +<tr id="i66" 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="i65" class="rowColor"> +<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#setRowOffsetPerColumnFamily-int-">setRowOffsetPerColumnFamily</a></span>(int offset)</code> <div class="block">Set offset for the row per Column Family.</div> </td> </tr> -<tr id="i66" class="altColor"> +<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#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="i67" class="rowColor"> +<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#setScanMetricsEnabled-boolean-">setScanMetricsEnabled</a></span>(boolean enabled)</code> <div class="block">Enable collection of <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanMetrics.html" title="class in org.apache.hadoop.hbase.client.metrics"><code>ScanMetrics</code></a>.</div> </td> </tr> -<tr id="i68" class="altColor"> +<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#setSmall-boolean-">setSmall</a></span>(boolean small)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> @@ -812,7 +830,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title </div> </td> </tr> -<tr id="i69" class="rowColor"> +<tr id="i71" 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"><span class="deprecatedLabel">Deprecated.</span> @@ -821,7 +839,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title </div> </td> </tr> -<tr id="i70" class="altColor"> +<tr id="i72" 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"><span class="deprecatedLabel">Deprecated.</span> @@ -830,7 +848,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title </div> </td> </tr> -<tr id="i71" class="rowColor"> +<tr id="i73" 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> @@ -838,45 +856,45 @@ extends <a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title [minStamp, maxStamp).</div> </td> </tr> -<tr id="i72" class="altColor"> +<tr id="i74" 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="i73" class="rowColor"> +<tr id="i75" 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="i74" class="altColor"> +<tr id="i76" 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="i75" class="rowColor"> +<tr id="i77" 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="i76" class="altColor"> +<tr id="i78" 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="i77" class="rowColor"> +<tr id="i79" 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="i78" class="altColor"> +<tr id="i80" 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> @@ -1695,7 +1713,10 @@ 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><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.600">setMaxVersions</a>()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">It is easy to misunderstand with column family's max versions, so use + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readAllVersions--"><code>readAllVersions()</code></a> instead.</span></div> <div class="block">Get all available versions.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1709,7 +1730,10 @@ 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><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.612">setMaxVersions</a>(int maxVersions)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">It is easy to misunderstand with column family's max versions, so use + <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readVersions-int-"><code>readVersions(int)</code></a> instead.</span></div> <div class="block">Get up to the specified number of versions of each column.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1719,13 +1743,43 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti </dl> </li> </ul> +<a name="readAllVersions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readAllVersions</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.620">readAllVersions</a>()</pre> +<div class="block">Get all available versions.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this</dd> +</dl> +</li> +</ul> +<a name="readVersions-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readVersions</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.630">readVersions</a>(int versions)</pre> +<div class="block">Get up to the specified number of versions of each column.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>versions</code> - specified number of versions for each column</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this</dd> +</dl> +</li> +</ul> <a name="setBatch-int-"> <!-- --> </a> <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.621">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.644">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 @@ -1745,7 +1799,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.635">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.658">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> @@ -1759,7 +1813,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.644">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.667">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> @@ -1773,7 +1827,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.656">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.679">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. @@ -1790,7 +1844,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.664">getMaxResultSize</a>()</pre> +<pre>public long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.687">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> @@ -1803,7 +1857,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.675">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.698">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> @@ -1819,11 +1873,11 @@ 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.681">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.704">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(org.apache.hadoop.hbase.Cell)</code></a> is called AFTER all tests - for ttl, column match, deletes and max versions have been run.</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(org.apache.hadoop.hbase.Cell)</code></a> is called AFTER all tests for ttl, + column match, deletes and column family's max versions have been run.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setFilter-org.apache.hadoop.hbase.filter.Filter-">setFilter</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> @@ -1840,7 +1894,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.691">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.714">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> @@ -1856,7 +1910,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.700">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.723">getFamilyMap</a>()</pre> <div class="block">Getting the familyMap</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -1870,7 +1924,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.707">numFamilies</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.730">numFamilies</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the number of families in familyMap</dd> @@ -1883,7 +1937,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.717">hasFamilies</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.740">hasFamilies</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if familyMap is non empty, false otherwise</dd> @@ -1896,7 +1950,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.724">getFamilies</a>()</pre> +<pre>public byte[][] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.747">getFamilies</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the keys of the familyMap</dd> @@ -1909,7 +1963,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.734">getStartRow</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.757">getStartRow</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the startrow</dd> @@ -1922,7 +1976,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.741">includeStartRow</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.764">includeStartRow</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>if we should include start row when scan</dd> @@ -1935,7 +1989,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.748">getStopRow</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.771">getStopRow</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the stoprow</dd> @@ -1948,7 +2002,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.755">includeStopRow</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.778">includeStopRow</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>if we should include stop row when scan</dd> @@ -1961,7 +2015,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.762">getMaxVersions</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.785">getMaxVersions</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the max number of versions to fetch</dd> @@ -1974,7 +2028,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.769">getBatch</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.792">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> @@ -1987,7 +2041,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.776">getMaxResultsPerColumnFamily</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.799">getMaxResultsPerColumnFamily</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>maximum number of values to return per row per CF</dd> @@ -2000,7 +2054,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.785">getRowOffsetPerColumnFamily</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.808">getRowOffsetPerColumnFamily</a>()</pre> <div class="block">Method for retrieving the scan's offset per row per column family (#kvs to be skipped)</div> <dl> @@ -2015,7 +2069,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.792">getCaching</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.815">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> @@ -2028,7 +2082,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.800">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.823">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> @@ -2043,7 +2097,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.807">hasFilter</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.830">hasFilter</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true is a filter has been specified, false if not</dd> @@ -2056,7 +2110,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.821">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.844">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 @@ -2075,7 +2129,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.831">getCacheBlocks</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.854">getCacheBlocks</a>()</pre> <div class="block">Get whether blocks should be cached for this Scan.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -2090,7 +2144,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.843">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.866">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> @@ -2108,7 +2162,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.852">isReversed</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.875">isReversed</a>()</pre> <div class="block">Get whether this scan is a reversed one.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -2122,7 +2176,7 @@ 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.866">setAllowPartialResults</a>(boolean allowPartialResults)</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.889">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 @@ -2144,7 +2198,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.876">getAllowPartialResults</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.899">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 @@ -2159,7 +2213,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.880">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.903">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. @@ -2187,7 +2241,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.891">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.914">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> @@ -2205,7 +2259,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.915">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.938">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> @@ -2225,7 +2279,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti <ul class="blockList"> <li class="blockList"> <h4>setRaw</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.978">setRaw</a>(boolean raw)</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.1001">setRaw</a>(boolean raw)</pre> <div class="block">Enable/disable "raw" mode for this scan. If "raw" is enabled the scan will return all delete marker and deleted rows that have not @@ -2245,7 +2299,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti <ul class="blockList"> <li class="blockList"> <h4>isRaw</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.986">isRaw</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1009">isRaw</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>True if this Scan is in "raw" mode.</dd> @@ -2259,7 +2313,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti <li class="blockList"> <h4>setSmall</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.1009">setSmall</a>(boolean small)</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.1032">setSmall</a>(boolean small)</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <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 @@ -2288,7 +2342,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" ti <li class="blockList"> <h4>isSmall</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 boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1021">isSmall</a>()</pre> +public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1044">isSmall</a>()</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <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 class="block">Get whether this scan is a small scan</div> <dl> @@ -2303,7 +2357,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setAttribute</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.1026">setAttribute</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> name, +<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.1049">setAttribute</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> name, byte[] value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/Attributes.html#setAttribute-java.lang.String-byte:A-">Attributes</a></code></span></div> <div class="block">Sets an attribute. @@ -2326,7 +2380,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setId</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.1031">setId</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> id)</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.1054">setId</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> id)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#setId-java.lang.String-">OperationWithAttributes</a></code></span></div> <div class="block">This method allows you to set an identifier on an operation. The original motivation for this was to allow the identifier to be used in slow query @@ -2347,7 +2401,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setAuthorizations</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.1036">setAuthorizations</a>(<a href="../../../../../org/apache/hadoop/hbase/security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a> authorizations)</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.1059">setAuthorizations</a>(<a href="../../../../../org/apache/hadoop/hbase/security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a> authorizations)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setAuthorizations-org.apache.hadoop.hbase.security.visibility.Authorizations-">Query</a></code></span></div> <div class="block">Sets the authorizations to be used by this Query</div> <dl> @@ -2362,7 +2416,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setACL</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.1041">setACL</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><<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="../../../../../org/apache/hadoop/hbase/security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>> perms)</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.1064">setACL</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><<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="../../../../../org/apache/hadoop/hbase/security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>> perms)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setACL-java.util.Map-">setACL</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> @@ -2377,7 +2431,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setACL</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.1046">setACL</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> user, +<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.1069">setACL</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> user, <a href="../../../../../org/apache/hadoop/hbase/security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a> perms)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> @@ -2394,7 +2448,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setConsistency</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.1051">setConsistency</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client">Consistency</a> consistency)</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.1074">setConsistency</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client">Consistency</a> consistency)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setConsistency-org.apache.hadoop.hbase.client.Consistency-">Query</a></code></span></div> <div class="block">Sets the consistency level for this operation</div> <dl> @@ -2411,7 +2465,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setReplicaId</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.1056">setReplicaId</a>(int Id)</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.1079">setReplicaId</a>(int Id)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setReplicaId-int-">Query</a></code></span></div> <div class="block">Specify region replica id where Query will fetch data from. Use this together with <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setConsistency-org.apache.hadoop.hbase.client.Consistency-"><code>Query.setConsistency(Consistency)</code></a> passing <a href="../../../../../org/apache/hadoop/hbase/client/Consistency.html#TIMELINE"><code>Consistency.TIMELINE</code></a> to read data from @@ -2429,7 +2483,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setIsolationLevel</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.1061">setIsolationLevel</a>(<a href="../../../../../org/apache/hadoop/hbase/client/IsolationLevel.html" title="enum in org.apache.hadoop.hbase.client">IsolationLevel</a> level)</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.1084">setIsolationLevel</a>(<a href="../../../../../org/apache/hadoop/hbase/client/IsolationLevel.html" title="enum in org.apache.hadoop.hbase.client">IsolationLevel</a> level)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setIsolationLevel-org.apache.hadoop.hbase.client.IsolationLevel-">Query</a></code></span></div> <div class="block">Set the isolation level for this query. If the isolation level is set to READ_UNCOMMITTED, then @@ -2453,7 +2507,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setPriority</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.1066">setPriority</a>(int priority)</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.1089">setPriority</a>(int priority)</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#setPriority-int-">setPriority</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd> @@ -2466,7 +2520,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>setScanMetricsEnabled</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.1074">setScanMetricsEnabled</a>(boolean enabled)</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.1097">setScanMetricsEnabled</a>(boolean enabled)</pre> <div class="block">Enable collection of <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanMetrics.html" title="class in org.apache.hadoop.hbase.client.metrics"><code>ScanMetrics</code></a>. For advanced users.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -2480,7 +2534,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <ul class="blockList"> <li class="blockList"> <h4>isScanMetricsEnabled</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1082">isScanMetricsEnabled</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1105">isScanMetricsEnabled</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>True if collection of scan metrics is enabled. For advanced users.</dd> @@ -2494,7 +2548,7 @@ public boolean <a href="../../../../../src-html/org/apache/hadoop/hbas <li class="blockList"> <h4>getScanMetrics</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/metrics/ScanMetrics.html" title="class in org.apache.hadoop.hbase.client.metrics">ScanMetrics</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1095">getScanMetrics</a>()</pre> +public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanMetrics.html" title="class in org.apache.hadoop.hbase.client.metrics">ScanMetrics</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1118">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> @@ -2512,7 +2566,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <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.1101">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.1124">isAsyncPrefetch</a>()</pre> </li> </ul> <a name="setAsyncPrefetch-boolean-"> @@ -2521,7 +2575,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <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.1105">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.1128">setAsyncPrefetch</a>(boolean asyncPrefetch)</pre> </li> </ul> <a name="getLimit--"> @@ -2530,7 +2584,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <ul class="blockList"> <li class="blockList"> <h4>getLimit</h4> -<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1113">getLimit</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1136">getLimit</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the limit of rows for this scan</dd> @@ -2543,7 +2597,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <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.1125">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.1148">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> @@ -2562,7 +2616,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <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.1135">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.1158">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> @@ -2577,7 +2631,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <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.1147">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.1170">getReadType</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the read type for this scan</dd> @@ -2590,7 +2644,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <ul class="blockList"> <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.1158">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.1181">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 @@ -2607,7 +2661,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <ul class="blockList"> <li class="blockList"> <h4>getMvccReadPoint</h4> -<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1166">getMvccReadPoint</a>()</pre> +<pre>long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1189">getMvccReadPoint</a>()</pre> <div class="block">Get the mvcc read point used to open a scanner.</div> </li> </ul> @@ -2617,7 +2671,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <ul class="blockList"> <li class="blockList"> <h4>setMvccReadPoint</h4> -<pre><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.1173">setMvccReadPoint</a>(long mvccReadPoint)</pre> +<pre><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.1196">setMvccReadPoint</a>(long mvccReadPoint)</pre> <div class="block">Set the mvcc read point used to open a scanner.</div> </li> </ul> @@ -2627,7 +2681,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/client/metrics/ScanM <ul class="blockList"> <li class="blockList"> <h4>resetMvccReadPoint</h4> -<pre><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.1181">resetMvccReadPoint</a>()</pre> +<pre><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>
<TRUNCATED>
