Google Git
Sign in
apache / hbase-site / 8ac68d4b7a8449d1b079203ac526389e2358d31e / . / devapidocs / src-html / org / apache / hadoop / hbase / backup / BackupDriver.html
blob: e8a893df987bf25162d4443bce246259338290f8 [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.backup;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_BACKUP_LIST_DESC;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_BANDWIDTH;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_BANDWIDTH_DESC;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_DEBUG;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_DEBUG_DESC;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_KEEP;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_KEEP_DESC;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_LIST;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_PATH;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_PATH_DESC;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_RECORD_NUMBER;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_RECORD_NUMBER_DESC;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_SET;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_SET_DESC;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_TABLE;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_TABLE_DESC;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_WORKERS;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_WORKERS_DESC;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_YARN_QUEUE_NAME;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import static org.apache.hadoop.hbase.backup.BackupRestoreConstants.OPTION_YARN_QUEUE_NAME_DESC;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>import java.io.IOException;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import java.net.URI;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.conf.Configuration;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.fs.Path;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.backup.BackupRestoreConstants.BackupCommand;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.backup.impl.BackupCommands;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.backup.impl.BackupManager;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.util.AbstractHBaseTool;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.util.FSUtils;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.apache.hadoop.util.ToolRunner;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.apache.log4j.Level;<a name="line.53"></a>
<span class="sourceLineNo">054</span>import org.apache.log4j.LogManager;<a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.slf4j.Logger;<a name="line.56"></a>
<span class="sourceLineNo">057</span>import org.slf4j.LoggerFactory;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>import org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine;<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> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * Command-line entry point for backup operation<a name="line.63"></a>
<span class="sourceLineNo">064</span> *<a name="line.64"></a>
<span class="sourceLineNo">065</span> */<a name="line.65"></a>
<span class="sourceLineNo">066</span>@InterfaceAudience.Private<a name="line.66"></a>
<span class="sourceLineNo">067</span>public class BackupDriver extends AbstractHBaseTool {<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> private static final Logger LOG = LoggerFactory.getLogger(BackupDriver.class);<a name="line.69"></a>
<span class="sourceLineNo">070</span> private CommandLine cmd;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> public BackupDriver() throws IOException {<a name="line.72"></a>
<span class="sourceLineNo">073</span> init();<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> protected void init() throws IOException {<a name="line.76"></a>
<span class="sourceLineNo">077</span> // disable irrelevant loggers to avoid it mess up command output<a name="line.77"></a>
<span class="sourceLineNo">078</span> LogUtils.disableZkAndClientLoggers();<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> private int parseAndRun(String[] args) throws IOException {<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> // Check if backup is enabled<a name="line.83"></a>
<span class="sourceLineNo">084</span> if (!BackupManager.isBackupEnabled(getConf())) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> System.err.println(BackupRestoreConstants.ENABLE_BACKUP);<a name="line.85"></a>
<span class="sourceLineNo">086</span> return -1;<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> System.out.println(BackupRestoreConstants.VERIFY_BACKUP);<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> String cmd = null;<a name="line.91"></a>
<span class="sourceLineNo">092</span> String[] remainArgs = null;<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (args == null || args.length == 0) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> printToolUsage();<a name="line.94"></a>
<span class="sourceLineNo">095</span> return -1;<a name="line.95"></a>
<span class="sourceLineNo">096</span> } else {<a name="line.96"></a>
<span class="sourceLineNo">097</span> cmd = args[0];<a name="line.97"></a>
<span class="sourceLineNo">098</span> remainArgs = new String[args.length - 1];<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (args.length &gt; 1) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> System.arraycopy(args, 1, remainArgs, 0, args.length - 1);<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> BackupCommand type = BackupCommand.HELP;<a name="line.104"></a>
<span class="sourceLineNo">105</span> if (BackupCommand.CREATE.name().equalsIgnoreCase(cmd)) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> type = BackupCommand.CREATE;<a name="line.106"></a>
<span class="sourceLineNo">107</span> } else if (BackupCommand.HELP.name().equalsIgnoreCase(cmd)) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> type = BackupCommand.HELP;<a name="line.108"></a>
<span class="sourceLineNo">109</span> } else if (BackupCommand.DELETE.name().equalsIgnoreCase(cmd)) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> type = BackupCommand.DELETE;<a name="line.110"></a>
<span class="sourceLineNo">111</span> } else if (BackupCommand.DESCRIBE.name().equalsIgnoreCase(cmd)) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> type = BackupCommand.DESCRIBE;<a name="line.112"></a>
<span class="sourceLineNo">113</span> } else if (BackupCommand.HISTORY.name().equalsIgnoreCase(cmd)) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> type = BackupCommand.HISTORY;<a name="line.114"></a>
<span class="sourceLineNo">115</span> } else if (BackupCommand.PROGRESS.name().equalsIgnoreCase(cmd)) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> type = BackupCommand.PROGRESS;<a name="line.116"></a>
<span class="sourceLineNo">117</span> } else if (BackupCommand.SET.name().equalsIgnoreCase(cmd)) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> type = BackupCommand.SET;<a name="line.118"></a>
<span class="sourceLineNo">119</span> } else if (BackupCommand.REPAIR.name().equalsIgnoreCase(cmd)) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> type = BackupCommand.REPAIR;<a name="line.120"></a>
<span class="sourceLineNo">121</span> } else if (BackupCommand.MERGE.name().equalsIgnoreCase(cmd)) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> type = BackupCommand.MERGE;<a name="line.122"></a>
<span class="sourceLineNo">123</span> } else {<a name="line.123"></a>
<span class="sourceLineNo">124</span> System.out.println("Unsupported command for backup: " + cmd);<a name="line.124"></a>
<span class="sourceLineNo">125</span> printToolUsage();<a name="line.125"></a>
<span class="sourceLineNo">126</span> return -1;<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> // enable debug logging<a name="line.129"></a>
<span class="sourceLineNo">130</span> if (this.cmd.hasOption(OPTION_DEBUG)) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> LogManager.getLogger("org.apache.hadoop.hbase.backup").setLevel(Level.DEBUG);<a name="line.131"></a>
<span class="sourceLineNo">132</span> } else {<a name="line.132"></a>
<span class="sourceLineNo">133</span> LogManager.getLogger("org.apache.hadoop.hbase.backup").setLevel(Level.INFO);<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> BackupCommands.Command command = BackupCommands.createCommand(getConf(), type, this.cmd);<a name="line.136"></a>
<span class="sourceLineNo">137</span> if (type == BackupCommand.CREATE &amp;&amp; conf != null) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> ((BackupCommands.CreateCommand) command).setConf(conf);<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span> try {<a name="line.140"></a>
<span class="sourceLineNo">141</span> command.execute();<a name="line.141"></a>
<span class="sourceLineNo">142</span> } catch (IOException e) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> if (e.getMessage().equals(BackupCommands.INCORRECT_USAGE)) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> return -1;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> throw e;<a name="line.146"></a>
<span class="sourceLineNo">147</span> } finally {<a name="line.147"></a>
<span class="sourceLineNo">148</span> command.finish();<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> return 0;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> @Override<a name="line.153"></a>
<span class="sourceLineNo">154</span> protected void addOptions() {<a name="line.154"></a>
<span class="sourceLineNo">155</span> // define supported options<a name="line.155"></a>
<span class="sourceLineNo">156</span> addOptNoArg(OPTION_DEBUG, OPTION_DEBUG_DESC);<a name="line.156"></a>
<span class="sourceLineNo">157</span> addOptWithArg(OPTION_TABLE, OPTION_TABLE_DESC);<a name="line.157"></a>
<span class="sourceLineNo">158</span> addOptWithArg(OPTION_BANDWIDTH, OPTION_BANDWIDTH_DESC);<a name="line.158"></a>
<span class="sourceLineNo">159</span> addOptWithArg(OPTION_LIST, OPTION_BACKUP_LIST_DESC);<a name="line.159"></a>
<span class="sourceLineNo">160</span> addOptWithArg(OPTION_WORKERS, OPTION_WORKERS_DESC);<a name="line.160"></a>
<span class="sourceLineNo">161</span> addOptWithArg(OPTION_RECORD_NUMBER, OPTION_RECORD_NUMBER_DESC);<a name="line.161"></a>
<span class="sourceLineNo">162</span> addOptWithArg(OPTION_SET, OPTION_SET_DESC);<a name="line.162"></a>
<span class="sourceLineNo">163</span> addOptWithArg(OPTION_PATH, OPTION_PATH_DESC);<a name="line.163"></a>
<span class="sourceLineNo">164</span> addOptWithArg(OPTION_KEEP, OPTION_KEEP_DESC);<a name="line.164"></a>
<span class="sourceLineNo">165</span> addOptWithArg(OPTION_YARN_QUEUE_NAME, OPTION_YARN_QUEUE_NAME_DESC);<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> @Override<a name="line.169"></a>
<span class="sourceLineNo">170</span> protected void processOptions(CommandLine cmd) {<a name="line.170"></a>
<span class="sourceLineNo">171</span> this.cmd = cmd;<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> @Override<a name="line.174"></a>
<span class="sourceLineNo">175</span> protected int doWork() throws Exception {<a name="line.175"></a>
<span class="sourceLineNo">176</span> return parseAndRun(cmd.getArgs());<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> public static void main(String[] args) throws Exception {<a name="line.179"></a>
<span class="sourceLineNo">180</span> Configuration conf = HBaseConfiguration.create();<a name="line.180"></a>
<span class="sourceLineNo">181</span> Path hbasedir = FSUtils.getRootDir(conf);<a name="line.181"></a>
<span class="sourceLineNo">182</span> URI defaultFs = hbasedir.getFileSystem(conf).getUri();<a name="line.182"></a>
<span class="sourceLineNo">183</span> FSUtils.setFsDefault(conf, new Path(defaultFs));<a name="line.183"></a>
<span class="sourceLineNo">184</span> int ret = ToolRunner.run(conf, new BackupDriver(), args);<a name="line.184"></a>
<span class="sourceLineNo">185</span> System.exit(ret);<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> @Override<a name="line.188"></a>
<span class="sourceLineNo">189</span> public int run(String[] args) throws IOException {<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (conf == null) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> LOG.error("Tool configuration is not initialized");<a name="line.191"></a>
<span class="sourceLineNo">192</span> throw new NullPointerException("conf");<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> CommandLine cmd;<a name="line.195"></a>
<span class="sourceLineNo">196</span> try {<a name="line.196"></a>
<span class="sourceLineNo">197</span> // parse the command line arguments<a name="line.197"></a>
<span class="sourceLineNo">198</span> cmd = parseArgs(args);<a name="line.198"></a>
<span class="sourceLineNo">199</span> cmdLineArgs = args;<a name="line.199"></a>
<span class="sourceLineNo">200</span> } catch (Exception e) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> System.err.println("Error when parsing command-line arguments: " + e.getMessage());<a name="line.201"></a>
<span class="sourceLineNo">202</span> printToolUsage();<a name="line.202"></a>
<span class="sourceLineNo">203</span> return EXIT_FAILURE;<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> processOptions(cmd);<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> int ret = EXIT_FAILURE;<a name="line.207"></a>
<span class="sourceLineNo">208</span> try {<a name="line.208"></a>
<span class="sourceLineNo">209</span> ret = doWork();<a name="line.209"></a>
<span class="sourceLineNo">210</span> } catch (Exception e) {<a name="line.210"></a>
<span class="sourceLineNo">211</span> LOG.error("Error running command-line tool", e);<a name="line.211"></a>
<span class="sourceLineNo">212</span> return EXIT_FAILURE;<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> return ret;<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> protected void printToolUsage() throws IOException {<a name="line.217"></a>
<span class="sourceLineNo">218</span> System.out.println(BackupCommands.USAGE);<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span>}<a name="line.220"></a>
</pre>
</div>
</body>
</html>