| <!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.mob, class: ExpiredMobFileCleaner"> |
| <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.mob;</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 org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.conf.Configured;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.HBaseConfiguration;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.Admin;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.client.Connection;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.client.ConnectionFactory;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.client.TableDescriptor;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.io.hfile.CacheConfig;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.util.Tool;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.util.ToolRunner;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.slf4j.Logger;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41">/**</span> |
| <span class="source-line-no">042</span><span id="line-42"> * The cleaner to delete the expired MOB files.</span> |
| <span class="source-line-no">043</span><span id="line-43"> */</span> |
| <span class="source-line-no">044</span><span id="line-44">@InterfaceAudience.Private</span> |
| <span class="source-line-no">045</span><span id="line-45">public class ExpiredMobFileCleaner extends Configured implements Tool {</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> private static final Logger LOG = LoggerFactory.getLogger(ExpiredMobFileCleaner.class);</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> /**</span> |
| <span class="source-line-no">050</span><span id="line-50"> * Cleans the MOB files when they're expired and their min versions are 0. If the latest timestamp</span> |
| <span class="source-line-no">051</span><span id="line-51"> * of Cells in a MOB file is older than the TTL in the column family, it's regarded as expired.</span> |
| <span class="source-line-no">052</span><span id="line-52"> * This cleaner deletes them. At a time T0, the cells in a mob file M0 are expired. If a user</span> |
| <span class="source-line-no">053</span><span id="line-53"> * starts a scan before T0, those mob cells are visible, this scan still runs after T0. At that</span> |
| <span class="source-line-no">054</span><span id="line-54"> * time T1, this mob file M0 is expired, meanwhile a cleaner starts, the M0 is archived and can be</span> |
| <span class="source-line-no">055</span><span id="line-55"> * read in the archive directory.</span> |
| <span class="source-line-no">056</span><span id="line-56"> * @param tableName The current table name.</span> |
| <span class="source-line-no">057</span><span id="line-57"> * @param family The current family.</span> |
| <span class="source-line-no">058</span><span id="line-58"> */</span> |
| <span class="source-line-no">059</span><span id="line-59"> public void cleanExpiredMobFiles(String tableName, ColumnFamilyDescriptor family)</span> |
| <span class="source-line-no">060</span><span id="line-60"> throws IOException {</span> |
| <span class="source-line-no">061</span><span id="line-61"> Configuration conf = getConf();</span> |
| <span class="source-line-no">062</span><span id="line-62"> TableName tn = TableName.valueOf(tableName);</span> |
| <span class="source-line-no">063</span><span id="line-63"> FileSystem fs = FileSystem.get(conf);</span> |
| <span class="source-line-no">064</span><span id="line-64"> LOG.info("Cleaning the expired MOB files of " + family.getNameAsString() + " in " + tableName);</span> |
| <span class="source-line-no">065</span><span id="line-65"> // disable the block cache.</span> |
| <span class="source-line-no">066</span><span id="line-66"> Configuration copyOfConf = new Configuration(conf);</span> |
| <span class="source-line-no">067</span><span id="line-67"> copyOfConf.setFloat(HConstants.HFILE_BLOCK_CACHE_SIZE_KEY, 0f);</span> |
| <span class="source-line-no">068</span><span id="line-68"> CacheConfig cacheConfig = new CacheConfig(copyOfConf);</span> |
| <span class="source-line-no">069</span><span id="line-69"> MobUtils.cleanExpiredMobFiles(fs, conf, tn, family, cacheConfig,</span> |
| <span class="source-line-no">070</span><span id="line-70"> EnvironmentEdgeManager.currentTime());</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"> public static void main(String[] args) throws Exception {</span> |
| <span class="source-line-no">074</span><span id="line-74"> Configuration conf = HBaseConfiguration.create();</span> |
| <span class="source-line-no">075</span><span id="line-75"> ToolRunner.run(conf, new ExpiredMobFileCleaner(), args);</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> private void printUsage() {</span> |
| <span class="source-line-no">079</span><span id="line-79"> System.err.println("Usage:\n" + "--------------------------\n"</span> |
| <span class="source-line-no">080</span><span id="line-80"> + ExpiredMobFileCleaner.class.getName() + " tableName familyName");</span> |
| <span class="source-line-no">081</span><span id="line-81"> System.err.println(" tableName The table name");</span> |
| <span class="source-line-no">082</span><span id="line-82"> System.err.println(" familyName The column family name");</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"> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "REC_CATCH_EXCEPTION",</span> |
| <span class="source-line-no">086</span><span id="line-86"> justification = "Intentional")</span> |
| <span class="source-line-no">087</span><span id="line-87"> @Override</span> |
| <span class="source-line-no">088</span><span id="line-88"> public int run(String[] args) throws Exception {</span> |
| <span class="source-line-no">089</span><span id="line-89"> if (args.length != 2) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> printUsage();</span> |
| <span class="source-line-no">091</span><span id="line-91"> return 1;</span> |
| <span class="source-line-no">092</span><span id="line-92"> }</span> |
| <span class="source-line-no">093</span><span id="line-93"> String tableName = args[0];</span> |
| <span class="source-line-no">094</span><span id="line-94"> String familyName = args[1];</span> |
| <span class="source-line-no">095</span><span id="line-95"> TableName tn = TableName.valueOf(tableName);</span> |
| <span class="source-line-no">096</span><span id="line-96"> Connection connection = ConnectionFactory.createConnection(getConf());</span> |
| <span class="source-line-no">097</span><span id="line-97"> Admin admin = connection.getAdmin();</span> |
| <span class="source-line-no">098</span><span id="line-98"> try {</span> |
| <span class="source-line-no">099</span><span id="line-99"> TableDescriptor htd = admin.getDescriptor(tn);</span> |
| <span class="source-line-no">100</span><span id="line-100"> ColumnFamilyDescriptor family = htd.getColumnFamily(Bytes.toBytes(familyName));</span> |
| <span class="source-line-no">101</span><span id="line-101"> if (family == null || !family.isMobEnabled()) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> throw new IOException("Column family " + familyName + " is not a MOB column family");</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104"> if (family.getMinVersions() > 0) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> throw new IOException(</span> |
| <span class="source-line-no">106</span><span id="line-106"> "The minVersions of the column family is not 0, could not be handled by this cleaner");</span> |
| <span class="source-line-no">107</span><span id="line-107"> }</span> |
| <span class="source-line-no">108</span><span id="line-108"> cleanExpiredMobFiles(tableName, family);</span> |
| <span class="source-line-no">109</span><span id="line-109"> return 0;</span> |
| <span class="source-line-no">110</span><span id="line-110"> } finally {</span> |
| <span class="source-line-no">111</span><span id="line-111"> admin.close();</span> |
| <span class="source-line-no">112</span><span id="line-112"> try {</span> |
| <span class="source-line-no">113</span><span id="line-113"> connection.close();</span> |
| <span class="source-line-no">114</span><span id="line-114"> } catch (IOException e) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> LOG.error("Failed to close the connection.", e);</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
