| <!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.util, class: HFileTestUtil"> |
| <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.util;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import static org.apache.hadoop.hbase.regionserver.HStoreFile.BULKLOAD_TIME_KEY;</span> |
| <span class="source-line-no">021</span><span id="line-21">import static org.junit.Assert.assertArrayEquals;</span> |
| <span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.fail;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">import java.io.IOException;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.Arrays;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.Locale;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.Optional;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.ArrayBackedTag;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.Cell;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.ExtendedCell;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.KeyValue;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.PrivateCellUtil;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.Tag;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.TagType;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.client.Result;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.client.ResultScanner;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.client.Scan;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.client.Table;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.io.hfile.CacheConfig;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.io.hfile.HFile;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.hbase.io.hfile.HFileContext;</span> |
| <span class="source-line-no">047</span><span id="line-47">import org.apache.hadoop.hbase.io.hfile.HFileContextBuilder;</span> |
| <span class="source-line-no">048</span><span id="line-48">import org.apache.hadoop.hbase.mob.MobUtils;</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50">/**</span> |
| <span class="source-line-no">051</span><span id="line-51"> * Utility class for HFile-related testing.</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53">public class HFileTestUtil {</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> public static final String OPT_DATA_BLOCK_ENCODING_USAGE = "Encoding algorithm (e.g. prefix "</span> |
| <span class="source-line-no">056</span><span id="line-56"> + "compression) to use for data blocks in the test column family, " + "one of "</span> |
| <span class="source-line-no">057</span><span id="line-57"> + Arrays.toString(DataBlockEncoding.values()) + ".";</span> |
| <span class="source-line-no">058</span><span id="line-58"> public static final String OPT_DATA_BLOCK_ENCODING =</span> |
| <span class="source-line-no">059</span><span id="line-59"> ColumnFamilyDescriptorBuilder.DATA_BLOCK_ENCODING.toLowerCase(Locale.ROOT);</span> |
| <span class="source-line-no">060</span><span id="line-60"> /** Column family used by the test */</span> |
| <span class="source-line-no">061</span><span id="line-61"> public static byte[] DEFAULT_COLUMN_FAMILY = Bytes.toBytes("test_cf");</span> |
| <span class="source-line-no">062</span><span id="line-62"> /** Column families used by the test */</span> |
| <span class="source-line-no">063</span><span id="line-63"> public static final byte[][] DEFAULT_COLUMN_FAMILIES = { DEFAULT_COLUMN_FAMILY };</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> /**</span> |
| <span class="source-line-no">066</span><span id="line-66"> * Create an HFile with the given number of rows between a given start key and end key @</span> |
| <span class="source-line-no">067</span><span id="line-67"> * family:qualifier. The value will be the key value. This file will not have tags.</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> public static void createHFile(Configuration configuration, FileSystem fs, Path path,</span> |
| <span class="source-line-no">070</span><span id="line-70"> byte[] family, byte[] qualifier, byte[] startKey, byte[] endKey, int numRows)</span> |
| <span class="source-line-no">071</span><span id="line-71"> throws IOException {</span> |
| <span class="source-line-no">072</span><span id="line-72"> createHFile(configuration, fs, path, DataBlockEncoding.NONE, family, qualifier, startKey,</span> |
| <span class="source-line-no">073</span><span id="line-73"> endKey, numRows, false);</span> |
| <span class="source-line-no">074</span><span id="line-74"> }</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"> * Create an HFile with the given number of rows between a given start key and end key @</span> |
| <span class="source-line-no">078</span><span id="line-78"> * family:qualifier. The value will be the key value. This file will use certain data block</span> |
| <span class="source-line-no">079</span><span id="line-79"> * encoding algorithm.</span> |
| <span class="source-line-no">080</span><span id="line-80"> */</span> |
| <span class="source-line-no">081</span><span id="line-81"> public static void createHFileWithDataBlockEncoding(Configuration configuration, FileSystem fs,</span> |
| <span class="source-line-no">082</span><span id="line-82"> Path path, DataBlockEncoding encoding, byte[] family, byte[] qualifier, byte[] startKey,</span> |
| <span class="source-line-no">083</span><span id="line-83"> byte[] endKey, int numRows) throws IOException {</span> |
| <span class="source-line-no">084</span><span id="line-84"> createHFile(configuration, fs, path, encoding, family, qualifier, startKey, endKey, numRows,</span> |
| <span class="source-line-no">085</span><span id="line-85"> false);</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> /**</span> |
| <span class="source-line-no">089</span><span id="line-89"> * Create an HFile with the given number of rows between a given start key and end key @</span> |
| <span class="source-line-no">090</span><span id="line-90"> * family:qualifier. The value will be the key value. This cells will also have a tag whose value</span> |
| <span class="source-line-no">091</span><span id="line-91"> * is the key.</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> public static void createHFileWithTags(Configuration configuration, FileSystem fs, Path path,</span> |
| <span class="source-line-no">094</span><span id="line-94"> byte[] family, byte[] qualifier, byte[] startKey, byte[] endKey, int numRows)</span> |
| <span class="source-line-no">095</span><span id="line-95"> throws IOException {</span> |
| <span class="source-line-no">096</span><span id="line-96"> createHFile(configuration, fs, path, DataBlockEncoding.NONE, family, qualifier, startKey,</span> |
| <span class="source-line-no">097</span><span id="line-97"> endKey, numRows, true);</span> |
| <span class="source-line-no">098</span><span id="line-98"> }</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"> * Create an HFile with the given number of rows between a given start key and end key @</span> |
| <span class="source-line-no">102</span><span id="line-102"> * family:qualifier. If withTag is true, we add the rowKey as the tag value for tagtype</span> |
| <span class="source-line-no">103</span><span id="line-103"> * MOB_TABLE_NAME_TAG_TYPE</span> |
| <span class="source-line-no">104</span><span id="line-104"> */</span> |
| <span class="source-line-no">105</span><span id="line-105"> public static void createHFile(Configuration configuration, FileSystem fs, Path path,</span> |
| <span class="source-line-no">106</span><span id="line-106"> DataBlockEncoding encoding, byte[] family, byte[] qualifier, byte[] startKey, byte[] endKey,</span> |
| <span class="source-line-no">107</span><span id="line-107"> int numRows, boolean withTag) throws IOException {</span> |
| <span class="source-line-no">108</span><span id="line-108"> HFileContext meta = new HFileContextBuilder().withIncludesTags(withTag)</span> |
| <span class="source-line-no">109</span><span id="line-109"> .withDataBlockEncoding(encoding).withColumnFamily(family).build();</span> |
| <span class="source-line-no">110</span><span id="line-110"> HFile.Writer writer = HFile.getWriterFactory(configuration, new CacheConfig(configuration))</span> |
| <span class="source-line-no">111</span><span id="line-111"> .withPath(fs, path).withFileContext(meta).create();</span> |
| <span class="source-line-no">112</span><span id="line-112"> long now = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">113</span><span id="line-113"> try {</span> |
| <span class="source-line-no">114</span><span id="line-114"> // subtract 2 since iterateOnSplits doesn't include boundary keys</span> |
| <span class="source-line-no">115</span><span id="line-115"> for (byte[] key : Bytes.iterateOnSplits(startKey, endKey, numRows - 2)) {</span> |
| <span class="source-line-no">116</span><span id="line-116"> ExtendedCell kv = new KeyValue(key, family, qualifier, now, key);</span> |
| <span class="source-line-no">117</span><span id="line-117"> if (withTag) {</span> |
| <span class="source-line-no">118</span><span id="line-118"> // add a tag. Arbitrarily chose mob tag since we have a helper already.</span> |
| <span class="source-line-no">119</span><span id="line-119"> Tag tableNameTag = new ArrayBackedTag(TagType.MOB_TABLE_NAME_TAG_TYPE, key);</span> |
| <span class="source-line-no">120</span><span id="line-120"> kv = MobUtils.createMobRefCell(kv, key, tableNameTag);</span> |
| <span class="source-line-no">121</span><span id="line-121"></span> |
| <span class="source-line-no">122</span><span id="line-122"> // verify that the kv has the tag.</span> |
| <span class="source-line-no">123</span><span id="line-123"> Optional<Tag> tag = PrivateCellUtil.getTag(kv, TagType.MOB_TABLE_NAME_TAG_TYPE);</span> |
| <span class="source-line-no">124</span><span id="line-124"> if (!tag.isPresent()) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> throw new IllegalStateException("Tag didn't stick to KV " + kv.toString());</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"> writer.append(kv);</span> |
| <span class="source-line-no">129</span><span id="line-129"> }</span> |
| <span class="source-line-no">130</span><span id="line-130"> } finally {</span> |
| <span class="source-line-no">131</span><span id="line-131"> writer.appendFileInfo(BULKLOAD_TIME_KEY, Bytes.toBytes(EnvironmentEdgeManager.currentTime()));</span> |
| <span class="source-line-no">132</span><span id="line-132"> writer.close();</span> |
| <span class="source-line-no">133</span><span id="line-133"> }</span> |
| <span class="source-line-no">134</span><span id="line-134"> }</span> |
| <span class="source-line-no">135</span><span id="line-135"></span> |
| <span class="source-line-no">136</span><span id="line-136"> /**</span> |
| <span class="source-line-no">137</span><span id="line-137"> * This verifies that each cell has a tag that is equal to its rowkey name. For this to work the</span> |
| <span class="source-line-no">138</span><span id="line-138"> * hbase instance must have HConstants.RPC_CODEC_CONF_KEY set to</span> |
| <span class="source-line-no">139</span><span id="line-139"> * KeyValueCodecWithTags.class.getCanonicalName());</span> |
| <span class="source-line-no">140</span><span id="line-140"> * @param table table containing tagged cells</span> |
| <span class="source-line-no">141</span><span id="line-141"> * @throws IOException if problems reading table</span> |
| <span class="source-line-no">142</span><span id="line-142"> */</span> |
| <span class="source-line-no">143</span><span id="line-143"> public static void verifyTags(Table table) throws IOException {</span> |
| <span class="source-line-no">144</span><span id="line-144"> ResultScanner s = table.getScanner(new Scan());</span> |
| <span class="source-line-no">145</span><span id="line-145"> for (Result r : s) {</span> |
| <span class="source-line-no">146</span><span id="line-146"> for (Cell c : r.listCells()) {</span> |
| <span class="source-line-no">147</span><span id="line-147"> Optional<Tag> tag =</span> |
| <span class="source-line-no">148</span><span id="line-148"> PrivateCellUtil.getTag((ExtendedCell) c, TagType.MOB_TABLE_NAME_TAG_TYPE);</span> |
| <span class="source-line-no">149</span><span id="line-149"> if (!tag.isPresent()) {</span> |
| <span class="source-line-no">150</span><span id="line-150"> fail(c.toString() + " has null tag");</span> |
| <span class="source-line-no">151</span><span id="line-151"> continue;</span> |
| <span class="source-line-no">152</span><span id="line-152"> }</span> |
| <span class="source-line-no">153</span><span id="line-153"> Tag t = tag.get();</span> |
| <span class="source-line-no">154</span><span id="line-154"> byte[] tval = Tag.cloneValue(t);</span> |
| <span class="source-line-no">155</span><span id="line-155"> assertArrayEquals(c.toString() + " has tag" + Bytes.toString(tval), r.getRow(), tval);</span> |
| <span class="source-line-no">156</span><span id="line-156"> }</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</span> |
| <span class="source-line-no">158</span><span id="line-158"> }</span> |
| <span class="source-line-no">159</span><span id="line-159">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |