blob: 4d162836cd02015e3e6ab44eb7199c9bbf24d835 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver, class: MobStoreScanner">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.ArrayList;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.NavigableSet;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.ExtendedCell;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.Scan;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.mob.MobCell;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.mob.MobUtils;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">029</span><span id="line-29">import org.slf4j.Logger;</span>
<span class="source-line-no">030</span><span id="line-30">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32">/**</span>
<span class="source-line-no">033</span><span id="line-33"> * Scanner scans both the memstore and the MOB Store. Coalesce KeyValue stream into</span>
<span class="source-line-no">034</span><span id="line-34"> * {@code List&lt;KeyValue&gt;} for a single row.</span>
<span class="source-line-no">035</span><span id="line-35"> */</span>
<span class="source-line-no">036</span><span id="line-36">@InterfaceAudience.Private</span>
<span class="source-line-no">037</span><span id="line-37">public class MobStoreScanner extends StoreScanner {</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> private static final Logger LOG = LoggerFactory.getLogger(MobStoreScanner.class);</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> private boolean cacheMobBlocks = false;</span>
<span class="source-line-no">042</span><span id="line-42"> private boolean rawMobScan = false;</span>
<span class="source-line-no">043</span><span id="line-43"> private boolean readEmptyValueOnMobCellMiss = false;</span>
<span class="source-line-no">044</span><span id="line-44"> private final HMobStore mobStore;</span>
<span class="source-line-no">045</span><span id="line-45"> private final List&lt;MobCell&gt; referencedMobCells;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> public MobStoreScanner(HStore store, ScanInfo scanInfo, Scan scan,</span>
<span class="source-line-no">048</span><span id="line-48"> final NavigableSet&lt;byte[]&gt; columns, long readPt) throws IOException {</span>
<span class="source-line-no">049</span><span id="line-49"> super(store, scanInfo, scan, columns, readPt);</span>
<span class="source-line-no">050</span><span id="line-50"> cacheMobBlocks = MobUtils.isCacheMobBlocks(scan);</span>
<span class="source-line-no">051</span><span id="line-51"> rawMobScan = MobUtils.isRawMobScan(scan);</span>
<span class="source-line-no">052</span><span id="line-52"> readEmptyValueOnMobCellMiss = MobUtils.isReadEmptyValueOnMobCellMiss(scan);</span>
<span class="source-line-no">053</span><span id="line-53"> if (!(store instanceof HMobStore)) {</span>
<span class="source-line-no">054</span><span id="line-54"> throw new IllegalArgumentException("The store " + store + " is not a HMobStore");</span>
<span class="source-line-no">055</span><span id="line-55"> }</span>
<span class="source-line-no">056</span><span id="line-56"> mobStore = (HMobStore) store;</span>
<span class="source-line-no">057</span><span id="line-57"> this.referencedMobCells = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">058</span><span id="line-58"> }</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> /**</span>
<span class="source-line-no">061</span><span id="line-61"> * Firstly reads the cells from the HBase. If the cell are a reference cell (which has the</span>
<span class="source-line-no">062</span><span id="line-62"> * reference tag), the scanner need seek this cell from the mob file, and use the cell found from</span>
<span class="source-line-no">063</span><span id="line-63"> * the mob file as the result.</span>
<span class="source-line-no">064</span><span id="line-64"> */</span>
<span class="source-line-no">065</span><span id="line-65"> @Override</span>
<span class="source-line-no">066</span><span id="line-66"> public boolean next(List&lt;? super ExtendedCell&gt; outResult, ScannerContext ctx) throws IOException {</span>
<span class="source-line-no">067</span><span id="line-67"> boolean result = super.next(outResult, ctx);</span>
<span class="source-line-no">068</span><span id="line-68"> if (!rawMobScan) {</span>
<span class="source-line-no">069</span><span id="line-69"> // retrieve the mob data</span>
<span class="source-line-no">070</span><span id="line-70"> if (outResult.isEmpty()) {</span>
<span class="source-line-no">071</span><span id="line-71"> return result;</span>
<span class="source-line-no">072</span><span id="line-72"> }</span>
<span class="source-line-no">073</span><span id="line-73"> long mobKVCount = 0;</span>
<span class="source-line-no">074</span><span id="line-74"> long mobKVSize = 0;</span>
<span class="source-line-no">075</span><span id="line-75"> for (int i = 0; i &lt; outResult.size(); i++) {</span>
<span class="source-line-no">076</span><span id="line-76"> // At server side, we should only get ExtendedCell</span>
<span class="source-line-no">077</span><span id="line-77"> ExtendedCell cell = (ExtendedCell) outResult.get(i);</span>
<span class="source-line-no">078</span><span id="line-78"> if (MobUtils.isMobReferenceCell(cell)) {</span>
<span class="source-line-no">079</span><span id="line-79"> MobCell mobCell =</span>
<span class="source-line-no">080</span><span id="line-80"> mobStore.resolve(cell, cacheMobBlocks, readPt, readEmptyValueOnMobCellMiss);</span>
<span class="source-line-no">081</span><span id="line-81"> mobKVCount++;</span>
<span class="source-line-no">082</span><span id="line-82"> mobKVSize += mobCell.getCell().getValueLength();</span>
<span class="source-line-no">083</span><span id="line-83"> outResult.set(i, mobCell.getCell());</span>
<span class="source-line-no">084</span><span id="line-84"> // Keep the MobCell here unless we shipped the RPC or close the scanner.</span>
<span class="source-line-no">085</span><span id="line-85"> referencedMobCells.add(mobCell);</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"> }</span>
<span class="source-line-no">088</span><span id="line-88"> mobStore.updateMobScanCellsCount(mobKVCount);</span>
<span class="source-line-no">089</span><span id="line-89"> mobStore.updateMobScanCellsSize(mobKVSize);</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"> return result;</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> private void freeAllReferencedMobCells() throws IOException {</span>
<span class="source-line-no">095</span><span id="line-95"> for (MobCell cell : referencedMobCells) {</span>
<span class="source-line-no">096</span><span id="line-96"> cell.close();</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> referencedMobCells.clear();</span>
<span class="source-line-no">099</span><span id="line-99"> }</span>
<span class="source-line-no">100</span><span id="line-100"></span>
<span class="source-line-no">101</span><span id="line-101"> @Override</span>
<span class="source-line-no">102</span><span id="line-102"> public void shipped() throws IOException {</span>
<span class="source-line-no">103</span><span id="line-103"> super.shipped();</span>
<span class="source-line-no">104</span><span id="line-104"> this.freeAllReferencedMobCells();</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"></span>
<span class="source-line-no">107</span><span id="line-107"> @Override</span>
<span class="source-line-no">108</span><span id="line-108"> public void close() {</span>
<span class="source-line-no">109</span><span id="line-109"> super.close();</span>
<span class="source-line-no">110</span><span id="line-110"> try {</span>
<span class="source-line-no">111</span><span id="line-111"> this.freeAllReferencedMobCells();</span>
<span class="source-line-no">112</span><span id="line-112"> } catch (IOException e) {</span>
<span class="source-line-no">113</span><span id="line-113"> LOG.warn("Failed to free referenced mob cells: ", e);</span>
<span class="source-line-no">114</span><span id="line-114"> }</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116">}</span>
</pre>
</div>
</main>
</body>
</html>