blob: 9409b171fbca3ffdb97777a6f73a2a5987b28dce [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: MultiTableInputFormat">
<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.ArrayList;</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 org.apache.hadoop.conf.Configurable;</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.hbase.client.Scan;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">027</span><span id="line-27"></span>
<span class="source-line-no">028</span><span id="line-28">/**</span>
<span class="source-line-no">029</span><span id="line-29"> * Convert HBase tabular data from multiple scanners into a format that is consumable by Map/Reduce.</span>
<span class="source-line-no">030</span><span id="line-30"> * &lt;p&gt;</span>
<span class="source-line-no">031</span><span id="line-31"> * Usage example</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;/p&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> *</span>
<span class="source-line-no">034</span><span id="line-34"> * &lt;pre&gt;</span>
<span class="source-line-no">035</span><span id="line-35"> * List&amp;lt;Scan&amp;gt; scans = new ArrayList&amp;lt;Scan&amp;gt;();</span>
<span class="source-line-no">036</span><span id="line-36"> *</span>
<span class="source-line-no">037</span><span id="line-37"> * Scan scan1 = new Scan();</span>
<span class="source-line-no">038</span><span id="line-38"> * scan1.withStartRow(firstRow1);</span>
<span class="source-line-no">039</span><span id="line-39"> * scan1.withStopRow(lastRow1);</span>
<span class="source-line-no">040</span><span id="line-40"> * scan1.setAttribute(Scan.SCAN_ATTRIBUTES_TABLE_NAME, table1);</span>
<span class="source-line-no">041</span><span id="line-41"> * scans.add(scan1);</span>
<span class="source-line-no">042</span><span id="line-42"> *</span>
<span class="source-line-no">043</span><span id="line-43"> * Scan scan2 = new Scan();</span>
<span class="source-line-no">044</span><span id="line-44"> * scan2.withStartRow(firstRow2);</span>
<span class="source-line-no">045</span><span id="line-45"> * scan2.withStopRow(lastRow2);</span>
<span class="source-line-no">046</span><span id="line-46"> * scan1.setAttribute(Scan.SCAN_ATTRIBUTES_TABLE_NAME, table2);</span>
<span class="source-line-no">047</span><span id="line-47"> * scans.add(scan2);</span>
<span class="source-line-no">048</span><span id="line-48"> *</span>
<span class="source-line-no">049</span><span id="line-49"> * TableMapReduceUtil.initTableMapperJob(scans, TableMapper.class, Text.class, IntWritable.class,</span>
<span class="source-line-no">050</span><span id="line-50"> * job);</span>
<span class="source-line-no">051</span><span id="line-51"> * &lt;/pre&gt;</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.Public</span>
<span class="source-line-no">054</span><span id="line-54">public class MultiTableInputFormat extends MultiTableInputFormatBase implements Configurable {</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> /** Job parameter that specifies the scan list. */</span>
<span class="source-line-no">057</span><span id="line-57"> public static final String SCANS = "hbase.mapreduce.scans";</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> /** The configuration. */</span>
<span class="source-line-no">060</span><span id="line-60"> private Configuration conf = null;</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"> * Returns the current configuration.</span>
<span class="source-line-no">064</span><span id="line-64"> * @return The current configuration.</span>
<span class="source-line-no">065</span><span id="line-65"> * @see org.apache.hadoop.conf.Configurable#getConf()</span>
<span class="source-line-no">066</span><span id="line-66"> */</span>
<span class="source-line-no">067</span><span id="line-67"> @Override</span>
<span class="source-line-no">068</span><span id="line-68"> public Configuration getConf() {</span>
<span class="source-line-no">069</span><span id="line-69"> return conf;</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> /**</span>
<span class="source-line-no">073</span><span id="line-73"> * Sets the configuration. This is used to set the details for the tables to be scanned.</span>
<span class="source-line-no">074</span><span id="line-74"> * @param configuration The configuration to set.</span>
<span class="source-line-no">075</span><span id="line-75"> * @see org.apache.hadoop.conf.Configurable#setConf( org.apache.hadoop.conf.Configuration)</span>
<span class="source-line-no">076</span><span id="line-76"> */</span>
<span class="source-line-no">077</span><span id="line-77"> @Override</span>
<span class="source-line-no">078</span><span id="line-78"> public void setConf(Configuration configuration) {</span>
<span class="source-line-no">079</span><span id="line-79"> this.conf = configuration;</span>
<span class="source-line-no">080</span><span id="line-80"> String[] rawScans = conf.getStrings(SCANS);</span>
<span class="source-line-no">081</span><span id="line-81"> if (rawScans.length &lt;= 0) {</span>
<span class="source-line-no">082</span><span id="line-82"> throw new IllegalArgumentException(</span>
<span class="source-line-no">083</span><span id="line-83"> "There must be at least 1 scan configuration set to : " + SCANS);</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"> List&lt;Scan&gt; scans = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> for (int i = 0; i &lt; rawScans.length; i++) {</span>
<span class="source-line-no">088</span><span id="line-88"> try {</span>
<span class="source-line-no">089</span><span id="line-89"> scans.add(TableMapReduceUtil.convertStringToScan(rawScans[i]));</span>
<span class="source-line-no">090</span><span id="line-90"> } catch (IOException e) {</span>
<span class="source-line-no">091</span><span id="line-91"> throw new RuntimeException("Failed to convert Scan : " + rawScans[i] + " to string", e);</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>
<span class="source-line-no">094</span><span id="line-94"> this.setScans(scans);</span>
<span class="source-line-no">095</span><span id="line-95"> }</span>
<span class="source-line-no">096</span><span id="line-96">}</span>
</pre>
</div>
</main>
</body>
</html>