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