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