blob: 0a1353e5030af0d74ac70dcaa33e3a4a314a3756 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Scan (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Scan (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"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":42,"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":42,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":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";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Scan.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/client/RpcConnectionRegistry.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev&nbsp;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&nbsp;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>
<li><a href="Scan.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.client</div>
<h2 title="Class Scan" class="title">Class Scan</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/hadoop/hbase/client/Operation.html" title="class in org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client.Operation</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client.OperationWithAttributes</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">org.apache.hadoop.hbase.client.Query</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.client.Scan</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/client/Attributes.html" title="interface in org.apache.hadoop.hbase.client">Attributes</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/client/ImmutableScan.html" title="class in org.apache.hadoop.hbase.client">ImmutableScan</a>, <a href="../../../../../org/apache/hadoop/hbase/regionserver/InternalScan.html" title="class in org.apache.hadoop.hbase.regionserver">InternalScan</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Public
public class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.84">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.
<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.
<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.
<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>.
<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>
.
<p>
To limit the number of versions of each column to be returned, call <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readVersions-int-"><code>readVersions(int)</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>.
<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>
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">&nbsp;</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&nbsp;</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>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#allowPartialResults">allowPartialResults</a></span></code>
<div class="block">Partial <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s are <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s must be combined to form a complete <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="https://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#asyncPrefetch">asyncPrefetch</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#batch">batch</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#cacheBlocks">cacheBlocks</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#caching">caching</a></span></code>
<div class="block">-1 means no caching specified and the value of <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.HBASE_CLIENT_SCANNER_CACHING</code></a>
(default to <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#DEFAULT_HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.DEFAULT_HBASE_CLIENT_SCANNER_CACHING</code></a>) will be used</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></span></code>
<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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;byte[],<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;byte[]&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#familyMap">familyMap</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</a></span></code>
<div class="block">Parameter name for client scanner sync/async prefetch toggle.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#includeStartRow">includeStartRow</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#includeStopRow">includeStopRow</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#limit">limit</a></span></code>
<div class="block">The number of rows we want for this scan.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#LOG">LOG</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#maxResultSize">maxResultSize</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#maxVersions">maxVersions</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#mvccReadPoint">mvccReadPoint</a></span></code>
<div class="block">The mvcc read point to use when open a scanner.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#needCursorResult">needCursorResult</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#RAW_ATTR">RAW_ATTR</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <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#readType">readType</a></span></code>
<div class="block">Control whether to use pread at server side.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#reversed">reversed</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#SCAN_ATTRIBUTES_METRICS_ENABLE">SCAN_ATTRIBUTES_METRICS_ENABLE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#SCAN_ATTRIBUTES_TABLE_NAME">SCAN_ATTRIBUTES_TABLE_NAME</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#startRow">startRow</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#stopRow">stopRow</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#storeLimit">storeLimit</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#storeOffset">storeOffset</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#tr">tr</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.client.Query">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#colFamTimeRangeMap">colFamTimeRangeMap</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#consistency">consistency</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#filter">filter</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#loadColumnFamiliesOnDemand">loadColumnFamiliesOnDemand</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#targetReplicaId">targetReplicaId</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.client.OperationWithAttributes">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#ID_ATRIBUTE">ID_ATRIBUTE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#Scan--">Scan</a></span>()</code>
<div class="block">Create a Scan operation across all rows.</div>
</td>
</tr>
<tr class="rowColor">
<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>&nbsp;get)</code>
<div class="block">Builds a scan object with the same specs as get.</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.Scan-">Scan</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan)</code>
<div class="block">Creates a new instance of this class while copying all values.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" 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#addColumn-byte:A-byte:A-">addColumn</a></span>(byte[]&nbsp;family,
byte[]&nbsp;qualifier)</code>
<div class="block">Get the column from the specified family with the specified qualifier.</div>
</td>
</tr>
<tr id="i1" 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#addFamily-byte:A-">addFamily</a></span>(byte[]&nbsp;family)</code>
<div class="block">Get all columns from the specified family.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <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#createScanFromCursor-org.apache.hadoop.hbase.client.Cursor-">createScanFromCursor</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Cursor.html" title="class in org.apache.hadoop.hbase.client">Cursor</a>&nbsp;cursor)</code>
<div class="block">Create a new Scan with a cursor.</div>
</td>
</tr>
<tr id="i3" 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#getAllowPartialResults--">getAllowPartialResults</a></span>()</code>
<div class="block">Returns true when the constructor of this scan understands that the results they will see may
only represent a partial portion of a row.</div>
</td>
</tr>
<tr id="i4" 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#getBatch--">getBatch</a></span>()</code>
<div class="block">Returns maximum number of values to return for a single call to next()</div>
</td>
</tr>
<tr id="i5" 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#getCacheBlocks--">getCacheBlocks</a></span>()</code>
<div class="block">Get whether blocks should be cached for this Scan.</div>
</td>
</tr>
<tr id="i6" 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#getCaching--">getCaching</a></span>()</code>
<div class="block">Returns caching the number of rows fetched when calling next on a scanner</div>
</td>
</tr>
<tr id="i7" 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#getFamilies--">getFamilies</a></span>()</code>
<div class="block">Returns the keys of the familyMap</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;byte[],<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;byte[]&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getFamilyMap--">getFamilyMap</a></span>()</code>
<div class="block">Getting the familyMap</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getFilter--">getFilter</a></span>()</code>
<div class="block">Returns RowFilter</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getFingerprint--">getFingerprint</a></span>()</code>
<div class="block">Compile the table and column family (i.e.</div>
</td>
</tr>
<tr id="i11" 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#getLimit--">getLimit</a></span>()</code>
<div class="block">Returns the limit of rows for this scan</div>
</td>
</tr>
<tr id="i12" class="altColor">
<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>
<div class="block">Returns the maximum result size in bytes.</div>
</td>
</tr>
<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#getMaxResultsPerColumnFamily--">getMaxResultsPerColumnFamily</a></span>()</code>
<div class="block">Returns maximum number of values to return per row per CF</div>
</td>
</tr>
<tr id="i14" 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#getMaxVersions--">getMaxVersions</a></span>()</code>
<div class="block">Returns the max number of versions to fetch</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>(package private) long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getMvccReadPoint--">getMvccReadPoint</a></span>()</code>
<div class="block">Get the mvcc read point used to open a scanner.</div>
</td>
</tr>
<tr id="i16" 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>
<div class="block">Returns the read type for this scan</div>
</td>
</tr>
<tr id="i17" 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="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#getStartRow--">getStartRow</a></span>()</code>
<div class="block">Returns the startrow</div>
</td>
</tr>
<tr id="i19" 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#getStopRow--">getStopRow</a></span>()</code>
<div class="block">Returns the stoprow</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#getTimeRange--">getTimeRange</a></span>()</code>
<div class="block">Returns TimeRange</div>
</td>
</tr>
<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#hasFamilies--">hasFamilies</a></span>()</code>
<div class="block">Returns true if familyMap is non empty, false otherwise</div>
</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#hasFilter--">hasFilter</a></span>()</code>
<div class="block">Returns true is a filter has been specified, false if not</div>
</td>
</tr>
<tr id="i23" 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>
<div class="block">Returns if we should include start row when scan</div>
</td>
</tr>
<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#includeStopRow--">includeStopRow</a></span>()</code>
<div class="block">Returns if we should include stop row when scan</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://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>&nbsp;</td>
</tr>
<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#isGetScan--">isGetScan</a></span>()</code>&nbsp;</td>
</tr>
<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#isNeedCursorResult--">isNeedCursorResult</a></span>()</code>&nbsp;</td>
</tr>
<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#isRaw--">isRaw</a></span>()</code>
<div class="block">Returns True if this Scan is in "raw" mode.</div>
</td>
</tr>
<tr id="i29" 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#isReversed--">isReversed</a></span>()</code>
<div class="block">Get whether this scan is a reversed one.</div>
</td>
</tr>
<tr id="i30" 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#isScanMetricsEnabled--">isScanMetricsEnabled</a></span>()</code>
<div class="block">Returns True if collection of scan metrics is enabled.</div>
</td>
</tr>
<tr id="i31" 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>
<div class="block">Returns the number of families in familyMap</div>
</td>
</tr>
<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#readAllVersions--">readAllVersions</a></span>()</code>
<div class="block">Get all available versions.</div>
</td>
</tr>
<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#readVersions-int-">readVersions</a></span>(int&nbsp;versions)</code>
<div class="block">Get up to the specified number of versions of each column.</div>
</td>
</tr>
<tr id="i34" 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">
<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="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://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>&gt;&nbsp;perms)</code>
<div class="block">Set the ACL for the operation.</div>
</td>
</tr>
<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#setACL-java.lang.String-org.apache.hadoop.hbase.security.access.Permission-">setACL</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="../../../../../org/apache/hadoop/hbase/security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>&nbsp;perms)</code>
<div class="block">Set the ACL for the operation.</div>
</td>
</tr>
<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#setAllowPartialResults-boolean-">setAllowPartialResults</a></span>(boolean&nbsp;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">
<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&nbsp;asyncPrefetch)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Since 3.0.0, will be removed in 4.0.0. After building sync client upon async
client, the implementation is always 'async prefetch', so this flag is useless now.</span></div>
</div>
</td>
</tr>
<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#setAttribute-java.lang.String-byte:A-">setAttribute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
byte[]&nbsp;value)</code>
<div class="block">Sets an attribute.</div>
</td>
</tr>
<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#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>&nbsp;authorizations)</code>
<div class="block">Sets the authorizations to be used by this Query</div>
</td>
</tr>
<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#setBatch-int-">setBatch</a></span>(int&nbsp;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">
<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&nbsp;cacheBlocks)</code>
<div class="block">Set whether blocks should be cached for this Scan.</div>
</td>
</tr>
<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#setCaching-int-">setCaching</a></span>(int&nbsp;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">
<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[]&nbsp;cf,
long&nbsp;minStamp,
long&nbsp;maxStamp)</code>
<div class="block">Get versions of columns only within the specified timestamp range, [minStamp, maxStamp) on a
per CF bases.</div>
</td>
</tr>
<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#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>&nbsp;consistency)</code>
<div class="block">Sets the consistency level for this operation</div>
</td>
</tr>
<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#setFamilyMap-java.util.Map-">setFamilyMap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;byte[],<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;byte[]&gt;&gt;&nbsp;familyMap)</code>
<div class="block">Setting the familyMap</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#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>&nbsp;filter)</code>
<div class="block">Apply the specified server-side filter when performing the Query.</div>
</td>
</tr>
<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#setId-java.lang.String-">setId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>
<div class="block">This method allows you to set an identifier on an operation.</div>
</td>
</tr>
<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#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>&nbsp;level)</code>
<div class="block">Set the isolation level for this query.</div>
</td>
</tr>
<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#setLimit-int-">setLimit</a></span>(int&nbsp;limit)</code>
<div class="block">Set the limit of rows for this scan.</div>
</td>
</tr>
<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#setLoadColumnFamiliesOnDemand-boolean-">setLoadColumnFamiliesOnDemand</a></span>(boolean&nbsp;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="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#setMaxResultSize-long-">setMaxResultSize</a></span>(long&nbsp;maxResultSize)</code>
<div class="block">Set the maximum result size.</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#setMaxResultsPerColumnFamily-int-">setMaxResultsPerColumnFamily</a></span>(int&nbsp;limit)</code>
<div class="block">Set the maximum number of values to return per row per Column Family</div>
</td>
</tr>
<tr id="i54" 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#setMvccReadPoint-long-">setMvccReadPoint</a></span>(long&nbsp;mvccReadPoint)</code>
<div class="block">Set the mvcc read point used to open a scanner.</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#setNeedCursorResult-boolean-">setNeedCursorResult</a></span>(boolean&nbsp;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="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#setOneRowLimit--">setOneRowLimit</a></span>()</code>
<div class="block">Call this when you only want to get one row.</div>
</td>
</tr>
<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#setPriority-int-">setPriority</a></span>(int&nbsp;priority)</code>&nbsp;</td>
</tr>
<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#setRaw-boolean-">setRaw</a></span>(boolean&nbsp;raw)</code>
<div class="block">Enable/disable "raw" mode for this scan.</div>
</td>
</tr>
<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#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>&nbsp;readType)</code>
<div class="block">Set the read type for this scan.</div>
</td>
</tr>
<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#setReplicaId-int-">setReplicaId</a></span>(int&nbsp;Id)</code>
<div class="block">Specify region replica id where Query will fetch data from.</div>
</td>
</tr>
<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#setReversed-boolean-">setReversed</a></span>(boolean&nbsp;reversed)</code>
<div class="block">Set whether this scan is a reversed one</div>
</td>
</tr>
<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#setRowOffsetPerColumnFamily-int-">setRowOffsetPerColumnFamily</a></span>(int&nbsp;offset)</code>
<div class="block">Set offset for the row per Column Family.</div>
</td>
</tr>
<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#setRowPrefixFilter-byte:A-">setRowPrefixFilter</a></span>(byte[]&nbsp;rowPrefix)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 2.5.0, will be removed in 4.0.0. The name of this method is considered to be
confusing as it does not use a <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a> but uses setting the startRow and
stopRow instead. Use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setStartStopRowForPrefixScan-byte:A-"><code>setStartStopRowForPrefixScan(byte[])</code></a> instead.</span></div>
</div>
</td>
</tr>
<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#setScanMetricsEnabled-boolean-">setScanMetricsEnabled</a></span>(boolean&nbsp;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="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#setStartStopRowForPrefixScan-byte:A-">setStartStopRowForPrefixScan</a></span>(byte[]&nbsp;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="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#setTimeRange-long-long-">setTimeRange</a></span>(long&nbsp;minStamp,
long&nbsp;maxStamp)</code>
<div class="block">Get versions of columns only within the specified timestamp range, [minStamp, maxStamp).</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#setTimestamp-long-">setTimestamp</a></span>(long&nbsp;timestamp)</code>
<div class="block">Get versions of columns with the specified timestamp.</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#toMap-int-">toMap</a></span>(int&nbsp;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="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#withStartRow-byte:A-">withStartRow</a></span>(byte[]&nbsp;startRow)</code>
<div class="block">Set the start 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#withStartRow-byte:A-boolean-">withStartRow</a></span>(byte[]&nbsp;startRow,
boolean&nbsp;inclusive)</code>
<div class="block">Set the start row of the scan.</div>
</td>
</tr>
<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#withStopRow-byte:A-">withStopRow</a></span>(byte[]&nbsp;stopRow)</code>
<div class="block">Set the stop row of the scan.</div>
</td>
</tr>
<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#withStopRow-byte:A-boolean-">withStopRow</a></span>(byte[]&nbsp;stopRow,
boolean&nbsp;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">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#doLoadColumnFamiliesOnDemand--">doLoadColumnFamiliesOnDemand</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getACL--">getACL</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getAuthorizations--">getAuthorizations</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getColumnFamilyTimeRange--">getColumnFamilyTimeRange</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getConsistency--">getConsistency</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getIsolationLevel--">getIsolationLevel</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getLoadColumnFamiliesOnDemandValue--">getLoadColumnFamiliesOnDemandValue</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getReplicaId--">getReplicaId</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.OperationWithAttributes">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#getAttribute-java.lang.String-">getAttribute</a>, <a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#getAttributeSize--">getAttributeSize</a>, <a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#getAttributesMap--">getAttributesMap</a>, <a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#getId--">getId</a>, <a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#getPriority--">getPriority</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.client.Operation">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></h3>
<code><a href="../../../../../org/apache/hadoop/hbase/client/Operation.html#toJSON--">toJSON</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Operation.html#toJSON-int-">toJSON</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Operation.html#toMap--">toMap</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Operation.html#toString--">toString</a>, <a href="../../../../../org/apache/hadoop/hbase/client/Operation.html#toString-int-">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="LOG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOG</h4>
<pre>private static final&nbsp;org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.85">LOG</a></pre>
</li>
</ul>
<a name="RAW_ATTR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RAW_ATTR</h4>
<pre>private static final&nbsp;<a href="https://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.87">RAW_ATTR</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.RAW_ATTR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="startRow">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startRow</h4>
<pre>private&nbsp;byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.89">startRow</a></pre>
</li>
</ul>
<a name="includeStartRow">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includeStartRow</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.90">includeStartRow</a></pre>
</li>
</ul>
<a name="stopRow">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopRow</h4>
<pre>private&nbsp;byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.91">stopRow</a></pre>
</li>
</ul>
<a name="includeStopRow">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includeStopRow</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.92">includeStopRow</a></pre>
</li>
</ul>
<a name="maxVersions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxVersions</h4>
<pre>private&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.93">maxVersions</a></pre>
</li>
</ul>
<a name="batch">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batch</h4>
<pre>private&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.94">batch</a></pre>
</li>
</ul>
<a name="allowPartialResults">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowPartialResults</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.107">allowPartialResults</a></pre>
<div class="block">Partial <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s are <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s must be combined to form a complete <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>.
The <a href="../../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a>s had to be returned in fragments (i.e. as partials) because the size of the
cells in the row exceeded max result size on the server. Typically partial results will be
combined client side into complete results before being delivered to the caller. However, if
this flag is set, the caller is indicating that they do not mind seeing partial results (i.e.
they understand that the results returned from the Scanner may only represent part of a
particular row). In such a case, any attempt to combine the partials into a complete result on
the client side will be skipped, and the caller will be able to see the exact results returned
from the server.</div>
</li>
</ul>
<a name="storeLimit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeLimit</h4>
<pre>private&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.109">storeLimit</a></pre>
</li>
</ul>
<a name="storeOffset">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeOffset</h4>
<pre>private&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.110">storeOffset</a></pre>
</li>
</ul>
<a name="SCAN_ATTRIBUTES_METRICS_ENABLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SCAN_ATTRIBUTES_METRICS_ENABLE</h4>
<pre>private static final&nbsp;<a href="https://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.112">SCAN_ATTRIBUTES_METRICS_ENABLE</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_METRICS_ENABLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="SCAN_ATTRIBUTES_TABLE_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SCAN_ATTRIBUTES_TABLE_NAME</h4>
<pre>public static final&nbsp;<a href="https://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.117">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>
</dl>
</li>
</ul>
<a name="caching">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>caching</h4>
<pre>private&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.123">caching</a></pre>
<div class="block">-1 means no caching specified and the value of <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.HBASE_CLIENT_SCANNER_CACHING</code></a>
(default to <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#DEFAULT_HBASE_CLIENT_SCANNER_CACHING"><code>HConstants.DEFAULT_HBASE_CLIENT_SCANNER_CACHING</code></a>) will be used</div>
</li>
</ul>
<a name="maxResultSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxResultSize</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.124">maxResultSize</a></pre>
</li>
</ul>
<a name="cacheBlocks">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheBlocks</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.125">cacheBlocks</a></pre>
</li>
</ul>
<a name="reversed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reversed</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.126">reversed</a></pre>
</li>
</ul>
<a name="tr">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tr</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.127">tr</a></pre>
</li>
</ul>
<a name="familyMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>familyMap</h4>
<pre>private&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;byte[],<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;byte[]&gt;&gt; <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.128">familyMap</a></pre>
</li>
</ul>
<a name="asyncPrefetch">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asyncPrefetch</h4>
<pre>private&nbsp;<a href="https://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.130">asyncPrefetch</a></pre>
</li>
</ul>
<a name="HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</h4>
<pre>public static final&nbsp;<a href="https://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.137">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 Scan#setSmall or Scan#setReversed</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH</h4>
<pre>public static final&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.143">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>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.Scan.DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="mvccReadPoint">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mvccReadPoint</h4>
<pre>private&nbsp;long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.149">mvccReadPoint</a></pre>
<div class="block">The mvcc read point to use when open a scanner. Remember to clear it after switching regions as
the mvcc is only valid within region scope.</div>
</li>
</ul>
<a name="limit">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limit</h4>
<pre>private&nbsp;int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.155">limit</a></pre>
<div class="block">The number of rows we want for this scan. We will terminate the scan if the number of return
rows reaches this value.</div>
</li>
</ul>
<a name="readType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readType</h4>
<pre>private&nbsp;<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.160">readType</a></pre>
<div class="block">Control whether to use pread at server side.</div>
</li>
</ul>
<a name="needCursorResult">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>needCursorResult</h4>
<pre>private&nbsp;boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.162">needCursorResult</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Scan--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Scan</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.167">Scan</a>()</pre>
<div class="block">Create a Scan operation across all rows.</div>
</li>
</ul>
<a name="Scan-org.apache.hadoop.hbase.client.Scan-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Scan</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.175">Scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan)
throws <a href="https://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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scan</code> - The scan instance to copy from.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When copying the values fails.</dd>
</dl>
</li>
</ul>
<a name="Scan-org.apache.hadoop.hbase.client.Get-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Scan</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.226">Scan</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>&nbsp;get)</pre>
<div class="block">Builds a scan object with the same specs as get.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>get</code> - get to model scan after</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isGetScan--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGetScan</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.254">isGetScan</a>()</pre>
</li>
</ul>
<a name="addFamily-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFamily</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.265">addFamily</a>(byte[]&nbsp;family)</pre>
<div class="block">Get all columns from the specified family.
<p>
Overrides previous calls to addColumn for this family.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>family</code> - family name</dd>
</dl>
</li>
</ul>
<a name="addColumn-byte:A-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addColumn</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.278">addColumn</a>(byte[]&nbsp;family,
byte[]&nbsp;qualifier)</pre>
<div class="block">Get the column from the specified family with the specified qualifier.
<p>
Overrides previous calls to addFamily for this family.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>family</code> - family name</dd>
<dd><code>qualifier</code> - column qualifier</dd>
</dl>
</li>
</ul>
<a name="setTimeRange-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeRange</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.300">setTimeRange</a>(long&nbsp;minStamp,
long&nbsp;maxStamp)
throws <a href="https://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 only within the specified timestamp range, [minStamp, maxStamp). Note,
default maximum versions to return is 1. If your time range spans more than one version and you
want all versions returned, up the number of versions beyond the default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>minStamp</code> - minimum timestamp value, inclusive</dd>
<dd><code>maxStamp</code> - maximum timestamp value, exclusive</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readAllVersions--"><code>readAllVersions()</code></a>,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readVersions-int-"><code>readVersions(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setTimestamp-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimestamp</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.313">setTimestamp</a>(long&nbsp;timestamp)</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 and you want all versions returned, up the
number of versions beyond the defaut.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timestamp</code> - version timestamp</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readAllVersions--"><code>readAllVersions()</code></a>,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#readVersions-int-"><code>readVersions(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setColumnFamilyTimeRange-byte:A-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnFamilyTimeRange</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.326">setColumnFamilyTimeRange</a>(byte[]&nbsp;cf,
long&nbsp;minStamp,
long&nbsp;maxStamp)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setColumnFamilyTimeRange-byte:A-long-long-">Query</a></code></span></div>
<div class="block">Get versions of columns only within the specified timestamp range, [minStamp, maxStamp) on a
per CF bases. Note, default maximum versions to return is 1. If your time range spans more than
one version and you want all versions returned, up the number of versions beyond the default.
Column Family time ranges take precedence over the global time range.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setColumnFamilyTimeRange-byte:A-long-long-">setColumnFamilyTimeRange</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cf</code> - the column family for which you want to restrict</dd>
<dd><code>minStamp</code> - minimum timestamp value, inclusive</dd>
<dd><code>maxStamp</code> - maximum timestamp value, exclusive</dd>
</dl>
</li>
</ul>
<a name="withStartRow-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withStartRow</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.344">withStartRow</a>(byte[]&nbsp;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.
<p>
<b>Note:</b> <strong>Do NOT use this in combination with <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setRowPrefixFilter-byte:A-"><code>setRowPrefixFilter(byte[])</code></a> or
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setStartStopRowForPrefixScan-byte:A-"><code>setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result
unexpected or even undefined.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>startRow</code> - row to start scanner at or after</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.363">withStartRow</a>(byte[]&nbsp;startRow,
boolean&nbsp;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.
<p>
<b>Note:</b> <strong>Do NOT use this in combination with <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setRowPrefixFilter-byte:A-"><code>setRowPrefixFilter(byte[])</code></a> or
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setStartStopRowForPrefixScan-byte:A-"><code>setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result
unexpected or even undefined.
</p></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="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="withStopRow-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withStopRow</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.386">withStopRow</a>(byte[]&nbsp;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> <strong>Do NOT use this in combination with <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setRowPrefixFilter-byte:A-"><code>setRowPrefixFilter(byte[])</code></a> or
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setStartStopRowForPrefixScan-byte:A-"><code>setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result
unexpected or even undefined.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stopRow</code> - row to end at (exclusive)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.405">withStopRow</a>(byte[]&nbsp;stopRow,
boolean&nbsp;inclusive)</pre>
<div class="block">Set the stop row of the scan.
<p>
The scan will include rows that are lexicographically less than (or equal to if
<code>inclusive</code> is <code>true</code>) the provided stopRow.
<p>
<b>Note:</b> <strong>Do NOT use this in combination with <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setRowPrefixFilter-byte:A-"><code>setRowPrefixFilter(byte[])</code></a> or
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setStartStopRowForPrefixScan-byte:A-"><code>setStartStopRowForPrefixScan(byte[])</code></a>.</strong> Doing so will make the scan result
unexpected or even undefined.
</p></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="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://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="setRowPrefixFilter-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRowPrefixFilter</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.437">setRowPrefixFilter</a>(byte[]&nbsp;rowPrefix)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 2.5.0, will be removed in 4.0.0. The name of this method is considered to be
confusing as it does not use a <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a> but uses setting the startRow and
stopRow instead. Use <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setStartStopRowForPrefixScan-byte:A-"><code>setStartStopRowForPrefixScan(byte[])</code></a> instead.</span></div>
<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 for
the startRow and stopRow to achieve the desired result.
</p>
<p>
This can safely be used in combination with setFilter.
</p>
<p>
<strong>This CANNOT be used in combination with withStartRow and/or withStopRow.</strong> Such
a combination will yield unexpected and even undefined results.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowPrefix</code> - the prefix all rows must start with. (Set <i>null</i> to remove the filter.)</dd>
</dl>
</li>
</ul>
<a name="setStartStopRowForPrefixScan-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStartStopRowForPrefixScan</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.459">setStartStopRowForPrefixScan</a>(byte[]&nbsp;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 for
the startRow and stopRow to achieve the desired result.
</p>
<p>
This can safely be used in combination with setFilter.
</p>
<p>
<strong>This CANNOT be used in combination with withStartRow and/or withStopRow.</strong> Such
a combination will yield unexpected and even undefined results.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowPrefix</code> - the prefix all rows must start with. (Set <i>null</i> to remove the filter.)</dd>
</dl>
</li>
</ul>
<a name="readAllVersions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readAllVersions</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.473">readAllVersions</a>()</pre>
<div class="block">Get all available versions.</div>
</li>
</ul>
<a name="readVersions-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readVersions</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.482">readVersions</a>(int&nbsp;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>
</dl>
</li>
</ul>
<a name="setBatch-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBatch</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.496">setBatch</a>(int&nbsp;batch)</pre>
<div class="block">Set the maximum number of cells to return for each call to next(). Callers should be aware that
this is not equivalent to calling <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setAllowPartialResults-boolean-"><code>setAllowPartialResults(boolean)</code></a>. If you don't allow
partial results, the number of cells in each Result must equal to your batch setting unless it
is the last Result for current row. So this method is helpful in paging queries. If you just
want to prevent OOM at client, use setAllowPartialResults(true) is better.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>batch</code> - the maximum number of values</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/client/Result.html#mayHaveMoreCellsInRow--"><code>Result.mayHaveMoreCellsInRow()</code></a></dd>
</dl>
</li>
</ul>
<a name="setMaxResultsPerColumnFamily-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxResultsPerColumnFamily</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.509">setMaxResultsPerColumnFamily</a>(int&nbsp;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>
<dd><code>limit</code> - the maximum number of values returned / row / CF</dd>
</dl>
</li>
</ul>
<a name="setRowOffsetPerColumnFamily-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRowOffsetPerColumnFamily</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.518">setRowOffsetPerColumnFamily</a>(int&nbsp;offset)</pre>
<div class="block">Set offset for the row per Column Family.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offset</code> - is the number of kvs that will be skipped.</dd>
</dl>
</li>
</ul>
<a name="setCaching-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCaching</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.529">setCaching</a>(int&nbsp;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. Higher
caching values will enable faster scanners but will use more memory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>caching</code> - the number of rows for caching</dd>
</dl>
</li>
</ul>
<a name="getMaxResultSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxResultSize</h4>
<pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.535">getMaxResultSize</a>()</pre>
<div class="block">Returns the maximum result size in bytes. See <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setMaxResultSize-long-"><code>setMaxResultSize(long)</code></a></div>
</li>
</ul>
<a name="setMaxResultSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxResultSize</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.545">setMaxResultSize</a>(long&nbsp;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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxResultSize</code> - The maximum result size in bytes.</dd>
</dl>
</li>
</ul>
<a name="setFilter-org.apache.hadoop.hbase.filter.Filter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilter</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.551">setFilter</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>&nbsp;filter)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(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>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - filter to run on the server</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for invocation chaining</dd>
</dl>
</li>
</ul>
<a name="setFamilyMap-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFamilyMap</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.560">setFamilyMap</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;byte[],<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;byte[]&gt;&gt;&nbsp;familyMap)</pre>
<div class="block">Setting the familyMap</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>familyMap</code> - map of family to qualifier</dd>
</dl>
</li>
</ul>
<a name="getFamilyMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFamilyMap</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;byte[],<a href="https://docs.oracle.com/javase/8/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;byte[]&gt;&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.568">getFamilyMap</a>()</pre>
<div class="block">Getting the familyMap</div>
</li>
</ul>
<a name="numFamilies--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>numFamilies</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.573">numFamilies</a>()</pre>
<div class="block">Returns the number of families in familyMap</div>
</li>
</ul>
<a name="hasFamilies--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFamilies</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.581">hasFamilies</a>()</pre>
<div class="block">Returns true if familyMap is non empty, false otherwise</div>
</li>
</ul>
<a name="getFamilies--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFamilies</h4>
<pre>public&nbsp;byte[][]&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.586">getFamilies</a>()</pre>
<div class="block">Returns the keys of the familyMap</div>
</li>
</ul>
<a name="getStartRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartRow</h4>
<pre>public&nbsp;byte[]&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.594">getStartRow</a>()</pre>
<div class="block">Returns the startrow</div>
</li>
</ul>
<a name="includeStartRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includeStartRow</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.599">includeStartRow</a>()</pre>
<div class="block">Returns if we should include start row when scan</div>
</li>
</ul>
<a name="getStopRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStopRow</h4>
<pre>public&nbsp;byte[]&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.604">getStopRow</a>()</pre>
<div class="block">Returns the stoprow</div>
</li>
</ul>
<a name="includeStopRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includeStopRow</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.609">includeStopRow</a>()</pre>
<div class="block">Returns if we should include stop row when scan</div>
</li>
</ul>
<a name="getMaxVersions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxVersions</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.614">getMaxVersions</a>()</pre>
<div class="block">Returns the max number of versions to fetch</div>
</li>
</ul>
<a name="getBatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatch</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.619">getBatch</a>()</pre>
<div class="block">Returns maximum number of values to return for a single call to next()</div>
</li>
</ul>
<a name="getMaxResultsPerColumnFamily--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxResultsPerColumnFamily</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.624">getMaxResultsPerColumnFamily</a>()</pre>
<div class="block">Returns maximum number of values to return per row per CF</div>
</li>
</ul>
<a name="getRowOffsetPerColumnFamily--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowOffsetPerColumnFamily</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.632">getRowOffsetPerColumnFamily</a>()</pre>
<div class="block">Method for retrieving the scan's offset per row per column family (#kvs to be skipped)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>row offset</dd>
</dl>
</li>
</ul>
<a name="getCaching--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCaching</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.637">getCaching</a>()</pre>
<div class="block">Returns caching the number of rows fetched when calling next on a scanner</div>
</li>
</ul>
<a name="getTimeRange--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeRange</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/io/TimeRange.html" title="class in org.apache.hadoop.hbase.io">TimeRange</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.642">getTimeRange</a>()</pre>
<div class="block">Returns TimeRange</div>
</li>
</ul>
<a name="getFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.648">getFilter</a>()</pre>
<div class="block">Returns RowFilter</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#getFilter--">getFilter</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
</dl>
</li>
</ul>
<a name="hasFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFilter</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.653">hasFilter</a>()</pre>
<div class="block">Returns true is a filter has been specified, false if not</div>
</li>
</ul>
<a name="setCacheBlocks-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCacheBlocks</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.664">setCacheBlocks</a>(boolean&nbsp;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 family are used (this
will never override caching blocks if the block cache is disabled for that family or entirely).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheBlocks</code> - if false, default settings are overridden and blocks will not be cached</dd>
</dl>
</li>
</ul>
<a name="getCacheBlocks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheBlocks</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.673">getCacheBlocks</a>()</pre>
<div class="block">Get whether blocks should be cached for this Scan.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if default caching should be used, false if blocks should not be cached</dd>
</dl>
</li>
</ul>
<a name="setReversed-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReversed</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.683">setReversed</a>(boolean&nbsp;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>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reversed</code> - if true, scan will be backward order</dd>
</dl>
</li>
</ul>
<a name="isReversed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReversed</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.692">isReversed</a>()</pre>
<div class="block">Get whether this scan is a reversed one.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if backward scan, false if forward(default) scan</dd>
</dl>
</li>
</ul>
<a name="setAllowPartialResults-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowPartialResults</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.704">setAllowPartialResults</a>(boolean&nbsp;allowPartialResults)</pre>
<div class="block">Setting whether the caller wants to see the partial results when server returns
less-than-expected cells. It is helpful while scanning a huge row to prevent OOM at client. By
default this value is false and the complete results will be assembled client side before being
delivered to the caller.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/client/Result.html#mayHaveMoreCellsInRow--"><code>Result.mayHaveMoreCellsInRow()</code></a>,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html#setBatch-int-"><code>setBatch(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="getAllowPartialResults--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowPartialResults</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.714">getAllowPartialResults</a>()</pre>
<div class="block">Returns true when the constructor of this scan understands that the results they will see may
only represent a partial portion of a row. The entire row would be retrieved by subsequent
calls to <a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html#next--"><code>ResultScanner.next()</code></a></div>
</li>
</ul>
<a name="setLoadColumnFamiliesOnDemand-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoadColumnFamiliesOnDemand</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.719">setLoadColumnFamiliesOnDemand</a>(boolean&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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. if you filter
on one column, the other column family data will be loaded only for the rows that are included
in result, not all rows like in normal case. With column-specific filters, like
SingleColumnValueFilter w/filterIfMissing == true, this can deliver huge perf gains when
there's a cf with lots of data; however, it can also lead to some inconsistent results, as
follows: - if someone does a concurrent update to both column families in question you may get
a row that never existed, e.g. for { rowKey = 5, { cat_videos =&gt; 1 }, { video =&gt; "my cat"
} } someone puts rowKey 5 with { cat_videos =&gt; 0 }, { video =&gt; "my dog" }, concurrent
scan filtering on "cat_videos == 1" can get { rowKey = 5, { cat_videos =&gt; 1 }, { video =&gt;
"my dog" } }. - if there's a concurrent split and you have more than 2 column families, some
rows may be missing some column families.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setLoadColumnFamiliesOnDemand-boolean-">setLoadColumnFamiliesOnDemand</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
</dl>
</li>
</ul>
<a name="getFingerprint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFingerprint</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.728">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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Operation.html#getFingerprint--">getFingerprint</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map containing fingerprint information (i.e. column families)</dd>
</dl>
</li>
</ul>
<a name="toMap-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toMap</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.750">toMap</a>(int&nbsp;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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Operation.html#toMap-int-">toMap</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Operation.html" title="class in org.apache.hadoop.hbase.client">Operation</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxCols</code> - a limit on the number of columns output prior to truncation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map containing parameters of a query (i.e. rows, columns...)</dd>
</dl>
</li>
</ul>
<a name="setRaw-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRaw</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.837">setRaw</a>(boolean&nbsp;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 been collected, yet. This is mostly useful for Scan on
column families that have KEEP_DELETED_ROWS enabled. It is an error to specify any column when
"raw" is set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>raw</code> - True/False to enable/disable "raw" mode.</dd>
</dl>
</li>
</ul>
<a name="isRaw--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRaw</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.843">isRaw</a>()</pre>
<div class="block">Returns True if this Scan is in "raw" mode.</div>
</li>
</ul>
<a name="setAttribute-java.lang.String-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttribute</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.849">setAttribute</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
byte[]&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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. In case value = null attribute is removed from the attributes map. Attribute
names starting with _ indicate system attributes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Attributes.html#setAttribute-java.lang.String-byte:A-">setAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Attributes.html" title="interface in org.apache.hadoop.hbase.client">Attributes</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#setAttribute-java.lang.String-byte:A-">setAttribute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - attribute name</dd>
<dd><code>value</code> - attribute value</dd>
</dl>
</li>
</ul>
<a name="setId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.854">setId</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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 logging, but this could obviously be
useful in other places. One use of this could be to put a class.method identifier in here to
see where the slow query is coming from. id to set for the scan</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html#setId-java.lang.String-">setId</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd>
</dl>
</li>
</ul>
<a name="setAuthorizations-org.apache.hadoop.hbase.security.visibility.Authorizations-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthorizations</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.859">setAuthorizations</a>(<a href="../../../../../org/apache/hadoop/hbase/security/visibility/Authorizations.html" title="class in org.apache.hadoop.hbase.security.visibility">Authorizations</a>&nbsp;authorizations)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setAuthorizations-org.apache.hadoop.hbase.security.visibility.Authorizations-">setAuthorizations</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
</dl>
</li>
</ul>
<a name="setACL-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setACL</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.864">setACL</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://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>&gt;&nbsp;perms)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setACL-java.util.Map-">Query</a></code></span></div>
<div class="block">Set the ACL for the operation.</div>
<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>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>perms</code> - A map of permissions for a user or users</dd>
</dl>
</li>
</ul>
<a name="setACL-java.lang.String-org.apache.hadoop.hbase.security.access.Permission-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setACL</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.869">setACL</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="../../../../../org/apache/hadoop/hbase/security/access/Permission.html" title="class in org.apache.hadoop.hbase.security.access">Permission</a>&nbsp;perms)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setACL-java.lang.String-org.apache.hadoop.hbase.security.access.Permission-">Query</a></code></span></div>
<div class="block">Set the ACL for the operation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setACL-java.lang.String-org.apache.hadoop.hbase.security.access.Permission-">setACL</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - User short name</dd>
<dd><code>perms</code> - Permissions for the user</dd>
</dl>
</li>
</ul>
<a name="setConsistency-org.apache.hadoop.hbase.client.Consistency-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConsistency</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.874">setConsistency</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client">Consistency</a>&nbsp;consistency)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setConsistency-org.apache.hadoop.hbase.client.Consistency-">setConsistency</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consistency</code> - the consistency level</dd>
</dl>
</li>
</ul>
<a name="setReplicaId-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReplicaId</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.879">setReplicaId</a>(int&nbsp;Id)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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 a
specific replicaId. <br>
<b> Expert: </b>This is an advanced API exposed. Only use it if you know what you are doing</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setReplicaId-int-">setReplicaId</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
</dl>
</li>
</ul>
<a name="setIsolationLevel-org.apache.hadoop.hbase.client.IsolationLevel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsolationLevel</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.884">setIsolationLevel</a>(<a href="../../../../../org/apache/hadoop/hbase/client/IsolationLevel.html" title="enum in org.apache.hadoop.hbase.client">IsolationLevel</a>&nbsp;level)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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
this query will return data from committed and uncommitted transactions. If the isolation level
is set to READ_COMMITTED, then this query will return data from committed transactions only. If
a isolation level is not explicitly set on a Query, then it is assumed to be READ_COMMITTED.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html#setIsolationLevel-org.apache.hadoop.hbase.client.IsolationLevel-">setIsolationLevel</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/Query.html" title="class in org.apache.hadoop.hbase.client">Query</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>level</code> - IsolationLevel for this query</dd>
</dl>
</li>
</ul>
<a name="setPriority-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPriority</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.889">setPriority</a>(int&nbsp;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>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/client/OperationWithAttributes.html" title="class in org.apache.hadoop.hbase.client">OperationWithAttributes</a></code></dd>
</dl>
</li>
</ul>
<a name="setScanMetricsEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScanMetricsEnabled</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.897">setScanMetricsEnabled</a>(boolean&nbsp;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>
<dd><code>enabled</code> - Set to true to enable accumulating scan metrics</dd>
</dl>
</li>
</ul>
<a name="isScanMetricsEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isScanMetricsEnabled</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.903">isScanMetricsEnabled</a>()</pre>
<div class="block">Returns True if collection of scan metrics is enabled. For advanced users.</div>
</li>
</ul>
<a name="isAsyncPrefetch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAsyncPrefetch</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.908">isAsyncPrefetch</a>()</pre>
</li>
</ul>
<a name="setAsyncPrefetch-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAsyncPrefetch</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.917">setAsyncPrefetch</a>(boolean&nbsp;asyncPrefetch)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Since 3.0.0, will be removed in 4.0.0. After building sync client upon async
client, the implementation is always 'async prefetch', so this flag is useless now.</span></div>
</li>
</ul>
<a name="getLimit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLimit</h4>
<pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.923">getLimit</a>()</pre>
<div class="block">Returns the limit of rows for this scan</div>
</li>
</ul>
<a name="setLimit-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLimit</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.934">setLimit</a>(int&nbsp;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>
This condition will be tested at last, after all other conditions such as stopRow, filter, etc.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>limit</code> - the limit of rows for this scan</dd>
</dl>
</li>
</ul>
<a name="setOneRowLimit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOneRowLimit</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.943">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>
</li>
</ul>
<a name="getReadType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.955">getReadType</a>()</pre>
<div class="block">Returns the read type for this scan</div>
</li>
</ul>
<a name="setReadType-org.apache.hadoop.hbase.client.Scan.ReadType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.965">setReadType</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client">Scan.ReadType</a>&nbsp;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
example, we will always use pread if this is a get scan.</div>
</li>
</ul>
<a name="getMvccReadPoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMvccReadPoint</h4>
<pre>long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.973">getMvccReadPoint</a>()</pre>
<div class="block">Get the mvcc read point used to open a scanner.</div>
</li>
</ul>
<a name="setMvccReadPoint-long-">
<!-- -->
</a>
<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>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.980">setMvccReadPoint</a>(long&nbsp;mvccReadPoint)</pre>
<div class="block">Set the mvcc read point used to open a scanner.</div>
</li>
</ul>
<a name="resetMvccReadPoint--">
<!-- -->
</a>
<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>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.988">resetMvccReadPoint</a>()</pre>
<div class="block">Set the mvcc read point to -1 which means do not use it.</div>
</li>
</ul>
<a name="setNeedCursorResult-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNeedCursorResult</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1005">setNeedCursorResult</a>(boolean&nbsp;needCursorResult)</pre>
<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. However the scanner will return a Result
only when client can do it. So if there are many heartbeats, the blocking time on
ResultScanner#next() may be very long, which is not friendly to online services. Set this to
true then you can get a special Result whose #isCursor() returns true and is not contains any
real data. It only tells you where the server has scanned. You can call next to continue
scanning or open a new scanner with this row key as start row whenever you want. Users can get
a cursor when and only when there is a response from the server but we can not return a Result
to users, for example, this response is a heartbeat or there are partial cells but users do not
allow partial result. Now the cursor is in row level which means the special Result will only
contains a row key. <a href="../../../../../org/apache/hadoop/hbase/client/Result.html#isCursor--"><code>Result.isCursor()</code></a> <a href="../../../../../org/apache/hadoop/hbase/client/Result.html#getCursor--"><code>Result.getCursor()</code></a> <a href="../../../../../org/apache/hadoop/hbase/client/Cursor.html" title="class in org.apache.hadoop.hbase.client"><code>Cursor</code></a></div>
</li>
</ul>
<a name="isNeedCursorResult--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNeedCursorResult</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1010">isNeedCursorResult</a>()</pre>
</li>
</ul>
<a name="createScanFromCursor-org.apache.hadoop.hbase.client.Cursor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createScanFromCursor</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/client/Scan.html#line.1019">createScanFromCursor</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Cursor.html" title="class in org.apache.hadoop.hbase.client">Cursor</a>&nbsp;cursor)</pre>
<div class="block">Create a new Scan with a cursor. It only set the position information like start row key. The
others (like cfs, stop row, limit) should still be filled in by the user.
<a href="../../../../../org/apache/hadoop/hbase/client/Result.html#isCursor--"><code>Result.isCursor()</code></a> <a href="../../../../../org/apache/hadoop/hbase/client/Result.html#getCursor--"><code>Result.getCursor()</code></a> <a href="../../../../../org/apache/hadoop/hbase/client/Cursor.html" title="class in org.apache.hadoop.hbase.client"><code>Cursor</code></a></div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Scan.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/client/RpcConnectionRegistry.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Prev&nbsp;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&nbsp;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>
<li><a href="Scan.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>