| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StoreFileScanner (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.regionserver, class: StoreFileScanner"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/StoreFileScanner.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.regionserver</a></div> |
| <h1 title="Class StoreFileScanner" class="title">Class StoreFileScanner</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.regionserver.StoreFileScanner</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code>, <code><a href="Shipper.html" title="interface in org.apache.hadoop.hbase.regionserver">Shipper</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@LimitedPrivate("Phoenix") |
| @Evolving |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-47">StoreFileScanner</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></span></div> |
| <div class="block">KeyValueScanner adaptor over the Reader. It also provides hooks into bloom filter things.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#canOptimizeForNonNullColumn" class="member-name-link">canOptimizeForNonNullColumn</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#closed" class="member-name-link">closed</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#cur" class="member-name-link">cur</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#delayedReseek" class="member-name-link">delayedReseek</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#delayedSeekKV" class="member-name-link">delayedSeekKV</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#enforceMVCC" class="member-name-link">enforceMVCC</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#hasMVCCInfo" class="member-name-link">hasMVCCInfo</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final <a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileScanner</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#hfs" class="member-name-link">hfs</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#isFastSeekingEncoding" class="member-name-link">isFastSeekingEncoding</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="../Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#previousRow" class="member-name-link">previousRow</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final <a href="StoreFileReader.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileReader</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#reader" class="member-name-link">reader</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#readPt" class="member-name-link">readPt</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#realSeekDone" class="member-name-link">realSeekDone</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#scannerOrder" class="member-name-link">scannerOrder</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/LongAdder.html" title="class or interface in java.util.concurrent.atomic" class="external-link">LongAdder</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#seekCount" class="member-name-link">seekCount</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#stopSkippingKVsIfNextRow" class="member-name-link">stopSkippingKVsIfNextRow</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.regionserver.KeyValueScanner">Fields inherited from interface org.apache.hadoop.hbase.regionserver.<a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></h3> |
| <code><a href="KeyValueScanner.html#NO_NEXT_INDEXED_KEY">NO_NEXT_INDEXED_KEY</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.regionserver.StoreFileReader,org.apache.hadoop.hbase.io.hfile.HFileScanner,boolean,boolean,long,long,boolean,boolean)" class="member-name-link">StoreFileScanner</a><wbr>(<a href="StoreFileReader.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileReader</a> reader, |
| <a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileScanner</a> hfs, |
| boolean useMVCC, |
| boolean hasMVCC, |
| long readPt, |
| long scannerOrder, |
| boolean canOptimizeForNonNullColumn, |
| boolean isFastSeekingEncoding)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Implements a <a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver"><code>KeyValueScanner</code></a> on top of the specified <a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile"><code>HFileScanner</code></a></div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">backwardSeek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Seek the scanner at or before the row of specified Cell, it firstly tries to seek the scanner |
| at or after the specified Cell, return if peek KeyValue of scanner has the same row with |
| specified Cell, otherwise seek the scanner at the first Cell of the row which is the previous |
| row of specified KeyValue</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Close the KeyValue scanner.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enforceSeek()" class="member-name-link">enforceSeek</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Does the real seek operation in case it was skipped by seekToRowCol(KeyValue, boolean) (TODO: |
| Whats this?).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComparator()" class="member-name-link">getComparator</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFilePath()" class="member-name-link">getFilePath</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNextIndexedKey()" class="member-name-link">getNextIndexedKey</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="StoreFileReader.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileReader</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReader()" class="member-name-link">getReader</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScannerOrder()" class="member-name-link">getScannerOrder</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the order of this KeyValueScanner.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="StoreFileScanner.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileScanner</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getScannersForCompaction(java.util.Collection,boolean,long)" class="member-name-link">getScannersForCompaction</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> files, |
| boolean canUseDropBehind, |
| long readPt)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get scanners for compaction.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="StoreFileScanner.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileScanner</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getScannersForStoreFiles(java.util.Collection,boolean,boolean,boolean,boolean,long)" class="member-name-link">getScannersForStoreFiles</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> files, |
| boolean cacheBlocks, |
| boolean usePread, |
| boolean isCompaction, |
| boolean useDropBehind, |
| long readPt)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Return an array of scanners corresponding to the given set of store files.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="StoreFileScanner.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileScanner</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getScannersForStoreFiles(java.util.Collection,boolean,boolean,boolean,boolean,org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher,long)" class="member-name-link">getScannersForStoreFiles</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> files, |
| boolean cacheBlocks, |
| boolean usePread, |
| boolean isCompaction, |
| boolean canUseDrop, |
| <a href="querymatcher/ScanQueryMatcher.html" title="class in org.apache.hadoop.hbase.regionserver.querymatcher">ScanQueryMatcher</a> matcher, |
| long readPt)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Return an array of scanners corresponding to the given set of store files, And set the |
| ScanQueryMatcher for each store file scanner for further optimization</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static final long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSeekCount()" class="member-name-link">getSeekCount</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static final void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#instrument()" class="member-name-link">instrument</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFileScanner()" class="member-name-link">isFileScanner</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if this is a file scanner.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isStillAtSeekTargetAfterSkippingNewerKvs(org.apache.hadoop.hbase.Cell)" class="member-name-link">isStillAtSeekTargetAfterSkippingNewerKvs</a><wbr>(<a href="../Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> seekKey)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the next Cell in this scanner, iterating the scanner</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#peek()" class="member-name-link">peek</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Look at the next Cell in this scanner, but do not iterate scanner.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#realSeekDone()" class="member-name-link">realSeekDone</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">We optimize our store scanners by checking the most recent store file first, so we sometimes |
| pretend we have done a seek but delay it until the store scanner bubbles up to the top of the |
| key-value heap.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recordBlockSize(java.util.function.IntConsumer)" class="member-name-link">recordBlockSize</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/IntConsumer.html" title="class or interface in java.util.function" class="external-link">IntConsumer</a> blockSizeConsumer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Record the size of the current block in bytes, passing as an argument to the blockSizeConsumer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)" class="member-name-link">requestSeek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> kv, |
| boolean forward, |
| boolean useBloom)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Pretend we have done a seek but don't do it yet, if possible.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reseek(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">reseek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reseek the scanner at or after the specified KeyValue.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reseekAtOrAfter(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">reseekAtOrAfter</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekKey)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#reseekAtOrAfter(org.apache.hadoop.hbase.io.hfile.HFileScanner,org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">reseekAtOrAfter</a><wbr>(<a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileScanner</a> s, |
| <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> k)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seek(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Seek the scanner at or after the specified KeyValue.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekAtOrAfter(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seekAtOrAfter</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekKey)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#seekAtOrAfter(org.apache.hadoop.hbase.io.hfile.HFileScanner,org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seekAtOrAfter</a><wbr>(<a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileScanner</a> s, |
| <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> k)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns false if not found or if k is after the end.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekBefore(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seekBefore</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekKey)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekBeforeAndSaveKeyToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seekBeforeAndSaveKeyToPreviousRow</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekKey)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Seeks before the seek target cell and saves the location to <a href="#previousRow"><code>previousRow</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekToLastRow()" class="member-name-link">seekToLastRow</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Seek the scanner at the first KeyValue of last row</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seekToPreviousRow</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> originalKey)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Seek the scanner at the first Cell of the row which is the previous row of specified key</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekToPreviousRowStateless(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seekToPreviousRowStateless</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> originalKey)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This variant of the <code>StoreFileScanner#seekToPreviousRow(Cell)</code> method requires two seeks.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekToPreviousRowWithHint()" class="member-name-link">seekToPreviousRowWithHint</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This variant of the <code>StoreFileScanner#seekToPreviousRow(Cell)</code> method requires one seek |
| and one reseek.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekToPreviousRowWithoutHint(org.apache.hadoop.hbase.Cell)" class="member-name-link">seekToPreviousRowWithoutHint</a><wbr>(<a href="../Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> originalKey)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This variant of the <code>StoreFileScanner#seekToPreviousRow(Cell)</code> method requires two seeks |
| and one reseek.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentCell(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">setCurrentCell</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> newVal)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shipped()" class="member-name-link">shipped</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Called after a batch of rows scanned and set to be returned to client.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldUseScanner(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.regionserver.HStore,long)" class="member-name-link">shouldUseScanner</a><wbr>(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, |
| <a href="HStore.html" title="class in org.apache.hadoop.hbase.regionserver">HStore</a> store, |
| long oldestUnexpiredTS)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Allows to filter out scanners (both StoreFile and memstore) that we don't want to use based on |
| criteria such as Bloom filters and timestamp ranges.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#skipKVsNewerThanReadpoint()" class="member-name-link">skipKVsNewerThanReadpoint</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#skipKvsNewerThanReadpointReversed()" class="member-name-link">skipKvsNewerThanReadpointReversed</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="reader"> |
| <h3>reader</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="StoreFileReader.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileReader</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-51">reader</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hfs"> |
| <h3>hfs</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileScanner</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-52">hfs</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cur"> |
| <h3>cur</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-53">cur</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closed"> |
| <h3>closed</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-54">closed</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="realSeekDone"> |
| <h3>realSeekDone</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-56">realSeekDone</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delayedReseek"> |
| <h3>delayedReseek</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-57">delayedReseek</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delayedSeekKV"> |
| <h3>delayedSeekKV</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-58">delayedSeekKV</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enforceMVCC"> |
| <h3>enforceMVCC</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-60">enforceMVCC</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasMVCCInfo"> |
| <h3>hasMVCCInfo</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-61">hasMVCCInfo</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stopSkippingKVsIfNextRow"> |
| <h3>stopSkippingKVsIfNextRow</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-64">stopSkippingKVsIfNextRow</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="previousRow"> |
| <h3>previousRow</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-66">previousRow</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFastSeekingEncoding"> |
| <h3>isFastSeekingEncoding</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-71">isFastSeekingEncoding</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekCount"> |
| <h3>seekCount</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/LongAdder.html" title="class or interface in java.util.concurrent.atomic" class="external-link">LongAdder</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-73">seekCount</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="canOptimizeForNonNullColumn"> |
| <h3>canOptimizeForNonNullColumn</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-75">canOptimizeForNonNullColumn</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readPt"> |
| <h3>readPt</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-77">readPt</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scannerOrder"> |
| <h3>scannerOrder</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-81">scannerOrder</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.regionserver.StoreFileReader,org.apache.hadoop.hbase.io.hfile.HFileScanner,boolean,boolean,long,long,boolean,boolean)"> |
| <h3>StoreFileScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-98">StoreFileScanner</a></span><wbr><span class="parameters">(<a href="StoreFileReader.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileReader</a> reader, |
| <a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileScanner</a> hfs, |
| boolean useMVCC, |
| boolean hasMVCC, |
| long readPt, |
| long scannerOrder, |
| boolean canOptimizeForNonNullColumn, |
| boolean isFastSeekingEncoding)</span></div> |
| <div class="block">Implements a <a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver"><code>KeyValueScanner</code></a> on top of the specified <a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile"><code>HFileScanner</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>useMVCC</code> - If true, scanner will filter out updates with MVCC larger |
| than <code>readPt</code>.</dd> |
| <dd><code>readPt</code> - MVCC value to use to filter out the updates newer than this |
| scanner.</dd> |
| <dd><code>hasMVCC</code> - Set to true if underlying store file reader has MVCC info.</dd> |
| <dd><code>scannerOrder</code> - Order of the scanner relative to other scanners. See |
| <a href="KeyValueScanner.html#getScannerOrder()"><code>KeyValueScanner.getScannerOrder()</code></a>.</dd> |
| <dd><code>canOptimizeForNonNullColumn</code> - <code>true</code> if we can make sure there is no null column, |
| otherwise <code>false</code>. This is a hint for optimization.</dd> |
| <dd><code>isFastSeekingEncoding</code> - <code>true</code> if the data block encoding can seek quickly |
| from the beginning of a block (i.e. RIV1), otherwise |
| <code>false</code>. This is a hint for optimization.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getScannersForStoreFiles(java.util.Collection,boolean,boolean,boolean,boolean,long)"> |
| <h3>getScannersForStoreFiles</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="StoreFileScanner.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileScanner</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-115">getScannersForStoreFiles</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> files, |
| boolean cacheBlocks, |
| boolean usePread, |
| boolean isCompaction, |
| boolean useDropBehind, |
| long readPt)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Return an array of scanners corresponding to the given set of store files.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScannersForStoreFiles(java.util.Collection,boolean,boolean,boolean,boolean,org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher,long)"> |
| <h3>getScannersForStoreFiles</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="StoreFileScanner.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileScanner</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-126">getScannersForStoreFiles</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> files, |
| boolean cacheBlocks, |
| boolean usePread, |
| boolean isCompaction, |
| boolean canUseDrop, |
| <a href="querymatcher/ScanQueryMatcher.html" title="class in org.apache.hadoop.hbase.regionserver.querymatcher">ScanQueryMatcher</a> matcher, |
| long readPt)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Return an array of scanners corresponding to the given set of store files, And set the |
| ScanQueryMatcher for each store file scanner for further optimization</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScannersForCompaction(java.util.Collection,boolean,long)"> |
| <h3>getScannersForCompaction</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="StoreFileScanner.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileScanner</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-169">getScannersForCompaction</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> files, |
| boolean canUseDropBehind, |
| long readPt)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Get scanners for compaction. We will create a separated reader for each store file to avoid |
| contention with normal read request.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-191">toString</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="peek()"> |
| <h3>peek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-196">peek</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#peek()">KeyValueScanner</a></code></span></div> |
| <div class="block">Look at the next Cell in this scanner, but do not iterate scanner. NOTICE: The returned cell |
| has not been passed into ScanQueryMatcher. So it may not be what the user need.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#peek()">peek</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the next Cell</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="next()"> |
| <h3>next</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-201">next</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#next()">KeyValueScanner</a></code></span></div> |
| <div class="block">Return the next Cell in this scanner, iterating the scanner</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#next()">next</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the next Cell</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seek(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>seek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-222">seek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> key)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#seek(org.apache.hadoop.hbase.ExtendedCell)">KeyValueScanner</a></code></span></div> |
| <div class="block">Seek the scanner at or after the specified KeyValue.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#seek(org.apache.hadoop.hbase.ExtendedCell)">seek</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - seek value</dd> |
| <dt>Returns:</dt> |
| <dd>true if scanner has values left, false if end of scanner</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reseek(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>reseek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-251">reseek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> key)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#reseek(org.apache.hadoop.hbase.ExtendedCell)">KeyValueScanner</a></code></span></div> |
| <div class="block">Reseek the scanner at or after the specified KeyValue. This method is guaranteed to seek at or |
| after the required key only if the key comes after the current position of the scanner. Should |
| not be used to seek to a key which may come before the current position.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#reseek(org.apache.hadoop.hbase.ExtendedCell)">reseek</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - seek value (should be non-null)</dd> |
| <dt>Returns:</dt> |
| <dd>true if scanner has values left, false if end of scanner</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCurrentCell(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>setCurrentCell</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-279">setCurrentCell</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> newVal)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="skipKVsNewerThanReadpoint()"> |
| <h3>skipKVsNewerThanReadpoint</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-286">skipKVsNewerThanReadpoint</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-307">close</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#close()">KeyValueScanner</a></code></span></div> |
| <div class="block">Close the KeyValue scanner.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#close()">close</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekAtOrAfter(org.apache.hadoop.hbase.io.hfile.HFileScanner,org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>seekAtOrAfter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-319">seekAtOrAfter</a></span><wbr><span class="parameters">(<a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileScanner</a> s, |
| <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> k)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Returns false if not found or if k is after the end.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reseekAtOrAfter(org.apache.hadoop.hbase.io.hfile.HFileScanner,org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>reseekAtOrAfter</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-337">reseekAtOrAfter</a></span><wbr><span class="parameters">(<a href="../io/hfile/HFileScanner.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileScanner</a> s, |
| <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> k)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScannerOrder()"> |
| <h3>getScannerOrder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-361">getScannerOrder</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#getScannerOrder()">KeyValueScanner</a></code></span></div> |
| <div class="block">Get the order of this KeyValueScanner. This is only relevant for StoreFileScanners. This is |
| required for comparing multiple files to find out which one has the latest data. |
| StoreFileScanners are ordered from 0 (oldest) to newest in increasing order.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#getScannerOrder()">getScannerOrder</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="KeyValueScanner.html#getScannerOrder()"><code>KeyValueScanner.getScannerOrder()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)"> |
| <h3>requestSeek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-378">requestSeek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> kv, |
| boolean forward, |
| boolean useBloom)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Pretend we have done a seek but don't do it yet, if possible. The hope is that we find |
| requested columns in more recent files and won't have to seek in older files. Creates a fake |
| key/value with the given row/column and the highest (most recent) possible timestamp we might |
| get from this file. When users of such "lazy scanner" need to know the next KV precisely (e.g. |
| when this scanner is at the top of the heap), they run <a href="#enforceSeek()"><code>enforceSeek()</code></a>. |
| <p> |
| Note that this function does guarantee that the current KV of this scanner will be advanced to |
| at least the given KV. Because of this, it does have to do a real seek in cases when the seek |
| timestamp is older than the highest timestamp of the file, e.g. when we are trying to seek to |
| the next row/column and use OLDEST_TIMESTAMP in the seek key.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)">requestSeek</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dd><code>forward</code> - do a forward-only "reseek" instead of a random-access seek</dd> |
| <dd><code>useBloom</code> - whether to enable multi-column Bloom filter optimization</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReader()"> |
| <h3>getReader</h3> |
| <div class="member-signature"><span class="return-type"><a href="StoreFileReader.html" title="class in org.apache.hadoop.hbase.regionserver">StoreFileReader</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-441">getReader</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComparator()"> |
| <h3>getComparator</h3> |
| <div class="member-signature"><span class="return-type"><a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-445">getComparator</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="realSeekDone()"> |
| <h3>realSeekDone</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-449">realSeekDone</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#realSeekDone()">KeyValueScanner</a></code></span></div> |
| <div class="block">We optimize our store scanners by checking the most recent store file first, so we sometimes |
| pretend we have done a seek but delay it until the store scanner bubbles up to the top of the |
| key-value heap. This method is then used to ensure the top store file scanner has done a seek |
| operation.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#realSeekDone()">realSeekDone</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enforceSeek()"> |
| <h3>enforceSeek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-454">enforceSeek</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#enforceSeek()">KeyValueScanner</a></code></span></div> |
| <div class="block">Does the real seek operation in case it was skipped by seekToRowCol(KeyValue, boolean) (TODO: |
| Whats this?). Note that this function should be never called on scanners that always do real |
| seek operations (i.e. most of the scanners). The easiest way to achieve this is to call |
| <a href="KeyValueScanner.html#realSeekDone()"><code>KeyValueScanner.realSeekDone()</code></a> first.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#enforceSeek()">enforceSeek</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFileScanner()"> |
| <h3>isFileScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-465">isFileScanner</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#isFileScanner()">KeyValueScanner</a></code></span></div> |
| <div class="block">Returns true if this is a file scanner. Otherwise a memory scanner is assumed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#isFileScanner()">isFileScanner</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="recordBlockSize(java.util.function.IntConsumer)"> |
| <h3>recordBlockSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-470">recordBlockSize</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/IntConsumer.html" title="class or interface in java.util.function" class="external-link">IntConsumer</a> blockSizeConsumer)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#recordBlockSize(java.util.function.IntConsumer)">KeyValueScanner</a></code></span></div> |
| <div class="block">Record the size of the current block in bytes, passing as an argument to the blockSizeConsumer. |
| Implementations should ensure that blockSizeConsumer is only called once per block.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#recordBlockSize(java.util.function.IntConsumer)">recordBlockSize</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>blockSizeConsumer</code> - to be called with block size in bytes, once per block.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFilePath()"> |
| <h3>getFilePath</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-475">getFilePath</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#getFilePath()">getFilePath</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the file path if this is a file scanner, otherwise null.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="KeyValueScanner.html#isFileScanner()"><code>KeyValueScanner.isFileScanner()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSeekCount()"> |
| <h3>getSeekCount</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-481">getSeekCount</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="instrument()"> |
| <h3>instrument</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-485">instrument</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shouldUseScanner(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.regionserver.HStore,long)"> |
| <h3>shouldUseScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-489">shouldUseScanner</a></span><wbr><span class="parameters">(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, |
| <a href="HStore.html" title="class in org.apache.hadoop.hbase.regionserver">HStore</a> store, |
| long oldestUnexpiredTS)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#shouldUseScanner(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.regionserver.HStore,long)">KeyValueScanner</a></code></span></div> |
| <div class="block">Allows to filter out scanners (both StoreFile and memstore) that we don't want to use based on |
| criteria such as Bloom filters and timestamp ranges.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#shouldUseScanner(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.regionserver.HStore,long)">shouldUseScanner</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>scan</code> - the scan that we are selecting scanners for</dd> |
| <dd><code>store</code> - the store we are performing the scan on.</dd> |
| <dd><code>oldestUnexpiredTS</code> - the oldest timestamp we are interested in for this query, based on TTL</dd> |
| <dt>Returns:</dt> |
| <dd>true if the scanner should be included in the query</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>seekToPreviousRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-502">seekToPreviousRow</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> originalKey)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)">KeyValueScanner</a></code></span></div> |
| <div class="block">Seek the scanner at the first Cell of the row which is the previous row of specified key</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)">seekToPreviousRow</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>originalKey</code> - seek value</dd> |
| <dt>Returns:</dt> |
| <dd>true if the scanner at the first valid Cell of previous row, false if not existing such |
| Cell</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekToPreviousRowWithHint()"> |
| <h3>seekToPreviousRowWithHint</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-530">seekToPreviousRowWithHint</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">This variant of the <code>StoreFileScanner#seekToPreviousRow(Cell)</code> method requires one seek |
| and one reseek. This method maintains state in <a href="#previousRow"><code>previousRow</code></a> which only |
| makes sense in the context of a sequential row-by-row reverse scan. |
| <a href="#previousRow"><code>previousRow</code></a> should be reset if that is not the case. The reasoning for |
| why this method is faster than <code>StoreFileScanner#seekToPreviousRowStateless(Cell)</code> is |
| that seeks are slower as they need to start from the beginning of the file, while reseeks go |
| forward from the current position.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekToPreviousRowWithoutHint(org.apache.hadoop.hbase.Cell)"> |
| <h3>seekToPreviousRowWithoutHint</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-563">seekToPreviousRowWithoutHint</a></span><wbr><span class="parameters">(<a href="../Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> originalKey)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">This variant of the <code>StoreFileScanner#seekToPreviousRow(Cell)</code> method requires two seeks |
| and one reseek. The extra expense/seek is with the intent of speeding up subsequent calls by |
| using the <a href="#seekToPreviousRowWithHint()"><code>seekToPreviousRowWithHint()</code></a> which this method seeds the state |
| for by setting <a href="#previousRow"><code>previousRow</code></a></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekToPreviousRowStateless(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>seekToPreviousRowStateless</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-603">seekToPreviousRowStateless</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> originalKey)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">This variant of the <code>StoreFileScanner#seekToPreviousRow(Cell)</code> method requires two seeks. |
| It should be used if the cost for seeking is lower i.e. when using a fast seeking data block |
| encoding like RIV1.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekBefore(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>seekBefore</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-623">seekBefore</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekKey)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekBeforeAndSaveKeyToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>seekBeforeAndSaveKeyToPreviousRow</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-643">seekBeforeAndSaveKeyToPreviousRow</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekKey)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Seeks before the seek target cell and saves the location to <a href="#previousRow"><code>previousRow</code></a>. If there |
| doesn't exist a KV in this file before the seek target cell, reposition the scanner at the |
| beginning of the storefile (in preparation to a reseek at or after the seek key) and set the |
| <a href="#previousRow"><code>previousRow</code></a> to null. If <a href="#previousRow"><code>previousRow</code></a> is ever non-null and then transitions to |
| being null again via this method, that's because there doesn't exist a row before the seek |
| target in the storefile (i.e. we're at the beginning of the storefile)</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekAtOrAfter(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>seekAtOrAfter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-658">seekAtOrAfter</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekKey)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reseekAtOrAfter(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>reseekAtOrAfter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-670">reseekAtOrAfter</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekKey)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStillAtSeekTargetAfterSkippingNewerKvs(org.apache.hadoop.hbase.Cell)"> |
| <h3>isStillAtSeekTargetAfterSkippingNewerKvs</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-682">isStillAtSeekTargetAfterSkippingNewerKvs</a></span><wbr><span class="parameters">(<a href="../Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> seekKey)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="skipKvsNewerThanReadpointReversed()"> |
| <h3>skipKvsNewerThanReadpointReversed</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-687">skipKvsNewerThanReadpointReversed</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seekToLastRow()"> |
| <h3>seekToLastRow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-699">seekToLastRow</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#seekToLastRow()">KeyValueScanner</a></code></span></div> |
| <div class="block">Seek the scanner at the first KeyValue of last row</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#seekToLastRow()">seekToLastRow</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if scanner has values left, false if the underlying data is empty</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="backwardSeek(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>backwardSeek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-713">backwardSeek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> key)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="KeyValueScanner.html#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)">KeyValueScanner</a></code></span></div> |
| <div class="block">Seek the scanner at or before the row of specified Cell, it firstly tries to seek the scanner |
| at or after the specified Cell, return if peek KeyValue of scanner has the same row with |
| specified Cell, otherwise seek the scanner at the first Cell of the row which is the previous |
| row of specified KeyValue</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)">backwardSeek</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - seek KeyValue</dd> |
| <dt>Returns:</dt> |
| <dd>true if the scanner is at the valid KeyValue, false if such KeyValue does not exist</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNextIndexedKey()"> |
| <h3>getNextIndexedKey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-722">getNextIndexedKey</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="KeyValueScanner.html#getNextIndexedKey()">getNextIndexedKey</a></code> in interface <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the next key in the index, usually the first key of next block OR a key that falls |
| between last key of current block and first key of next block.. see |
| HFileWriterImpl#getMidpoint, or null if not known.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shipped()"> |
| <h3>shipped</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/StoreFileScanner.html#line-727">shipped</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Shipper.html#shipped()">Shipper</a></code></span></div> |
| <div class="block">Called after a batch of rows scanned and set to be returned to client. Any in between cleanup |
| can be done here.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Shipper.html#shipped()">shipped</a></code> in interface <code><a href="Shipper.html" title="interface in org.apache.hadoop.hbase.regionserver">Shipper</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |