blob: 93884985089afe13dc24f3d242f0afa62dfe8d2f [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> *<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a>
<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a>
<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a>
<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a>
<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a>
<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.mob;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.conf.Configuration;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configured;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.fs.FileSystem;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HConstants;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.TableName;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.ConnectionFactory;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.TableDescriptor;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.io.hfile.CacheConfig;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.util.Tool;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.util.ToolRunner;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.slf4j.Logger;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.slf4j.LoggerFactory;<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>/**<a name="line.42"></a>
<span class="sourceLineNo">043</span> * The cleaner to delete the expired MOB files.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>@InterfaceAudience.Private<a name="line.45"></a>
<span class="sourceLineNo">046</span>public class ExpiredMobFileCleaner extends Configured implements Tool {<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> private static final Logger LOG = LoggerFactory.getLogger(ExpiredMobFileCleaner.class);<a name="line.48"></a>
<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * Cleans the MOB files when they're expired and their min versions are 0.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * If the latest timestamp of Cells in a MOB file is older than the TTL in the column family,<a name="line.51"></a>
<span class="sourceLineNo">052</span> * it's regarded as expired. This cleaner deletes them.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * At a time T0, the cells in a mob file M0 are expired. If a user starts a scan before T0, those<a name="line.53"></a>
<span class="sourceLineNo">054</span> * mob cells are visible, this scan still runs after T0. At that time T1, this mob file M0<a name="line.54"></a>
<span class="sourceLineNo">055</span> * is expired, meanwhile a cleaner starts, the M0 is archived and can be read in the archive<a name="line.55"></a>
<span class="sourceLineNo">056</span> * directory.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @param tableName The current table name.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @param family The current family.<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> public void cleanExpiredMobFiles(String tableName, ColumnFamilyDescriptor family) throws IOException {<a name="line.60"></a>
<span class="sourceLineNo">061</span> Configuration conf = getConf();<a name="line.61"></a>
<span class="sourceLineNo">062</span> TableName tn = TableName.valueOf(tableName);<a name="line.62"></a>
<span class="sourceLineNo">063</span> FileSystem fs = FileSystem.get(conf);<a name="line.63"></a>
<span class="sourceLineNo">064</span> LOG.info("Cleaning the expired MOB files of " + family.getNameAsString() + " in " + tableName);<a name="line.64"></a>
<span class="sourceLineNo">065</span> // disable the block cache.<a name="line.65"></a>
<span class="sourceLineNo">066</span> Configuration copyOfConf = new Configuration(conf);<a name="line.66"></a>
<span class="sourceLineNo">067</span> copyOfConf.setFloat(HConstants.HFILE_BLOCK_CACHE_SIZE_KEY, 0f);<a name="line.67"></a>
<span class="sourceLineNo">068</span> CacheConfig cacheConfig = new CacheConfig(copyOfConf);<a name="line.68"></a>
<span class="sourceLineNo">069</span> MobUtils.cleanExpiredMobFiles(fs, conf, tn, family, cacheConfig,<a name="line.69"></a>
<span class="sourceLineNo">070</span> EnvironmentEdgeManager.currentTime());<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> public static void main(String[] args) throws Exception {<a name="line.73"></a>
<span class="sourceLineNo">074</span> Configuration conf = HBaseConfiguration.create();<a name="line.74"></a>
<span class="sourceLineNo">075</span> ToolRunner.run(conf, new ExpiredMobFileCleaner(), args);<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> private void printUsage() {<a name="line.78"></a>
<span class="sourceLineNo">079</span> System.err.println("Usage:\n" + "--------------------------\n"<a name="line.79"></a>
<span class="sourceLineNo">080</span> + ExpiredMobFileCleaner.class.getName() + " tableName familyName");<a name="line.80"></a>
<span class="sourceLineNo">081</span> System.err.println(" tableName The table name");<a name="line.81"></a>
<span class="sourceLineNo">082</span> System.err.println(" familyName The column family name");<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> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="REC_CATCH_EXCEPTION",<a name="line.85"></a>
<span class="sourceLineNo">086</span> justification="Intentional")<a name="line.86"></a>
<span class="sourceLineNo">087</span> @Override<a name="line.87"></a>
<span class="sourceLineNo">088</span> public int run(String[] args) throws Exception {<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (args.length != 2) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> printUsage();<a name="line.90"></a>
<span class="sourceLineNo">091</span> return 1;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> String tableName = args[0];<a name="line.93"></a>
<span class="sourceLineNo">094</span> String familyName = args[1];<a name="line.94"></a>
<span class="sourceLineNo">095</span> TableName tn = TableName.valueOf(tableName);<a name="line.95"></a>
<span class="sourceLineNo">096</span> Connection connection = ConnectionFactory.createConnection(getConf());<a name="line.96"></a>
<span class="sourceLineNo">097</span> Admin admin = connection.getAdmin();<a name="line.97"></a>
<span class="sourceLineNo">098</span> try {<a name="line.98"></a>
<span class="sourceLineNo">099</span> TableDescriptor htd = admin.getDescriptor(tn);<a name="line.99"></a>
<span class="sourceLineNo">100</span> ColumnFamilyDescriptor family = htd.getColumnFamily(Bytes.toBytes(familyName));<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (family == null || !family.isMobEnabled()) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> throw new IOException("Column family " + familyName + " is not a MOB column family");<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (family.getMinVersions() &gt; 0) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> throw new IOException(<a name="line.105"></a>
<span class="sourceLineNo">106</span> "The minVersions of the column family is not 0, could not be handled by this cleaner");<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> cleanExpiredMobFiles(tableName, family);<a name="line.108"></a>
<span class="sourceLineNo">109</span> return 0;<a name="line.109"></a>
<span class="sourceLineNo">110</span> } finally {<a name="line.110"></a>
<span class="sourceLineNo">111</span> admin.close();<a name="line.111"></a>
<span class="sourceLineNo">112</span> try {<a name="line.112"></a>
<span class="sourceLineNo">113</span> connection.close();<a name="line.113"></a>
<span class="sourceLineNo">114</span> } catch (IOException e) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> LOG.error("Failed to close the connection.", e);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span>}<a name="line.119"></a>
</pre>
</div>
</body>
</html>