| <!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.client, class: BatchScanResultCache"> |
| <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.client;</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 static org.apache.hadoop.hbase.client.ConnectionUtils.filterCells;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.ArrayDeque;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.ArrayList;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.Deque;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.List;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.CellUtil;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.ExtendedCell;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</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"> * A scan result cache for batched scan, i.e,</span> |
| <span class="source-line-no">034</span><span id="line-34"> * {@code scan.getBatch() > 0 && !scan.getAllowPartialResults()}.</span> |
| <span class="source-line-no">035</span><span id="line-35"> * <p></span> |
| <span class="source-line-no">036</span><span id="line-36"> * If user setBatch(5) and rpc returns 3+5+5+5+3 cells, we should return 5+5+5+5+1 to user. setBatch</span> |
| <span class="source-line-no">037</span><span id="line-37"> * doesn't mean setAllowPartialResult(true).</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @since 2.0.0</span> |
| <span class="source-line-no">039</span><span id="line-39"> */</span> |
| <span class="source-line-no">040</span><span id="line-40">@InterfaceAudience.Private</span> |
| <span class="source-line-no">041</span><span id="line-41">public class BatchScanResultCache implements ScanResultCache {</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43"> private final int batch;</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> // used to filter out the cells that already returned to user as we always start from the</span> |
| <span class="source-line-no">046</span><span id="line-46"> // beginning of a row when retry.</span> |
| <span class="source-line-no">047</span><span id="line-47"> private ExtendedCell lastCell;</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> private boolean lastResultPartial;</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> private final Deque<Result> partialResults = new ArrayDeque<>();</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> private int numCellsOfPartialResults;</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> private int numberOfCompleteRows;</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> public BatchScanResultCache(int batch) {</span> |
| <span class="source-line-no">058</span><span id="line-58"> this.batch = batch;</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"> private void recordLastResult(Result result) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> lastCell = result.rawExtendedCells()[result.rawExtendedCells().length - 1];</span> |
| <span class="source-line-no">063</span><span id="line-63"> lastResultPartial = result.mayHaveMoreCellsInRow();</span> |
| <span class="source-line-no">064</span><span id="line-64"> }</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> private Result createCompletedResult() throws IOException {</span> |
| <span class="source-line-no">067</span><span id="line-67"> numberOfCompleteRows++;</span> |
| <span class="source-line-no">068</span><span id="line-68"> Result result = Result.createCompleteResult(partialResults);</span> |
| <span class="source-line-no">069</span><span id="line-69"> partialResults.clear();</span> |
| <span class="source-line-no">070</span><span id="line-70"> numCellsOfPartialResults = 0;</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"></span> |
| <span class="source-line-no">074</span><span id="line-74"> // Add new result to the partial list and return a batched Result if caching size exceed batching</span> |
| <span class="source-line-no">075</span><span id="line-75"> // limit. As the RS will also respect the scan.getBatch, we can make sure that we will get only</span> |
| <span class="source-line-no">076</span><span id="line-76"> // one Result back at most(or null, which means we do not have enough cells).</span> |
| <span class="source-line-no">077</span><span id="line-77"> private Result regroupResults(Result result) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> partialResults.addLast(result);</span> |
| <span class="source-line-no">079</span><span id="line-79"> numCellsOfPartialResults += result.size();</span> |
| <span class="source-line-no">080</span><span id="line-80"> if (numCellsOfPartialResults < batch) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> return null;</span> |
| <span class="source-line-no">082</span><span id="line-82"> }</span> |
| <span class="source-line-no">083</span><span id="line-83"> ExtendedCell[] cells = new ExtendedCell[batch];</span> |
| <span class="source-line-no">084</span><span id="line-84"> int cellCount = 0;</span> |
| <span class="source-line-no">085</span><span id="line-85"> boolean stale = false;</span> |
| <span class="source-line-no">086</span><span id="line-86"> for (;;) {</span> |
| <span class="source-line-no">087</span><span id="line-87"> Result r = partialResults.pollFirst();</span> |
| <span class="source-line-no">088</span><span id="line-88"> stale = stale || r.isStale();</span> |
| <span class="source-line-no">089</span><span id="line-89"> int newCellCount = cellCount + r.size();</span> |
| <span class="source-line-no">090</span><span id="line-90"> if (newCellCount > batch) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> // We have more cells than expected, so split the current result</span> |
| <span class="source-line-no">092</span><span id="line-92"> int len = batch - cellCount;</span> |
| <span class="source-line-no">093</span><span id="line-93"> System.arraycopy(r.rawCells(), 0, cells, cellCount, len);</span> |
| <span class="source-line-no">094</span><span id="line-94"> ExtendedCell[] remainingCells = new ExtendedCell[r.size() - len];</span> |
| <span class="source-line-no">095</span><span id="line-95"> System.arraycopy(r.rawExtendedCells(), len, remainingCells, 0, r.size() - len);</span> |
| <span class="source-line-no">096</span><span id="line-96"> partialResults.addFirst(</span> |
| <span class="source-line-no">097</span><span id="line-97"> Result.create(remainingCells, r.getExists(), r.isStale(), r.mayHaveMoreCellsInRow()));</span> |
| <span class="source-line-no">098</span><span id="line-98"> break;</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</span> |
| <span class="source-line-no">100</span><span id="line-100"> System.arraycopy(r.rawCells(), 0, cells, cellCount, r.size());</span> |
| <span class="source-line-no">101</span><span id="line-101"> if (newCellCount == batch) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> break;</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104"> cellCount = newCellCount;</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"> numCellsOfPartialResults -= batch;</span> |
| <span class="source-line-no">107</span><span id="line-107"> return Result.create(cells, null, stale,</span> |
| <span class="source-line-no">108</span><span id="line-108"> result.mayHaveMoreCellsInRow() || !partialResults.isEmpty());</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> @Override</span> |
| <span class="source-line-no">112</span><span id="line-112"> public Result[] addAndGet(Result[] results, boolean isHeartbeatMessage) throws IOException {</span> |
| <span class="source-line-no">113</span><span id="line-113"> if (results.length == 0) {</span> |
| <span class="source-line-no">114</span><span id="line-114"> if (!isHeartbeatMessage) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> if (!partialResults.isEmpty()) {</span> |
| <span class="source-line-no">116</span><span id="line-116"> return new Result[] { createCompletedResult() };</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118"> if (lastResultPartial) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> // An empty non heartbeat result indicate that there must be a row change. So if the</span> |
| <span class="source-line-no">120</span><span id="line-120"> // lastResultPartial is true then we need to increase numberOfCompleteRows.</span> |
| <span class="source-line-no">121</span><span id="line-121"> numberOfCompleteRows++;</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"> }</span> |
| <span class="source-line-no">124</span><span id="line-124"> return EMPTY_RESULT_ARRAY;</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"> List<Result> regroupedResults = new ArrayList<>();</span> |
| <span class="source-line-no">127</span><span id="line-127"> for (Result result : results) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> result = filterCells(result, lastCell);</span> |
| <span class="source-line-no">129</span><span id="line-129"> if (result == null) {</span> |
| <span class="source-line-no">130</span><span id="line-130"> continue;</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"> if (!partialResults.isEmpty()) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> if (!Bytes.equals(partialResults.peek().getRow(), result.getRow())) {</span> |
| <span class="source-line-no">134</span><span id="line-134"> // there is a row change</span> |
| <span class="source-line-no">135</span><span id="line-135"> regroupedResults.add(createCompletedResult());</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"> } else if (lastResultPartial && !CellUtil.matchingRows(lastCell, result.getRow())) {</span> |
| <span class="source-line-no">138</span><span id="line-138"> // As for batched scan we may return partial results to user if we reach the batch limit, so</span> |
| <span class="source-line-no">139</span><span id="line-139"> // here we need to use lastCell to determine if there is row change and increase</span> |
| <span class="source-line-no">140</span><span id="line-140"> // numberOfCompleteRows.</span> |
| <span class="source-line-no">141</span><span id="line-141"> numberOfCompleteRows++;</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143"> // check if we have a row change</span> |
| <span class="source-line-no">144</span><span id="line-144"> if (</span> |
| <span class="source-line-no">145</span><span id="line-145"> !partialResults.isEmpty() && !Bytes.equals(partialResults.peek().getRow(), result.getRow())</span> |
| <span class="source-line-no">146</span><span id="line-146"> ) {</span> |
| <span class="source-line-no">147</span><span id="line-147"> regroupedResults.add(createCompletedResult());</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</span> |
| <span class="source-line-no">149</span><span id="line-149"> Result regroupedResult = regroupResults(result);</span> |
| <span class="source-line-no">150</span><span id="line-150"> if (regroupedResult != null) {</span> |
| <span class="source-line-no">151</span><span id="line-151"> if (!regroupedResult.mayHaveMoreCellsInRow()) {</span> |
| <span class="source-line-no">152</span><span id="line-152"> numberOfCompleteRows++;</span> |
| <span class="source-line-no">153</span><span id="line-153"> }</span> |
| <span class="source-line-no">154</span><span id="line-154"> regroupedResults.add(regroupedResult);</span> |
| <span class="source-line-no">155</span><span id="line-155"> // only update last cell when we actually return it to user.</span> |
| <span class="source-line-no">156</span><span id="line-156"> recordLastResult(regroupedResult);</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</span> |
| <span class="source-line-no">158</span><span id="line-158"> if (!result.mayHaveMoreCellsInRow() && !partialResults.isEmpty()) {</span> |
| <span class="source-line-no">159</span><span id="line-159"> // We are done for this row</span> |
| <span class="source-line-no">160</span><span id="line-160"> regroupedResults.add(createCompletedResult());</span> |
| <span class="source-line-no">161</span><span id="line-161"> }</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"> return regroupedResults.toArray(new Result[0]);</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"></span> |
| <span class="source-line-no">166</span><span id="line-166"> @Override</span> |
| <span class="source-line-no">167</span><span id="line-167"> public void clear() {</span> |
| <span class="source-line-no">168</span><span id="line-168"> partialResults.clear();</span> |
| <span class="source-line-no">169</span><span id="line-169"> numCellsOfPartialResults = 0;</span> |
| <span class="source-line-no">170</span><span id="line-170"> }</span> |
| <span class="source-line-no">171</span><span id="line-171"></span> |
| <span class="source-line-no">172</span><span id="line-172"> @Override</span> |
| <span class="source-line-no">173</span><span id="line-173"> public int numberOfCompleteRows() {</span> |
| <span class="source-line-no">174</span><span id="line-174"> return numberOfCompleteRows;</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
