blob: 220726ebfc5b11a72e658f264cb81be970e92f85 [file] [log] [blame]
<!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.tool, class: DataBlockEncodingValidator">
<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.tool;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.List;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.client.Admin;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.Connection;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.ConnectionFactory;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.TableDescriptor;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.AbstractHBaseTool;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">032</span><span id="line-32">import org.slf4j.Logger;</span>
<span class="source-line-no">033</span><span id="line-33">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine;</span>
<span class="source-line-no">036</span><span id="line-36"></span>
<span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.TOOLS)</span>
<span class="source-line-no">038</span><span id="line-38">public class DataBlockEncodingValidator extends AbstractHBaseTool {</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> private static final Logger LOG = LoggerFactory.getLogger(DataBlockEncodingValidator.class);</span>
<span class="source-line-no">041</span><span id="line-41"> private static final byte[] DATA_BLOCK_ENCODING = Bytes.toBytes("DATA_BLOCK_ENCODING");</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> /**</span>
<span class="source-line-no">044</span><span id="line-44"> * Check DataBlockEncodings of column families are compatible.</span>
<span class="source-line-no">045</span><span id="line-45"> * @return number of column families with incompatible DataBlockEncoding</span>
<span class="source-line-no">046</span><span id="line-46"> * @throws IOException if a remote or network exception occurs</span>
<span class="source-line-no">047</span><span id="line-47"> */</span>
<span class="source-line-no">048</span><span id="line-48"> private int validateDBE() throws IOException {</span>
<span class="source-line-no">049</span><span id="line-49"> int incompatibilities = 0;</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> LOG.info("Validating Data Block Encodings");</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> try (Connection connection = ConnectionFactory.createConnection(getConf());</span>
<span class="source-line-no">054</span><span id="line-54"> Admin admin = connection.getAdmin()) {</span>
<span class="source-line-no">055</span><span id="line-55"> List&lt;TableDescriptor&gt; tableDescriptors = admin.listTableDescriptors();</span>
<span class="source-line-no">056</span><span id="line-56"> String encoding = "";</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> for (TableDescriptor td : tableDescriptors) {</span>
<span class="source-line-no">059</span><span id="line-59"> ColumnFamilyDescriptor[] columnFamilies = td.getColumnFamilies();</span>
<span class="source-line-no">060</span><span id="line-60"> for (ColumnFamilyDescriptor cfd : columnFamilies) {</span>
<span class="source-line-no">061</span><span id="line-61"> try {</span>
<span class="source-line-no">062</span><span id="line-62"> encoding = Bytes.toString(cfd.getValue(DATA_BLOCK_ENCODING));</span>
<span class="source-line-no">063</span><span id="line-63"> // IllegalArgumentException will be thrown if encoding is incompatible with 2.0</span>
<span class="source-line-no">064</span><span id="line-64"> DataBlockEncoding.valueOf(encoding);</span>
<span class="source-line-no">065</span><span id="line-65"> } catch (IllegalArgumentException e) {</span>
<span class="source-line-no">066</span><span id="line-66"> incompatibilities++;</span>
<span class="source-line-no">067</span><span id="line-67"> LOG.warn("Incompatible DataBlockEncoding for table: {}, cf: {}, encoding: {}",</span>
<span class="source-line-no">068</span><span id="line-68"> td.getTableName().getNameAsString(), cfd.getNameAsString(), encoding);</span>
<span class="source-line-no">069</span><span id="line-69"> }</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"> }</span>
<span class="source-line-no">073</span><span id="line-73"></span>
<span class="source-line-no">074</span><span id="line-74"> if (incompatibilities &gt; 0) {</span>
<span class="source-line-no">075</span><span id="line-75"> LOG.warn("There are {} column families with incompatible Data Block Encodings. Do not "</span>
<span class="source-line-no">076</span><span id="line-76"> + "upgrade until these encodings are converted to a supported one. "</span>
<span class="source-line-no">077</span><span id="line-77"> + "Check https://s.apache.org/prefixtree for instructions.", incompatibilities);</span>
<span class="source-line-no">078</span><span id="line-78"> } else {</span>
<span class="source-line-no">079</span><span id="line-79"> LOG.info("The used Data Block Encodings are compatible with HBase 2.0.");</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> return incompatibilities;</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> @Override</span>
<span class="source-line-no">086</span><span id="line-86"> protected void printUsage() {</span>
<span class="source-line-no">087</span><span id="line-87"> String header =</span>
<span class="source-line-no">088</span><span id="line-88"> "hbase " + PreUpgradeValidator.TOOL_NAME + " " + PreUpgradeValidator.VALIDATE_DBE_NAME;</span>
<span class="source-line-no">089</span><span id="line-89"> printUsage(header, null, "");</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> @Override</span>
<span class="source-line-no">093</span><span id="line-93"> protected void addOptions() {</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> @Override</span>
<span class="source-line-no">097</span><span id="line-97"> protected void processOptions(CommandLine cmd) {</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"> @Override</span>
<span class="source-line-no">101</span><span id="line-101"> protected int doWork() throws Exception {</span>
<span class="source-line-no">102</span><span id="line-102"> return (validateDBE() == 0) ? EXIT_SUCCESS : EXIT_FAILURE;</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104">}</span>
</pre>
</div>
</main>
</body>
</html>