Google Git
Sign in
apache / hbase-site / 8464c4343b0e99023cf67df60d7e689dc7a5073f / . / apidocs / src-html / org / apache / hadoop / hbase / filter / TimestampsFilter.html
blob: af8738786dba82acc01796f1c8688497c4d777f1 [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.filter;<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.ArrayList;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Objects;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.TreeSet;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.Cell;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.PrivateCellUtil;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Filter that returns only cells whose timestamp (version) is<a name="line.36"></a>
<span class="sourceLineNo">037</span> * in the specified list of timestamps (versions).<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Note: Use of this filter overrides any time range/time stamp<a name="line.39"></a>
<span class="sourceLineNo">040</span> * options specified using {@link org.apache.hadoop.hbase.client.Get#setTimeRange(long, long)},<a name="line.40"></a>
<span class="sourceLineNo">041</span> * {@link org.apache.hadoop.hbase.client.Scan#setTimeRange(long, long)},<a name="line.41"></a>
<span class="sourceLineNo">042</span> * {@link org.apache.hadoop.hbase.client.Get#setTimestamp(long)},<a name="line.42"></a>
<span class="sourceLineNo">043</span> * or {@link org.apache.hadoop.hbase.client.Scan#setTimestamp(long)}.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>@InterfaceAudience.Public<a name="line.45"></a>
<span class="sourceLineNo">046</span>public class TimestampsFilter extends FilterBase {<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> private final boolean canHint;<a name="line.48"></a>
<span class="sourceLineNo">049</span> TreeSet&lt;Long&gt; timestamps;<a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final int MAX_LOG_TIMESTAMPS = 5;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> // Used during scans to hint the scan to stop early<a name="line.52"></a>
<span class="sourceLineNo">053</span> // once the timestamps fall below the minTimestamp.<a name="line.53"></a>
<span class="sourceLineNo">054</span> long minTimestamp = Long.MAX_VALUE;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Constructor for filter that retains only the specified timestamps in the list.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @param timestamps<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> public TimestampsFilter(List&lt;Long&gt; timestamps) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> this(timestamps, false);<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Constructor for filter that retains only those<a name="line.65"></a>
<span class="sourceLineNo">066</span> * cells whose timestamp (version) is in the specified<a name="line.66"></a>
<span class="sourceLineNo">067</span> * list of timestamps.<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @param timestamps list of timestamps that are wanted.<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @param canHint should the filter provide a seek hint? This can skip<a name="line.70"></a>
<span class="sourceLineNo">071</span> * past delete tombstones, so it should only be used when that<a name="line.71"></a>
<span class="sourceLineNo">072</span> * is not an issue ( no deletes, or don't care if data<a name="line.72"></a>
<span class="sourceLineNo">073</span> * becomes visible)<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> public TimestampsFilter(List&lt;Long&gt; timestamps, boolean canHint) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> for (Long timestamp : timestamps) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> Preconditions.checkArgument(timestamp &gt;= 0, "must be positive %s", timestamp);<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> this.canHint = canHint;<a name="line.79"></a>
<span class="sourceLineNo">080</span> this.timestamps = new TreeSet&lt;&gt;(timestamps);<a name="line.80"></a>
<span class="sourceLineNo">081</span> init();<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> * @return the list of timestamps<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> public List&lt;Long&gt; getTimestamps() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> List&lt;Long&gt; list = new ArrayList&lt;&gt;(timestamps.size());<a name="line.88"></a>
<span class="sourceLineNo">089</span> list.addAll(timestamps);<a name="line.89"></a>
<span class="sourceLineNo">090</span> return list;<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> private void init() {<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (this.timestamps.size() &gt; 0) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> minTimestamp = this.timestamps.first();<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<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> * Gets the minimum timestamp requested by filter.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @return minimum timestamp requested by filter.<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> public long getMin() {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return minTimestamp;<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> @Override<a name="line.107"></a>
<span class="sourceLineNo">108</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.108"></a>
<span class="sourceLineNo">109</span> // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.109"></a>
<span class="sourceLineNo">110</span> return false;<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> @Override<a name="line.113"></a>
<span class="sourceLineNo">114</span> public ReturnCode filterCell(final Cell c) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> if (this.timestamps.contains(c.getTimestamp())) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> return ReturnCode.INCLUDE;<a name="line.116"></a>
<span class="sourceLineNo">117</span> } else if (c.getTimestamp() &lt; minTimestamp) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> // The remaining versions of this column are guaranteed<a name="line.118"></a>
<span class="sourceLineNo">119</span> // to be lesser than all of the other values.<a name="line.119"></a>
<span class="sourceLineNo">120</span> return ReturnCode.NEXT_COL;<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span> return canHint ? ReturnCode.SEEK_NEXT_USING_HINT : ReturnCode.SKIP;<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * Pick the next cell that the scanner should seek to. Since this can skip any number of cells<a name="line.127"></a>
<span class="sourceLineNo">128</span> * any of which can be a delete this can resurect old data.<a name="line.128"></a>
<span class="sourceLineNo">129</span> *<a name="line.129"></a>
<span class="sourceLineNo">130</span> * The method will only be used if canHint was set to true while creating the filter.<a name="line.130"></a>
<span class="sourceLineNo">131</span> *<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @throws IOException This will never happen.<a name="line.132"></a>
<span class="sourceLineNo">133</span> */<a name="line.133"></a>
<span class="sourceLineNo">134</span> @Override<a name="line.134"></a>
<span class="sourceLineNo">135</span> public Cell getNextCellHint(Cell currentCell) throws IOException {<a name="line.135"></a>
<span class="sourceLineNo">136</span> if (!canHint) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> return null;<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> Long nextTimestampObject = timestamps.lower(currentCell.getTimestamp());<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> if (nextTimestampObject == null) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> // This should only happen if the current column's<a name="line.143"></a>
<span class="sourceLineNo">144</span> // timestamp is below the last one in the list.<a name="line.144"></a>
<span class="sourceLineNo">145</span> //<a name="line.145"></a>
<span class="sourceLineNo">146</span> // It should never happen as the filterCell should return NEXT_COL<a name="line.146"></a>
<span class="sourceLineNo">147</span> // but it's always better to be extra safe and protect against future<a name="line.147"></a>
<span class="sourceLineNo">148</span> // behavioral changes.<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> return PrivateCellUtil.createLastOnRowCol(currentCell);<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> // Since we know the nextTimestampObject isn't null here there must still be<a name="line.153"></a>
<span class="sourceLineNo">154</span> // timestamps that can be included. Cast the Long to a long and return the<a name="line.154"></a>
<span class="sourceLineNo">155</span> // a cell with the current row/cf/col and the next found timestamp.<a name="line.155"></a>
<span class="sourceLineNo">156</span> long nextTimestamp = nextTimestampObject;<a name="line.156"></a>
<span class="sourceLineNo">157</span> return PrivateCellUtil.createFirstOnRowColTS(currentCell, nextTimestamp);<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> public static Filter createFilterFromArguments(ArrayList&lt;byte []&gt; filterArguments) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> ArrayList&lt;Long&gt; timestamps = new ArrayList&lt;&gt;(filterArguments.size());<a name="line.161"></a>
<span class="sourceLineNo">162</span> for (int i = 0; i&lt;filterArguments.size(); i++) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> long timestamp = ParseFilter.convertByteArrayToLong(filterArguments.get(i));<a name="line.163"></a>
<span class="sourceLineNo">164</span> timestamps.add(timestamp);<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span> return new TimestampsFilter(timestamps);<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> * @return The filter serialized using pb<a name="line.170"></a>
<span class="sourceLineNo">171</span> */<a name="line.171"></a>
<span class="sourceLineNo">172</span> @Override<a name="line.172"></a>
<span class="sourceLineNo">173</span> public byte[] toByteArray() {<a name="line.173"></a>
<span class="sourceLineNo">174</span> FilterProtos.TimestampsFilter.Builder builder =<a name="line.174"></a>
<span class="sourceLineNo">175</span> FilterProtos.TimestampsFilter.newBuilder();<a name="line.175"></a>
<span class="sourceLineNo">176</span> builder.addAllTimestamps(this.timestamps);<a name="line.176"></a>
<span class="sourceLineNo">177</span> builder.setCanHint(canHint);<a name="line.177"></a>
<span class="sourceLineNo">178</span> return builder.build().toByteArray();<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> /**<a name="line.181"></a>
<span class="sourceLineNo">182</span> * @param pbBytes A pb serialized {@link TimestampsFilter} instance<a name="line.182"></a>
<span class="sourceLineNo">183</span> *<a name="line.183"></a>
<span class="sourceLineNo">184</span> * @return An instance of {@link TimestampsFilter} made from &lt;code&gt;bytes&lt;/code&gt;<a name="line.184"></a>
<span class="sourceLineNo">185</span> * @see #toByteArray<a name="line.185"></a>
<span class="sourceLineNo">186</span> */<a name="line.186"></a>
<span class="sourceLineNo">187</span> public static TimestampsFilter parseFrom(final byte[] pbBytes)<a name="line.187"></a>
<span class="sourceLineNo">188</span> throws DeserializationException {<a name="line.188"></a>
<span class="sourceLineNo">189</span> FilterProtos.TimestampsFilter proto;<a name="line.189"></a>
<span class="sourceLineNo">190</span> try {<a name="line.190"></a>
<span class="sourceLineNo">191</span> proto = FilterProtos.TimestampsFilter.parseFrom(pbBytes);<a name="line.191"></a>
<span class="sourceLineNo">192</span> } catch (InvalidProtocolBufferException e) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> throw new DeserializationException(e);<a name="line.193"></a>
<span class="sourceLineNo">194</span> }<a name="line.194"></a>
<span class="sourceLineNo">195</span> return new TimestampsFilter(proto.getTimestampsList(),<a name="line.195"></a>
<span class="sourceLineNo">196</span> proto.hasCanHint() &amp;&amp; proto.getCanHint());<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> /**<a name="line.199"></a>
<span class="sourceLineNo">200</span> * @param o the other filter to compare with<a name="line.200"></a>
<span class="sourceLineNo">201</span> * @return true if and only if the fields of the filter that are serialized<a name="line.201"></a>
<span class="sourceLineNo">202</span> * are equal to the corresponding fields in other. Used for testing.<a name="line.202"></a>
<span class="sourceLineNo">203</span> */<a name="line.203"></a>
<span class="sourceLineNo">204</span> @Override<a name="line.204"></a>
<span class="sourceLineNo">205</span> boolean areSerializedFieldsEqual(Filter o) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> if (o == this) return true;<a name="line.206"></a>
<span class="sourceLineNo">207</span> if (!(o instanceof TimestampsFilter)) return false;<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> TimestampsFilter other = (TimestampsFilter)o;<a name="line.209"></a>
<span class="sourceLineNo">210</span> return this.getTimestamps().equals(other.getTimestamps());<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> @Override<a name="line.213"></a>
<span class="sourceLineNo">214</span> public String toString() {<a name="line.214"></a>
<span class="sourceLineNo">215</span> return toString(MAX_LOG_TIMESTAMPS);<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> protected String toString(int maxTimestamps) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> StringBuilder tsList = new StringBuilder();<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> int count = 0;<a name="line.221"></a>
<span class="sourceLineNo">222</span> for (Long ts : this.timestamps) {<a name="line.222"></a>
<span class="sourceLineNo">223</span> if (count &gt;= maxTimestamps) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> break;<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span> ++count;<a name="line.226"></a>
<span class="sourceLineNo">227</span> tsList.append(ts.toString());<a name="line.227"></a>
<span class="sourceLineNo">228</span> if (count &lt; this.timestamps.size() &amp;&amp; count &lt; maxTimestamps) {<a name="line.228"></a>
<span class="sourceLineNo">229</span> tsList.append(", ");<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span> }<a name="line.231"></a>
<span class="sourceLineNo">232</span><a name="line.232"></a>
<span class="sourceLineNo">233</span> return String.format("%s (%d/%d): [%s] canHint: [%b]", this.getClass().getSimpleName(),<a name="line.233"></a>
<span class="sourceLineNo">234</span> count, this.timestamps.size(), tsList.toString(), canHint);<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span> @Override<a name="line.237"></a>
<span class="sourceLineNo">238</span> public boolean equals(Object obj) {<a name="line.238"></a>
<span class="sourceLineNo">239</span> return obj instanceof Filter &amp;&amp; areSerializedFieldsEqual((Filter) obj);<a name="line.239"></a>
<span class="sourceLineNo">240</span> }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> @Override<a name="line.242"></a>
<span class="sourceLineNo">243</span> public int hashCode() {<a name="line.243"></a>
<span class="sourceLineNo">244</span> return Objects.hash(getTimestamps());<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>
</pre>
</div>
</body>
</html>