blob: 02dd17a7ed29b7b4f0fae6fdd4df9901c8541143 [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.mapreduce, class: Export">
<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.mapreduce;</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.commons.lang3.ArrayUtils;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configured;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HBaseConfiguration;</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.Result;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.client.Scan;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.io.ImmutableBytesWritable;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.util.Triple;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.mapreduce.Job;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.mapreduce.lib.output.FileOutputFormat;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.mapreduce.lib.output.SequenceFileOutputFormat;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.util.Tool;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.util.ToolRunner;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">037</span><span id="line-37"></span>
<span class="source-line-no">038</span><span id="line-38">/**</span>
<span class="source-line-no">039</span><span id="line-39"> * Export an HBase table. Writes content to sequence files up in HDFS. Use {@link Import} to read it</span>
<span class="source-line-no">040</span><span id="line-40"> * back in again.</span>
<span class="source-line-no">041</span><span id="line-41"> */</span>
<span class="source-line-no">042</span><span id="line-42">@InterfaceAudience.Public</span>
<span class="source-line-no">043</span><span id="line-43">public class Export extends Configured implements Tool {</span>
<span class="source-line-no">044</span><span id="line-44"> static final String NAME = "export";</span>
<span class="source-line-no">045</span><span id="line-45"> static final String JOB_NAME_CONF_KEY = "mapreduce.job.name";</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> /**</span>
<span class="source-line-no">048</span><span id="line-48"> * Sets up the actual job.</span>
<span class="source-line-no">049</span><span id="line-49"> * @param conf The current configuration.</span>
<span class="source-line-no">050</span><span id="line-50"> * @param args The command line parameters.</span>
<span class="source-line-no">051</span><span id="line-51"> * @return The newly created job.</span>
<span class="source-line-no">052</span><span id="line-52"> * @throws IOException When setting up the job fails.</span>
<span class="source-line-no">053</span><span id="line-53"> */</span>
<span class="source-line-no">054</span><span id="line-54"> public static Job createSubmittableJob(Configuration conf, String[] args) throws IOException {</span>
<span class="source-line-no">055</span><span id="line-55"> Triple&lt;TableName, Scan, Path&gt; arguments = ExportUtils.getArgumentsFromCommandLine(conf, args);</span>
<span class="source-line-no">056</span><span id="line-56"> String tableName = arguments.getFirst().getNameAsString();</span>
<span class="source-line-no">057</span><span id="line-57"> Path outputDir = arguments.getThird();</span>
<span class="source-line-no">058</span><span id="line-58"> Job job = Job.getInstance(conf, conf.get(JOB_NAME_CONF_KEY, NAME + "_" + tableName));</span>
<span class="source-line-no">059</span><span id="line-59"> job.setJobName(NAME + "_" + tableName);</span>
<span class="source-line-no">060</span><span id="line-60"> job.setJarByClass(Export.class);</span>
<span class="source-line-no">061</span><span id="line-61"> // Set optional scan parameters</span>
<span class="source-line-no">062</span><span id="line-62"> Scan s = arguments.getSecond();</span>
<span class="source-line-no">063</span><span id="line-63"> IdentityTableMapper.initJob(tableName, s, IdentityTableMapper.class, job);</span>
<span class="source-line-no">064</span><span id="line-64"> // No reducers. Just write straight to output files.</span>
<span class="source-line-no">065</span><span id="line-65"> job.setNumReduceTasks(0);</span>
<span class="source-line-no">066</span><span id="line-66"> job.setOutputFormatClass(SequenceFileOutputFormat.class);</span>
<span class="source-line-no">067</span><span id="line-67"> job.setOutputKeyClass(ImmutableBytesWritable.class);</span>
<span class="source-line-no">068</span><span id="line-68"> job.setOutputValueClass(Result.class);</span>
<span class="source-line-no">069</span><span id="line-69"> FileOutputFormat.setOutputPath(job, outputDir); // job conf doesn't contain the conf so doesn't</span>
<span class="source-line-no">070</span><span id="line-70"> // have a default fs.</span>
<span class="source-line-no">071</span><span id="line-71"> return job;</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"> @Override</span>
<span class="source-line-no">075</span><span id="line-75"> public int run(String[] args) throws Exception {</span>
<span class="source-line-no">076</span><span id="line-76"> if (!ExportUtils.isValidArguements(args)) {</span>
<span class="source-line-no">077</span><span id="line-77"> ExportUtils.usage("Wrong number of arguments: " + ArrayUtils.getLength(args));</span>
<span class="source-line-no">078</span><span id="line-78"> System.err.println(" -D " + JOB_NAME_CONF_KEY</span>
<span class="source-line-no">079</span><span id="line-79"> + "=jobName - use the specified mapreduce job name for the export");</span>
<span class="source-line-no">080</span><span id="line-80"> System.err.println("For MR performance consider the following properties:");</span>
<span class="source-line-no">081</span><span id="line-81"> System.err.println(" -D mapreduce.map.speculative=false");</span>
<span class="source-line-no">082</span><span id="line-82"> System.err.println(" -D mapreduce.reduce.speculative=false");</span>
<span class="source-line-no">083</span><span id="line-83"> return -1;</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"> Job job = createSubmittableJob(getConf(), args);</span>
<span class="source-line-no">086</span><span id="line-86"> return (job.waitForCompletion(true) ? 0 : 1);</span>
<span class="source-line-no">087</span><span id="line-87"> }</span>
<span class="source-line-no">088</span><span id="line-88"></span>
<span class="source-line-no">089</span><span id="line-89"> /**</span>
<span class="source-line-no">090</span><span id="line-90"> * Main entry point.</span>
<span class="source-line-no">091</span><span id="line-91"> * @param args The command line parameters.</span>
<span class="source-line-no">092</span><span id="line-92"> * @throws Exception When running the job fails.</span>
<span class="source-line-no">093</span><span id="line-93"> */</span>
<span class="source-line-no">094</span><span id="line-94"> public static void main(String[] args) throws Exception {</span>
<span class="source-line-no">095</span><span id="line-95"> int errCode = ToolRunner.run(HBaseConfiguration.create(), new Export(), args);</span>
<span class="source-line-no">096</span><span id="line-96"> System.exit(errCode);</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98">}</span>
</pre>
</div>
</main>
</body>
</html>