blob: e273d7f2548503812d1af64315448cc8a79ff932 [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: MultiTableSnapshotInputFormat">
<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 java.util.Collection;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.Map;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.Scan;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.mapreduce.InputSplit;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.mapreduce.JobContext;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">030</span><span id="line-30"></span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.com.google.common.collect.Lists;</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33">/**</span>
<span class="source-line-no">034</span><span id="line-34"> * MultiTableSnapshotInputFormat generalizes {@link TableSnapshotInputFormat} allowing a MapReduce</span>
<span class="source-line-no">035</span><span id="line-35"> * job to run over one or more table snapshots, with one or more scans configured for each.</span>
<span class="source-line-no">036</span><span id="line-36"> * Internally, the input format delegates to {@link TableSnapshotInputFormat} and thus has the same</span>
<span class="source-line-no">037</span><span id="line-37"> * performance advantages; see {@link TableSnapshotInputFormat} for more details. Usage is similar</span>
<span class="source-line-no">038</span><span id="line-38"> * to TableSnapshotInputFormat, with the following exception: initMultiTableSnapshotMapperJob takes</span>
<span class="source-line-no">039</span><span id="line-39"> * in a map from snapshot name to a collection of scans. For each snapshot in the map, each</span>
<span class="source-line-no">040</span><span id="line-40"> * corresponding scan will be applied; the overall dataset for the job is defined by the</span>
<span class="source-line-no">041</span><span id="line-41"> * concatenation of the regions and tables included in each snapshot/scan pair.</span>
<span class="source-line-no">042</span><span id="line-42"> * {@link TableMapReduceUtil#initMultiTableSnapshotMapperJob (Map, Class, Class, Class, org.apache.hadoop.mapreduce.Job, boolean, Path)}</span>
<span class="source-line-no">043</span><span id="line-43"> * can be used to configure the job.</span>
<span class="source-line-no">044</span><span id="line-44"> *</span>
<span class="source-line-no">045</span><span id="line-45"> * &lt;pre&gt;</span>
<span class="source-line-no">046</span><span id="line-46"> * {@code</span>
<span class="source-line-no">047</span><span id="line-47"> * Job job = new Job(conf);</span>
<span class="source-line-no">048</span><span id="line-48"> * Map&lt;String, Collection&lt;Scan&gt;&gt; snapshotScans = ImmutableMap.of(</span>
<span class="source-line-no">049</span><span id="line-49"> * "snapshot1", ImmutableList.of(new Scan(Bytes.toBytes("a"), Bytes.toBytes("b"))),</span>
<span class="source-line-no">050</span><span id="line-50"> * "snapshot2", ImmutableList.of(new Scan(Bytes.toBytes("1"), Bytes.toBytes("2")))</span>
<span class="source-line-no">051</span><span id="line-51"> * );</span>
<span class="source-line-no">052</span><span id="line-52"> * Path restoreDir = new Path("/tmp/snapshot_restore_dir")</span>
<span class="source-line-no">053</span><span id="line-53"> * TableMapReduceUtil.initTableSnapshotMapperJob(</span>
<span class="source-line-no">054</span><span id="line-54"> * snapshotScans, MyTableMapper.class, MyMapKeyOutput.class,</span>
<span class="source-line-no">055</span><span id="line-55"> * MyMapOutputValueWritable.class, job, true, restoreDir);</span>
<span class="source-line-no">056</span><span id="line-56"> * }</span>
<span class="source-line-no">057</span><span id="line-57"> * &lt;/pre&gt;</span>
<span class="source-line-no">058</span><span id="line-58"> *</span>
<span class="source-line-no">059</span><span id="line-59"> * Internally, this input format restores each snapshot into a subdirectory of the given tmp</span>
<span class="source-line-no">060</span><span id="line-60"> * directory. Input splits and record readers are created as described in</span>
<span class="source-line-no">061</span><span id="line-61"> * {@link org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat} (one per region). See</span>
<span class="source-line-no">062</span><span id="line-62"> * {@link TableSnapshotInputFormat} for more notes on permissioning; the same caveats apply here.</span>
<span class="source-line-no">063</span><span id="line-63"> * @see TableSnapshotInputFormat</span>
<span class="source-line-no">064</span><span id="line-64"> * @see org.apache.hadoop.hbase.client.TableSnapshotScanner</span>
<span class="source-line-no">065</span><span id="line-65"> */</span>
<span class="source-line-no">066</span><span id="line-66">@InterfaceAudience.Public</span>
<span class="source-line-no">067</span><span id="line-67">public class MultiTableSnapshotInputFormat extends TableSnapshotInputFormat {</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> private final MultiTableSnapshotInputFormatImpl delegate;</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 MultiTableSnapshotInputFormat() {</span>
<span class="source-line-no">072</span><span id="line-72"> this.delegate = new MultiTableSnapshotInputFormatImpl();</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"> @Override</span>
<span class="source-line-no">076</span><span id="line-76"> public List&lt;InputSplit&gt; getSplits(JobContext jobContext)</span>
<span class="source-line-no">077</span><span id="line-77"> throws IOException, InterruptedException {</span>
<span class="source-line-no">078</span><span id="line-78"> List&lt;TableSnapshotInputFormatImpl.InputSplit&gt; splits =</span>
<span class="source-line-no">079</span><span id="line-79"> delegate.getSplits(jobContext.getConfiguration());</span>
<span class="source-line-no">080</span><span id="line-80"> List&lt;InputSplit&gt; rtn = Lists.newArrayListWithCapacity(splits.size());</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> for (TableSnapshotInputFormatImpl.InputSplit split : splits) {</span>
<span class="source-line-no">083</span><span id="line-83"> rtn.add(new TableSnapshotInputFormat.TableSnapshotRegionSplit(split));</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> return rtn;</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"> public static void setInput(Configuration configuration,</span>
<span class="source-line-no">090</span><span id="line-90"> Map&lt;String, Collection&lt;Scan&gt;&gt; snapshotScans, Path tmpRestoreDir) throws IOException {</span>
<span class="source-line-no">091</span><span id="line-91"> new MultiTableSnapshotInputFormatImpl().setInput(configuration, snapshotScans, tmpRestoreDir);</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93">}</span>
</pre>
</div>
</main>
</body>
</html>