Google Git
Sign in
apache / hbase-site / 2aa10ca80c343376b56fec8288ef4f3784acabb7 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / regionserver / TestScanWithBloomError.html
blob: 06f59571443c0402a42cef86bdecf9df9f49af13 [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;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.junit.Assert.assertEquals;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertTrue;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.ArrayList;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Arrays;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Collections;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Comparator;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.NavigableSet;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.TreeSet;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.conf.Configuration;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.fs.FileSystem;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.fs.Path;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.Cell;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.HBaseTestingUtil;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.KeyValueTestUtil;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.client.Put;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.io.compress.Compression;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.io.hfile.HFilePrettyPrinter;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.testclassification.RegionServerTests;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.testclassification.SmallTests;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.util.BloomFilterUtil;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.junit.Before;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.junit.ClassRule;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.junit.Test;<a name="line.53"></a>
<span class="sourceLineNo">054</span>import org.junit.experimental.categories.Category;<a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.junit.runner.RunWith;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.junit.runners.Parameterized;<a name="line.56"></a>
<span class="sourceLineNo">057</span>import org.junit.runners.Parameterized.Parameters;<a name="line.57"></a>
<span class="sourceLineNo">058</span>import org.slf4j.Logger;<a name="line.58"></a>
<span class="sourceLineNo">059</span>import org.slf4j.LoggerFactory;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>/**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Test a multi-column scanner when there is a Bloom filter false-positive. This is needed for the<a name="line.62"></a>
<span class="sourceLineNo">063</span> * multi-column Bloom filter optimization.<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span>@RunWith(Parameterized.class)<a name="line.65"></a>
<span class="sourceLineNo">066</span>@Category({ RegionServerTests.class, SmallTests.class })<a name="line.66"></a>
<span class="sourceLineNo">067</span>public class TestScanWithBloomError {<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> @ClassRule<a name="line.69"></a>
<span class="sourceLineNo">070</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.70"></a>
<span class="sourceLineNo">071</span> HBaseClassTestRule.forClass(TestScanWithBloomError.class);<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> private static final Logger LOG = LoggerFactory.getLogger(TestScanWithBloomError.class);<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> private static final String TABLE_NAME = "ScanWithBloomError";<a name="line.75"></a>
<span class="sourceLineNo">076</span> private static final String FAMILY = "myCF";<a name="line.76"></a>
<span class="sourceLineNo">077</span> private static final byte[] FAMILY_BYTES = Bytes.toBytes(FAMILY);<a name="line.77"></a>
<span class="sourceLineNo">078</span> private static final String ROW = "theRow";<a name="line.78"></a>
<span class="sourceLineNo">079</span> private static final String QUALIFIER_PREFIX = "qual";<a name="line.79"></a>
<span class="sourceLineNo">080</span> private static final byte[] ROW_BYTES = Bytes.toBytes(ROW);<a name="line.80"></a>
<span class="sourceLineNo">081</span> private static NavigableSet&lt;Integer&gt; allColIds = new TreeSet&lt;&gt;();<a name="line.81"></a>
<span class="sourceLineNo">082</span> private HRegion region;<a name="line.82"></a>
<span class="sourceLineNo">083</span> private BloomType bloomType;<a name="line.83"></a>
<span class="sourceLineNo">084</span> private FileSystem fs;<a name="line.84"></a>
<span class="sourceLineNo">085</span> private Configuration conf;<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> private final static HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> @Parameters<a name="line.89"></a>
<span class="sourceLineNo">090</span> public static final Collection&lt;Object[]&gt; parameters() {<a name="line.90"></a>
<span class="sourceLineNo">091</span> List&lt;Object[]&gt; configurations = new ArrayList&lt;&gt;();<a name="line.91"></a>
<span class="sourceLineNo">092</span> for (BloomType bloomType : BloomType.values()) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> configurations.add(new Object[] { bloomType });<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span> return configurations;<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> public TestScanWithBloomError(BloomType bloomType) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> this.bloomType = bloomType;<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> @Before<a name="line.102"></a>
<span class="sourceLineNo">103</span> public void setUp() throws IOException {<a name="line.103"></a>
<span class="sourceLineNo">104</span> conf = TEST_UTIL.getConfiguration();<a name="line.104"></a>
<span class="sourceLineNo">105</span> fs = FileSystem.get(conf);<a name="line.105"></a>
<span class="sourceLineNo">106</span> conf.setInt(BloomFilterUtil.PREFIX_LENGTH_KEY, 10);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> @Test<a name="line.109"></a>
<span class="sourceLineNo">110</span> public void testThreeStoreFiles() throws IOException {<a name="line.110"></a>
<span class="sourceLineNo">111</span> ColumnFamilyDescriptor columnFamilyDescriptor = ColumnFamilyDescriptorBuilder<a name="line.111"></a>
<span class="sourceLineNo">112</span> .newBuilder(Bytes.toBytes(FAMILY)).setCompressionType(Compression.Algorithm.GZ)<a name="line.112"></a>
<span class="sourceLineNo">113</span> .setBloomFilterType(bloomType).setMaxVersions(TestMultiColumnScanner.MAX_VERSIONS).build();<a name="line.113"></a>
<span class="sourceLineNo">114</span> region = TEST_UTIL.createTestRegion(TABLE_NAME, columnFamilyDescriptor);<a name="line.114"></a>
<span class="sourceLineNo">115</span> createStoreFile(new int[] { 1, 2, 6 });<a name="line.115"></a>
<span class="sourceLineNo">116</span> createStoreFile(new int[] { 1, 2, 3, 7 });<a name="line.116"></a>
<span class="sourceLineNo">117</span> createStoreFile(new int[] { 1, 9 });<a name="line.117"></a>
<span class="sourceLineNo">118</span> scanColSet(new int[] { 1, 4, 6, 7 }, new int[] { 1, 6, 7 });<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> HBaseTestingUtil.closeRegionAndWAL(region);<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> private void scanColSet(int[] colSet, int[] expectedResultCols) throws IOException {<a name="line.123"></a>
<span class="sourceLineNo">124</span> LOG.info("Scanning column set: " + Arrays.toString(colSet));<a name="line.124"></a>
<span class="sourceLineNo">125</span> Scan scan = new Scan().withStartRow(ROW_BYTES).withStopRow(ROW_BYTES, true);<a name="line.125"></a>
<span class="sourceLineNo">126</span> addColumnSetToScan(scan, colSet);<a name="line.126"></a>
<span class="sourceLineNo">127</span> RegionScannerImpl scanner = region.getScanner(scan);<a name="line.127"></a>
<span class="sourceLineNo">128</span> KeyValueHeap storeHeap = scanner.storeHeap;<a name="line.128"></a>
<span class="sourceLineNo">129</span> assertEquals(0, storeHeap.getHeap().size());<a name="line.129"></a>
<span class="sourceLineNo">130</span> StoreScanner storeScanner = (StoreScanner) storeHeap.getCurrentForTesting();<a name="line.130"></a>
<span class="sourceLineNo">131</span> @SuppressWarnings({ "unchecked", "rawtypes" })<a name="line.131"></a>
<span class="sourceLineNo">132</span> List&lt;StoreFileScanner&gt; scanners =<a name="line.132"></a>
<span class="sourceLineNo">133</span> (List&lt;StoreFileScanner&gt;) (List) storeScanner.getAllScannersForTesting();<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> // Sort scanners by their HFile's modification time.<a name="line.135"></a>
<span class="sourceLineNo">136</span> Collections.sort(scanners, new Comparator&lt;StoreFileScanner&gt;() {<a name="line.136"></a>
<span class="sourceLineNo">137</span> @Override<a name="line.137"></a>
<span class="sourceLineNo">138</span> public int compare(StoreFileScanner s1, StoreFileScanner s2) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> Path p1 = s1.getReader().getHFileReader().getPath();<a name="line.139"></a>
<span class="sourceLineNo">140</span> Path p2 = s2.getReader().getHFileReader().getPath();<a name="line.140"></a>
<span class="sourceLineNo">141</span> long t1, t2;<a name="line.141"></a>
<span class="sourceLineNo">142</span> try {<a name="line.142"></a>
<span class="sourceLineNo">143</span> t1 = fs.getFileStatus(p1).getModificationTime();<a name="line.143"></a>
<span class="sourceLineNo">144</span> t2 = fs.getFileStatus(p2).getModificationTime();<a name="line.144"></a>
<span class="sourceLineNo">145</span> } catch (IOException ex) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> throw new RuntimeException(ex);<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> return t1 &lt; t2 ? -1 : t1 == t2 ? 1 : 0;<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> });<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> StoreFileReader lastStoreFileReader = null;<a name="line.152"></a>
<span class="sourceLineNo">153</span> for (StoreFileScanner sfScanner : scanners)<a name="line.153"></a>
<span class="sourceLineNo">154</span> lastStoreFileReader = sfScanner.getReader();<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> new HFilePrettyPrinter(conf).run(<a name="line.156"></a>
<span class="sourceLineNo">157</span> new String[] { "-m", "-p", "-f", lastStoreFileReader.getHFileReader().getPath().toString() });<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> // Disable Bloom filter for the last store file. The disabled Bloom filter<a name="line.159"></a>
<span class="sourceLineNo">160</span> // will always return "true".<a name="line.160"></a>
<span class="sourceLineNo">161</span> LOG.info("Disabling Bloom filter for: " + lastStoreFileReader.getHFileReader().getName());<a name="line.161"></a>
<span class="sourceLineNo">162</span> lastStoreFileReader.disableBloomFilterForTesting();<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> List&lt;Cell&gt; allResults = new ArrayList&lt;&gt;();<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> { // Limit the scope of results.<a name="line.166"></a>
<span class="sourceLineNo">167</span> List&lt;Cell&gt; results = new ArrayList&lt;&gt;();<a name="line.167"></a>
<span class="sourceLineNo">168</span> while (scanner.next(results) || results.size() &gt; 0) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> allResults.addAll(results);<a name="line.169"></a>
<span class="sourceLineNo">170</span> results.clear();<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span> List&lt;Integer&gt; actualIds = new ArrayList&lt;&gt;();<a name="line.174"></a>
<span class="sourceLineNo">175</span> for (Cell kv : allResults) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> String qual = Bytes.toString(CellUtil.cloneQualifier(kv));<a name="line.176"></a>
<span class="sourceLineNo">177</span> assertTrue(qual.startsWith(QUALIFIER_PREFIX));<a name="line.177"></a>
<span class="sourceLineNo">178</span> actualIds.add(Integer.valueOf(qual.substring(QUALIFIER_PREFIX.length())));<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span> List&lt;Integer&gt; expectedIds = new ArrayList&lt;&gt;();<a name="line.180"></a>
<span class="sourceLineNo">181</span> for (int expectedId : expectedResultCols)<a name="line.181"></a>
<span class="sourceLineNo">182</span> expectedIds.add(expectedId);<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> LOG.info("Column ids returned: " + actualIds + ", expected: " + expectedIds);<a name="line.184"></a>
<span class="sourceLineNo">185</span> assertEquals(expectedIds.toString(), actualIds.toString());<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> private void addColumnSetToScan(Scan scan, int[] colIds) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> for (int colId : colIds) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> scan.addColumn(FAMILY_BYTES, Bytes.toBytes(qualFromId(colId)));<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span> private String qualFromId(int colId) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return QUALIFIER_PREFIX + colId;<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> private void createStoreFile(int[] colIds) throws IOException {<a name="line.198"></a>
<span class="sourceLineNo">199</span> Put p = new Put(ROW_BYTES);<a name="line.199"></a>
<span class="sourceLineNo">200</span> for (int colId : colIds) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> long ts = Long.MAX_VALUE;<a name="line.201"></a>
<span class="sourceLineNo">202</span> String qual = qualFromId(colId);<a name="line.202"></a>
<span class="sourceLineNo">203</span> allColIds.add(colId);<a name="line.203"></a>
<span class="sourceLineNo">204</span> KeyValue kv = KeyValueTestUtil.create(ROW, FAMILY, qual, ts,<a name="line.204"></a>
<span class="sourceLineNo">205</span> TestMultiColumnScanner.createValue(ROW, qual, ts));<a name="line.205"></a>
<span class="sourceLineNo">206</span> p.add(kv);<a name="line.206"></a>
<span class="sourceLineNo">207</span> }<a name="line.207"></a>
<span class="sourceLineNo">208</span> region.put(p);<a name="line.208"></a>
<span class="sourceLineNo">209</span> region.flush(true);<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<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>
</pre>
</div>
</body>
</html>