| <!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.querymatcher, class: ScanQueryMatcher, enum: MatchCode"> |
| <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.querymatcher;</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.Iterator;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.NavigableSet;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.Cell;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.CellComparator;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.CellUtil;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.ExtendedCell;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.KeyValue;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.KeyValue.Type;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.KeyValueUtil;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.PrivateCellUtil;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.PrivateConstants;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.Tag;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.TagType;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.client.Scan;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.filter.Filter;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.regionserver.ScanInfo;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.regionserver.ShipperListener;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.regionserver.querymatcher.DeleteTracker.DeleteResult;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.security.visibility.VisibilityNewVersionBehaivorTracker;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.security.visibility.VisibilityScanDeleteTracker;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.util.Pair;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47">/**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * A query matcher that is specifically designed for the scan case.</span> |
| <span class="source-line-no">049</span><span id="line-49"> */</span> |
| <span class="source-line-no">050</span><span id="line-50">@InterfaceAudience.Private</span> |
| <span class="source-line-no">051</span><span id="line-51">public abstract class ScanQueryMatcher implements ShipperListener {</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * {@link #match} return codes. These instruct the scanner moving through memstores and StoreFiles</span> |
| <span class="source-line-no">055</span><span id="line-55"> * what to do with the current KeyValue.</span> |
| <span class="source-line-no">056</span><span id="line-56"> * <p></span> |
| <span class="source-line-no">057</span><span id="line-57"> * Additionally, this contains "early-out" language to tell the scanner to move on to the next</span> |
| <span class="source-line-no">058</span><span id="line-58"> * File (memstore or Storefile), or to return immediately.</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> public static enum MatchCode {</span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Include KeyValue in the returned result</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64"> INCLUDE,</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Do not include KeyValue in the returned result</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> SKIP,</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /**</span> |
| <span class="source-line-no">072</span><span id="line-72"> * Do not include, jump to next StoreFile or memstore (in time order)</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> NEXT,</span> |
| <span class="source-line-no">075</span><span id="line-75"></span> |
| <span class="source-line-no">076</span><span id="line-76"> /**</span> |
| <span class="source-line-no">077</span><span id="line-77"> * Do not include, return current result</span> |
| <span class="source-line-no">078</span><span id="line-78"> */</span> |
| <span class="source-line-no">079</span><span id="line-79"> DONE,</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> /**</span> |
| <span class="source-line-no">082</span><span id="line-82"> * These codes are used by the ScanQueryMatcher</span> |
| <span class="source-line-no">083</span><span id="line-83"> */</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> /**</span> |
| <span class="source-line-no">086</span><span id="line-86"> * Done with the row, seek there.</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> SEEK_NEXT_ROW,</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> /**</span> |
| <span class="source-line-no">091</span><span id="line-91"> * Done with column, seek to next.</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> SEEK_NEXT_COL,</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * Done with scan, thanks to the row filter.</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> DONE_SCAN,</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"> * Seek to next key which is given as hint.</span> |
| <span class="source-line-no">102</span><span id="line-102"> */</span> |
| <span class="source-line-no">103</span><span id="line-103"> SEEK_NEXT_USING_HINT,</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> /**</span> |
| <span class="source-line-no">106</span><span id="line-106"> * Include KeyValue and done with column, seek to next.</span> |
| <span class="source-line-no">107</span><span id="line-107"> */</span> |
| <span class="source-line-no">108</span><span id="line-108"> INCLUDE_AND_SEEK_NEXT_COL,</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"> * Include KeyValue and done with row, seek to next.</span> |
| <span class="source-line-no">112</span><span id="line-112"> */</span> |
| <span class="source-line-no">113</span><span id="line-113"> INCLUDE_AND_SEEK_NEXT_ROW,</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"> /** Row comparator for the region this query is for */</span> |
| <span class="source-line-no">117</span><span id="line-117"> protected final CellComparator rowComparator;</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> /** Key to seek to in memstore and StoreFiles */</span> |
| <span class="source-line-no">120</span><span id="line-120"> protected final ExtendedCell startKey;</span> |
| <span class="source-line-no">121</span><span id="line-121"></span> |
| <span class="source-line-no">122</span><span id="line-122"> /** Keeps track of columns and versions */</span> |
| <span class="source-line-no">123</span><span id="line-123"> protected final ColumnTracker columns;</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> /** The oldest timestamp we are interested in, based on TTL */</span> |
| <span class="source-line-no">126</span><span id="line-126"> protected final long oldestUnexpiredTS;</span> |
| <span class="source-line-no">127</span><span id="line-127"></span> |
| <span class="source-line-no">128</span><span id="line-128"> protected final long now;</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> /** Row the query is on */</span> |
| <span class="source-line-no">131</span><span id="line-131"> protected ExtendedCell currentRow;</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> protected ScanQueryMatcher(ExtendedCell startKey, ScanInfo scanInfo, ColumnTracker columns,</span> |
| <span class="source-line-no">134</span><span id="line-134"> long oldestUnexpiredTS, long now) {</span> |
| <span class="source-line-no">135</span><span id="line-135"> this.rowComparator = scanInfo.getComparator();</span> |
| <span class="source-line-no">136</span><span id="line-136"> this.startKey = startKey;</span> |
| <span class="source-line-no">137</span><span id="line-137"> this.oldestUnexpiredTS = oldestUnexpiredTS;</span> |
| <span class="source-line-no">138</span><span id="line-138"> this.now = now;</span> |
| <span class="source-line-no">139</span><span id="line-139"> this.columns = columns;</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</span> |
| <span class="source-line-no">141</span><span id="line-141"></span> |
| <span class="source-line-no">142</span><span id="line-142"> /** Returns true if the cell is expired */</span> |
| <span class="source-line-no">143</span><span id="line-143"> private static boolean isCellTTLExpired(final ExtendedCell cell, final long oldestTimestamp,</span> |
| <span class="source-line-no">144</span><span id="line-144"> final long now) {</span> |
| <span class="source-line-no">145</span><span id="line-145"> // Look for a TTL tag first. Use it instead of the family setting if</span> |
| <span class="source-line-no">146</span><span id="line-146"> // found. If a cell has multiple TTLs, resolve the conflict by using the</span> |
| <span class="source-line-no">147</span><span id="line-147"> // first tag encountered.</span> |
| <span class="source-line-no">148</span><span id="line-148"> Iterator<Tag> i = PrivateCellUtil.tagsIterator(cell);</span> |
| <span class="source-line-no">149</span><span id="line-149"> while (i.hasNext()) {</span> |
| <span class="source-line-no">150</span><span id="line-150"> Tag t = i.next();</span> |
| <span class="source-line-no">151</span><span id="line-151"> if (TagType.TTL_TAG_TYPE == t.getType()) {</span> |
| <span class="source-line-no">152</span><span id="line-152"> // Unlike in schema cell TTLs are stored in milliseconds, no need</span> |
| <span class="source-line-no">153</span><span id="line-153"> // to convert</span> |
| <span class="source-line-no">154</span><span id="line-154"> long ts = cell.getTimestamp();</span> |
| <span class="source-line-no">155</span><span id="line-155"> assert t.getValueLength() == Bytes.SIZEOF_LONG;</span> |
| <span class="source-line-no">156</span><span id="line-156"> long ttl = Tag.getValueAsLong(t);</span> |
| <span class="source-line-no">157</span><span id="line-157"> if (ts + ttl < now) {</span> |
| <span class="source-line-no">158</span><span id="line-158"> return true;</span> |
| <span class="source-line-no">159</span><span id="line-159"> }</span> |
| <span class="source-line-no">160</span><span id="line-160"> // Per cell TTLs cannot extend lifetime beyond family settings, so</span> |
| <span class="source-line-no">161</span><span id="line-161"> // fall through to check that</span> |
| <span class="source-line-no">162</span><span id="line-162"> break;</span> |
| <span class="source-line-no">163</span><span id="line-163"> }</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"> return false;</span> |
| <span class="source-line-no">166</span><span id="line-166"> }</span> |
| <span class="source-line-no">167</span><span id="line-167"></span> |
| <span class="source-line-no">168</span><span id="line-168"> /**</span> |
| <span class="source-line-no">169</span><span id="line-169"> * Check before the delete logic.</span> |
| <span class="source-line-no">170</span><span id="line-170"> * @return null means continue.</span> |
| <span class="source-line-no">171</span><span id="line-171"> */</span> |
| <span class="source-line-no">172</span><span id="line-172"> protected final MatchCode preCheck(ExtendedCell cell) {</span> |
| <span class="source-line-no">173</span><span id="line-173"> if (currentRow == null) {</span> |
| <span class="source-line-no">174</span><span id="line-174"> // Since the curCell is null it means we are already sure that we have moved over to the next</span> |
| <span class="source-line-no">175</span><span id="line-175"> // row</span> |
| <span class="source-line-no">176</span><span id="line-176"> return MatchCode.DONE;</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</span> |
| <span class="source-line-no">178</span><span id="line-178"> // if row key is changed, then we know that we have moved over to the next row</span> |
| <span class="source-line-no">179</span><span id="line-179"> if (rowComparator.compareRows(currentRow, cell) != 0) {</span> |
| <span class="source-line-no">180</span><span id="line-180"> return MatchCode.DONE;</span> |
| <span class="source-line-no">181</span><span id="line-181"> }</span> |
| <span class="source-line-no">182</span><span id="line-182"></span> |
| <span class="source-line-no">183</span><span id="line-183"> if (this.columns.done()) {</span> |
| <span class="source-line-no">184</span><span id="line-184"> return MatchCode.SEEK_NEXT_ROW;</span> |
| <span class="source-line-no">185</span><span id="line-185"> }</span> |
| <span class="source-line-no">186</span><span id="line-186"></span> |
| <span class="source-line-no">187</span><span id="line-187"> long timestamp = cell.getTimestamp();</span> |
| <span class="source-line-no">188</span><span id="line-188"> // check if this is a fake cell. The fake cell is an optimization, we should make the scanner</span> |
| <span class="source-line-no">189</span><span id="line-189"> // seek to next column or next row. See StoreFileScanner.requestSeek for more details.</span> |
| <span class="source-line-no">190</span><span id="line-190"> // check for early out based on timestamp alone</span> |
| <span class="source-line-no">191</span><span id="line-191"> if (timestamp == PrivateConstants.OLDEST_TIMESTAMP || columns.isDone(timestamp)) {</span> |
| <span class="source-line-no">192</span><span id="line-192"> return columns.getNextRowOrNextColumn(cell);</span> |
| <span class="source-line-no">193</span><span id="line-193"> }</span> |
| <span class="source-line-no">194</span><span id="line-194"> // check if the cell is expired by cell TTL</span> |
| <span class="source-line-no">195</span><span id="line-195"> if (isCellTTLExpired(cell, this.oldestUnexpiredTS, this.now)) {</span> |
| <span class="source-line-no">196</span><span id="line-196"> return MatchCode.SKIP;</span> |
| <span class="source-line-no">197</span><span id="line-197"> }</span> |
| <span class="source-line-no">198</span><span id="line-198"> return null;</span> |
| <span class="source-line-no">199</span><span id="line-199"> }</span> |
| <span class="source-line-no">200</span><span id="line-200"></span> |
| <span class="source-line-no">201</span><span id="line-201"> protected final MatchCode checkDeleted(DeleteTracker deletes, ExtendedCell cell) {</span> |
| <span class="source-line-no">202</span><span id="line-202"> if (deletes.isEmpty() && !(deletes instanceof NewVersionBehaviorTracker)) {</span> |
| <span class="source-line-no">203</span><span id="line-203"> return null;</span> |
| <span class="source-line-no">204</span><span id="line-204"> }</span> |
| <span class="source-line-no">205</span><span id="line-205"> // MvccSensitiveTracker always need check all cells to save some infos.</span> |
| <span class="source-line-no">206</span><span id="line-206"> DeleteResult deleteResult = deletes.isDeleted(cell);</span> |
| <span class="source-line-no">207</span><span id="line-207"> switch (deleteResult) {</span> |
| <span class="source-line-no">208</span><span id="line-208"> case FAMILY_DELETED:</span> |
| <span class="source-line-no">209</span><span id="line-209"> case COLUMN_DELETED:</span> |
| <span class="source-line-no">210</span><span id="line-210"> if (!(deletes instanceof NewVersionBehaviorTracker)) {</span> |
| <span class="source-line-no">211</span><span id="line-211"> // MvccSensitive can not seek to next because the Put with lower ts may have higher mvcc</span> |
| <span class="source-line-no">212</span><span id="line-212"> return columns.getNextRowOrNextColumn(cell);</span> |
| <span class="source-line-no">213</span><span id="line-213"> }</span> |
| <span class="source-line-no">214</span><span id="line-214"> case VERSION_DELETED:</span> |
| <span class="source-line-no">215</span><span id="line-215"> case FAMILY_VERSION_DELETED:</span> |
| <span class="source-line-no">216</span><span id="line-216"> case VERSION_MASKED:</span> |
| <span class="source-line-no">217</span><span id="line-217"> return MatchCode.SKIP;</span> |
| <span class="source-line-no">218</span><span id="line-218"> case NOT_DELETED:</span> |
| <span class="source-line-no">219</span><span id="line-219"> return null;</span> |
| <span class="source-line-no">220</span><span id="line-220"> default:</span> |
| <span class="source-line-no">221</span><span id="line-221"> throw new RuntimeException("Unexpected delete result: " + deleteResult);</span> |
| <span class="source-line-no">222</span><span id="line-222"> }</span> |
| <span class="source-line-no">223</span><span id="line-223"> }</span> |
| <span class="source-line-no">224</span><span id="line-224"></span> |
| <span class="source-line-no">225</span><span id="line-225"> /**</span> |
| <span class="source-line-no">226</span><span id="line-226"> * Determines if the caller should do one of several things:</span> |
| <span class="source-line-no">227</span><span id="line-227"> * <ul></span> |
| <span class="source-line-no">228</span><span id="line-228"> * <li>seek/skip to the next row (MatchCode.SEEK_NEXT_ROW)</li></span> |
| <span class="source-line-no">229</span><span id="line-229"> * <li>seek/skip to the next column (MatchCode.SEEK_NEXT_COL)</li></span> |
| <span class="source-line-no">230</span><span id="line-230"> * <li>include the current KeyValue (MatchCode.INCLUDE)</li></span> |
| <span class="source-line-no">231</span><span id="line-231"> * <li>ignore the current KeyValue (MatchCode.SKIP)</li></span> |
| <span class="source-line-no">232</span><span id="line-232"> * <li>got to the next row (MatchCode.DONE)</li></span> |
| <span class="source-line-no">233</span><span id="line-233"> * </ul></span> |
| <span class="source-line-no">234</span><span id="line-234"> * @param cell KeyValue to check</span> |
| <span class="source-line-no">235</span><span id="line-235"> * @return The match code instance.</span> |
| <span class="source-line-no">236</span><span id="line-236"> * @throws IOException in case there is an internal consistency problem caused by a data</span> |
| <span class="source-line-no">237</span><span id="line-237"> * corruption.</span> |
| <span class="source-line-no">238</span><span id="line-238"> */</span> |
| <span class="source-line-no">239</span><span id="line-239"> public abstract MatchCode match(ExtendedCell cell) throws IOException;</span> |
| <span class="source-line-no">240</span><span id="line-240"></span> |
| <span class="source-line-no">241</span><span id="line-241"> /** Returns the start key */</span> |
| <span class="source-line-no">242</span><span id="line-242"> public ExtendedCell getStartKey() {</span> |
| <span class="source-line-no">243</span><span id="line-243"> return startKey;</span> |
| <span class="source-line-no">244</span><span id="line-244"> }</span> |
| <span class="source-line-no">245</span><span id="line-245"></span> |
| <span class="source-line-no">246</span><span id="line-246"> /** Returns whether there is an null column in the query */</span> |
| <span class="source-line-no">247</span><span id="line-247"> public abstract boolean hasNullColumnInQuery();</span> |
| <span class="source-line-no">248</span><span id="line-248"></span> |
| <span class="source-line-no">249</span><span id="line-249"> /** Returns a cell represent the current row */</span> |
| <span class="source-line-no">250</span><span id="line-250"> public ExtendedCell currentRow() {</span> |
| <span class="source-line-no">251</span><span id="line-251"> return currentRow;</span> |
| <span class="source-line-no">252</span><span id="line-252"> }</span> |
| <span class="source-line-no">253</span><span id="line-253"></span> |
| <span class="source-line-no">254</span><span id="line-254"> /**</span> |
| <span class="source-line-no">255</span><span id="line-255"> * Make {@link #currentRow()} return null.</span> |
| <span class="source-line-no">256</span><span id="line-256"> */</span> |
| <span class="source-line-no">257</span><span id="line-257"> public void clearCurrentRow() {</span> |
| <span class="source-line-no">258</span><span id="line-258"> currentRow = null;</span> |
| <span class="source-line-no">259</span><span id="line-259"> }</span> |
| <span class="source-line-no">260</span><span id="line-260"></span> |
| <span class="source-line-no">261</span><span id="line-261"> protected abstract void reset();</span> |
| <span class="source-line-no">262</span><span id="line-262"></span> |
| <span class="source-line-no">263</span><span id="line-263"> /**</span> |
| <span class="source-line-no">264</span><span id="line-264"> * Set the row when there is change in row</span> |
| <span class="source-line-no">265</span><span id="line-265"> */</span> |
| <span class="source-line-no">266</span><span id="line-266"> public void setToNewRow(ExtendedCell currentRow) {</span> |
| <span class="source-line-no">267</span><span id="line-267"> this.currentRow = currentRow;</span> |
| <span class="source-line-no">268</span><span id="line-268"> columns.reset();</span> |
| <span class="source-line-no">269</span><span id="line-269"> reset();</span> |
| <span class="source-line-no">270</span><span id="line-270"> }</span> |
| <span class="source-line-no">271</span><span id="line-271"></span> |
| <span class="source-line-no">272</span><span id="line-272"> public abstract boolean isUserScan();</span> |
| <span class="source-line-no">273</span><span id="line-273"></span> |
| <span class="source-line-no">274</span><span id="line-274"> /**</span> |
| <span class="source-line-no">275</span><span id="line-275"> * @return Returns false if we know there are no more rows to be scanned (We've reached the</span> |
| <span class="source-line-no">276</span><span id="line-276"> * <code>stopRow</code> or we are scanning on row only because this Scan is for a Get,</span> |
| <span class="source-line-no">277</span><span id="line-277"> * etc.</span> |
| <span class="source-line-no">278</span><span id="line-278"> */</span> |
| <span class="source-line-no">279</span><span id="line-279"> public abstract boolean moreRowsMayExistAfter(ExtendedCell cell);</span> |
| <span class="source-line-no">280</span><span id="line-280"></span> |
| <span class="source-line-no">281</span><span id="line-281"> public ExtendedCell getKeyForNextColumn(ExtendedCell cell) {</span> |
| <span class="source-line-no">282</span><span id="line-282"> // We aren't sure whether any DeleteFamily cells exist, so we can't skip to next column.</span> |
| <span class="source-line-no">283</span><span id="line-283"> // TODO: Current way disable us to seek to next column quickly. Is there any better solution?</span> |
| <span class="source-line-no">284</span><span id="line-284"> // see HBASE-18471 for more details</span> |
| <span class="source-line-no">285</span><span id="line-285"> // see TestFromClientSide3#testScanAfterDeletingSpecifiedRow</span> |
| <span class="source-line-no">286</span><span id="line-286"> // see TestFromClientSide3#testScanAfterDeletingSpecifiedRowV2</span> |
| <span class="source-line-no">287</span><span id="line-287"> if (cell.getQualifierLength() == 0) {</span> |
| <span class="source-line-no">288</span><span id="line-288"> ExtendedCell nextKey = PrivateCellUtil.createNextOnRowCol(cell);</span> |
| <span class="source-line-no">289</span><span id="line-289"> if (nextKey != cell) {</span> |
| <span class="source-line-no">290</span><span id="line-290"> return nextKey;</span> |
| <span class="source-line-no">291</span><span id="line-291"> }</span> |
| <span class="source-line-no">292</span><span id="line-292"> // The cell is at the end of row/family/qualifier, so it is impossible to find any</span> |
| <span class="source-line-no">293</span><span id="line-293"> // DeleteFamily cells.</span> |
| <span class="source-line-no">294</span><span id="line-294"> // Let us seek to next column.</span> |
| <span class="source-line-no">295</span><span id="line-295"> }</span> |
| <span class="source-line-no">296</span><span id="line-296"> ColumnCount nextColumn = columns.getColumnHint();</span> |
| <span class="source-line-no">297</span><span id="line-297"> if (nextColumn == null) {</span> |
| <span class="source-line-no">298</span><span id="line-298"> return PrivateCellUtil.createLastOnRowCol(cell);</span> |
| <span class="source-line-no">299</span><span id="line-299"> } else {</span> |
| <span class="source-line-no">300</span><span id="line-300"> return PrivateCellUtil.createFirstOnRowCol(cell, nextColumn.getBuffer(),</span> |
| <span class="source-line-no">301</span><span id="line-301"> nextColumn.getOffset(), nextColumn.getLength());</span> |
| <span class="source-line-no">302</span><span id="line-302"> }</span> |
| <span class="source-line-no">303</span><span id="line-303"> }</span> |
| <span class="source-line-no">304</span><span id="line-304"></span> |
| <span class="source-line-no">305</span><span id="line-305"> /**</span> |
| <span class="source-line-no">306</span><span id="line-306"> * @param nextIndexed the key of the next entry in the block index (if any)</span> |
| <span class="source-line-no">307</span><span id="line-307"> * @param currentCell The Cell we're using to calculate the seek key</span> |
| <span class="source-line-no">308</span><span id="line-308"> * @return result of the compare between the indexed key and the key portion of the passed cell</span> |
| <span class="source-line-no">309</span><span id="line-309"> */</span> |
| <span class="source-line-no">310</span><span id="line-310"> public int compareKeyForNextRow(ExtendedCell nextIndexed, ExtendedCell currentCell) {</span> |
| <span class="source-line-no">311</span><span id="line-311"> return PrivateCellUtil.compareKeyBasedOnColHint(rowComparator, nextIndexed, currentCell, 0, 0,</span> |
| <span class="source-line-no">312</span><span id="line-312"> null, 0, 0, PrivateConstants.OLDEST_TIMESTAMP, Type.Minimum.getCode());</span> |
| <span class="source-line-no">313</span><span id="line-313"> }</span> |
| <span class="source-line-no">314</span><span id="line-314"></span> |
| <span class="source-line-no">315</span><span id="line-315"> /**</span> |
| <span class="source-line-no">316</span><span id="line-316"> * @param nextIndexed the key of the next entry in the block index (if any)</span> |
| <span class="source-line-no">317</span><span id="line-317"> * @param currentCell The Cell we're using to calculate the seek key</span> |
| <span class="source-line-no">318</span><span id="line-318"> * @return result of the compare between the indexed key and the key portion of the passed cell</span> |
| <span class="source-line-no">319</span><span id="line-319"> */</span> |
| <span class="source-line-no">320</span><span id="line-320"> public int compareKeyForNextColumn(ExtendedCell nextIndexed, ExtendedCell currentCell) {</span> |
| <span class="source-line-no">321</span><span id="line-321"> ColumnCount nextColumn = columns.getColumnHint();</span> |
| <span class="source-line-no">322</span><span id="line-322"> if (nextColumn == null) {</span> |
| <span class="source-line-no">323</span><span id="line-323"> return PrivateCellUtil.compareKeyBasedOnColHint(rowComparator, nextIndexed, currentCell, 0, 0,</span> |
| <span class="source-line-no">324</span><span id="line-324"> null, 0, 0, PrivateConstants.OLDEST_TIMESTAMP, Type.Minimum.getCode());</span> |
| <span class="source-line-no">325</span><span id="line-325"> } else {</span> |
| <span class="source-line-no">326</span><span id="line-326"> return PrivateCellUtil.compareKeyBasedOnColHint(rowComparator, nextIndexed, currentCell,</span> |
| <span class="source-line-no">327</span><span id="line-327"> currentCell.getFamilyOffset(), currentCell.getFamilyLength(), nextColumn.getBuffer(),</span> |
| <span class="source-line-no">328</span><span id="line-328"> nextColumn.getOffset(), nextColumn.getLength(), HConstants.LATEST_TIMESTAMP,</span> |
| <span class="source-line-no">329</span><span id="line-329"> Type.Maximum.getCode());</span> |
| <span class="source-line-no">330</span><span id="line-330"> }</span> |
| <span class="source-line-no">331</span><span id="line-331"> }</span> |
| <span class="source-line-no">332</span><span id="line-332"></span> |
| <span class="source-line-no">333</span><span id="line-333"> /** Returns the Filter */</span> |
| <span class="source-line-no">334</span><span id="line-334"> public abstract Filter getFilter();</span> |
| <span class="source-line-no">335</span><span id="line-335"></span> |
| <span class="source-line-no">336</span><span id="line-336"> /**</span> |
| <span class="source-line-no">337</span><span id="line-337"> * Delegate to {@link Filter#getNextCellHint(Cell)}. If no filter, return {@code null}.</span> |
| <span class="source-line-no">338</span><span id="line-338"> */</span> |
| <span class="source-line-no">339</span><span id="line-339"> public abstract ExtendedCell getNextKeyHint(ExtendedCell cell) throws IOException;</span> |
| <span class="source-line-no">340</span><span id="line-340"></span> |
| <span class="source-line-no">341</span><span id="line-341"> @Override</span> |
| <span class="source-line-no">342</span><span id="line-342"> public void beforeShipped() throws IOException {</span> |
| <span class="source-line-no">343</span><span id="line-343"> if (this.currentRow != null) {</span> |
| <span class="source-line-no">344</span><span id="line-344"> this.currentRow = PrivateCellUtil.createFirstOnRow(CellUtil.copyRow(this.currentRow));</span> |
| <span class="source-line-no">345</span><span id="line-345"> }</span> |
| <span class="source-line-no">346</span><span id="line-346"> if (columns != null) {</span> |
| <span class="source-line-no">347</span><span id="line-347"> columns.beforeShipped();</span> |
| <span class="source-line-no">348</span><span id="line-348"> }</span> |
| <span class="source-line-no">349</span><span id="line-349"> }</span> |
| <span class="source-line-no">350</span><span id="line-350"></span> |
| <span class="source-line-no">351</span><span id="line-351"> protected static ExtendedCell createStartKeyFromRow(byte[] startRow, ScanInfo scanInfo) {</span> |
| <span class="source-line-no">352</span><span id="line-352"> return PrivateCellUtil.createFirstDeleteFamilyCellOnRow(startRow, scanInfo.getFamily());</span> |
| <span class="source-line-no">353</span><span id="line-353"> }</span> |
| <span class="source-line-no">354</span><span id="line-354"></span> |
| <span class="source-line-no">355</span><span id="line-355"> protected static Pair<DeleteTracker, ColumnTracker> getTrackers(RegionCoprocessorHost host,</span> |
| <span class="source-line-no">356</span><span id="line-356"> NavigableSet<byte[]> columns, ScanInfo scanInfo, long oldestUnexpiredTS, Scan userScan)</span> |
| <span class="source-line-no">357</span><span id="line-357"> throws IOException {</span> |
| <span class="source-line-no">358</span><span id="line-358"> int resultMaxVersion = scanInfo.getMaxVersions();</span> |
| <span class="source-line-no">359</span><span id="line-359"> int maxVersionToCheck = resultMaxVersion;</span> |
| <span class="source-line-no">360</span><span id="line-360"> if (userScan != null) {</span> |
| <span class="source-line-no">361</span><span id="line-361"> if (userScan.isRaw()) {</span> |
| <span class="source-line-no">362</span><span id="line-362"> resultMaxVersion = userScan.getMaxVersions();</span> |
| <span class="source-line-no">363</span><span id="line-363"> maxVersionToCheck = userScan.hasFilter() ? Integer.MAX_VALUE : resultMaxVersion;</span> |
| <span class="source-line-no">364</span><span id="line-364"> } else {</span> |
| <span class="source-line-no">365</span><span id="line-365"> resultMaxVersion = Math.min(userScan.getMaxVersions(), scanInfo.getMaxVersions());</span> |
| <span class="source-line-no">366</span><span id="line-366"> maxVersionToCheck = userScan.hasFilter() ? scanInfo.getMaxVersions() : resultMaxVersion;</span> |
| <span class="source-line-no">367</span><span id="line-367"> }</span> |
| <span class="source-line-no">368</span><span id="line-368"> }</span> |
| <span class="source-line-no">369</span><span id="line-369"></span> |
| <span class="source-line-no">370</span><span id="line-370"> DeleteTracker deleteTracker;</span> |
| <span class="source-line-no">371</span><span id="line-371"> if (scanInfo.isNewVersionBehavior() && (userScan == null || !userScan.isRaw())) {</span> |
| <span class="source-line-no">372</span><span id="line-372"> deleteTracker = new NewVersionBehaviorTracker(columns, scanInfo.getComparator(),</span> |
| <span class="source-line-no">373</span><span id="line-373"> scanInfo.getMinVersions(), scanInfo.getMaxVersions(), resultMaxVersion, oldestUnexpiredTS);</span> |
| <span class="source-line-no">374</span><span id="line-374"> } else {</span> |
| <span class="source-line-no">375</span><span id="line-375"> deleteTracker = new ScanDeleteTracker(scanInfo.getComparator());</span> |
| <span class="source-line-no">376</span><span id="line-376"> }</span> |
| <span class="source-line-no">377</span><span id="line-377"> if (host != null) {</span> |
| <span class="source-line-no">378</span><span id="line-378"> deleteTracker = host.postInstantiateDeleteTracker(deleteTracker);</span> |
| <span class="source-line-no">379</span><span id="line-379"> if (deleteTracker instanceof VisibilityScanDeleteTracker && scanInfo.isNewVersionBehavior()) {</span> |
| <span class="source-line-no">380</span><span id="line-380"> deleteTracker = new VisibilityNewVersionBehaivorTracker(columns, scanInfo.getComparator(),</span> |
| <span class="source-line-no">381</span><span id="line-381"> scanInfo.getMinVersions(), scanInfo.getMaxVersions(), resultMaxVersion,</span> |
| <span class="source-line-no">382</span><span id="line-382"> oldestUnexpiredTS);</span> |
| <span class="source-line-no">383</span><span id="line-383"> }</span> |
| <span class="source-line-no">384</span><span id="line-384"> }</span> |
| <span class="source-line-no">385</span><span id="line-385"></span> |
| <span class="source-line-no">386</span><span id="line-386"> ColumnTracker columnTracker;</span> |
| <span class="source-line-no">387</span><span id="line-387"></span> |
| <span class="source-line-no">388</span><span id="line-388"> if (deleteTracker instanceof NewVersionBehaviorTracker) {</span> |
| <span class="source-line-no">389</span><span id="line-389"> columnTracker = (NewVersionBehaviorTracker) deleteTracker;</span> |
| <span class="source-line-no">390</span><span id="line-390"> } else if (columns == null || columns.size() == 0) {</span> |
| <span class="source-line-no">391</span><span id="line-391"> columnTracker = new ScanWildcardColumnTracker(scanInfo.getMinVersions(), maxVersionToCheck,</span> |
| <span class="source-line-no">392</span><span id="line-392"> oldestUnexpiredTS, scanInfo.getComparator());</span> |
| <span class="source-line-no">393</span><span id="line-393"> } else {</span> |
| <span class="source-line-no">394</span><span id="line-394"> columnTracker = new ExplicitColumnTracker(columns, scanInfo.getMinVersions(),</span> |
| <span class="source-line-no">395</span><span id="line-395"> maxVersionToCheck, oldestUnexpiredTS);</span> |
| <span class="source-line-no">396</span><span id="line-396"> }</span> |
| <span class="source-line-no">397</span><span id="line-397"> return new Pair<>(deleteTracker, columnTracker);</span> |
| <span class="source-line-no">398</span><span id="line-398"> }</span> |
| <span class="source-line-no">399</span><span id="line-399"></span> |
| <span class="source-line-no">400</span><span id="line-400"> // Used only for testing purposes</span> |
| <span class="source-line-no">401</span><span id="line-401"> static MatchCode checkColumn(ColumnTracker columnTracker, byte[] bytes, int offset, int length,</span> |
| <span class="source-line-no">402</span><span id="line-402"> long ttl, byte type, boolean ignoreCount) throws IOException {</span> |
| <span class="source-line-no">403</span><span id="line-403"> KeyValue kv = KeyValueUtil.createFirstOnRow(HConstants.EMPTY_BYTE_ARRAY, 0, 0,</span> |
| <span class="source-line-no">404</span><span id="line-404"> HConstants.EMPTY_BYTE_ARRAY, 0, 0, bytes, offset, length);</span> |
| <span class="source-line-no">405</span><span id="line-405"> MatchCode matchCode = columnTracker.checkColumn(kv, type);</span> |
| <span class="source-line-no">406</span><span id="line-406"> if (matchCode == MatchCode.INCLUDE) {</span> |
| <span class="source-line-no">407</span><span id="line-407"> return columnTracker.checkVersions(kv, ttl, type, ignoreCount);</span> |
| <span class="source-line-no">408</span><span id="line-408"> }</span> |
| <span class="source-line-no">409</span><span id="line-409"> return matchCode;</span> |
| <span class="source-line-no">410</span><span id="line-410"> }</span> |
| <span class="source-line-no">411</span><span id="line-411">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
