| <!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.mapred, class: TableOutputFormat"> |
| <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.mapred;</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.hadoop.fs.FileAlreadyExistsException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.client.BufferedMutator;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.Connection;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.ConnectionFactory;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.Put;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.io.ImmutableBytesWritable;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.mapred.FileOutputFormat;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.mapred.InvalidJobConfException;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.mapred.JobConf;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.mapred.RecordWriter;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.mapred.Reporter;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.util.Progressable;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37">/**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * Convert Map/Reduce output and write it to an HBase table</span> |
| <span class="source-line-no">039</span><span id="line-39"> */</span> |
| <span class="source-line-no">040</span><span id="line-40">@InterfaceAudience.Public</span> |
| <span class="source-line-no">041</span><span id="line-41">public class TableOutputFormat extends FileOutputFormat<ImmutableBytesWritable, Put> {</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43"> /** JobConf parameter that specifies the output table */</span> |
| <span class="source-line-no">044</span><span id="line-44"> public static final String OUTPUT_TABLE = "hbase.mapred.outputtable";</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> /**</span> |
| <span class="source-line-no">047</span><span id="line-47"> * Convert Reduce output (key, value) to (HStoreKey, KeyedDataArrayWritable) and write to an HBase</span> |
| <span class="source-line-no">048</span><span id="line-48"> * table.</span> |
| <span class="source-line-no">049</span><span id="line-49"> */</span> |
| <span class="source-line-no">050</span><span id="line-50"> protected static class TableRecordWriter implements RecordWriter<ImmutableBytesWritable, Put> {</span> |
| <span class="source-line-no">051</span><span id="line-51"> private BufferedMutator m_mutator;</span> |
| <span class="source-line-no">052</span><span id="line-52"> private Connection conn;</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Instantiate a TableRecordWriter with a BufferedMutator for batch writing.</span> |
| <span class="source-line-no">056</span><span id="line-56"> */</span> |
| <span class="source-line-no">057</span><span id="line-57"> public TableRecordWriter(JobConf job) throws IOException {</span> |
| <span class="source-line-no">058</span><span id="line-58"> // expecting exactly one path</span> |
| <span class="source-line-no">059</span><span id="line-59"> TableName tableName = TableName.valueOf(job.get(OUTPUT_TABLE));</span> |
| <span class="source-line-no">060</span><span id="line-60"> try {</span> |
| <span class="source-line-no">061</span><span id="line-61"> this.conn = ConnectionFactory.createConnection(job);</span> |
| <span class="source-line-no">062</span><span id="line-62"> this.m_mutator = conn.getBufferedMutator(tableName);</span> |
| <span class="source-line-no">063</span><span id="line-63"> } finally {</span> |
| <span class="source-line-no">064</span><span id="line-64"> if (this.m_mutator == null) {</span> |
| <span class="source-line-no">065</span><span id="line-65"> conn.close();</span> |
| <span class="source-line-no">066</span><span id="line-66"> conn = null;</span> |
| <span class="source-line-no">067</span><span id="line-67"> }</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</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 void close(Reporter reporter) throws IOException {</span> |
| <span class="source-line-no">072</span><span id="line-72"> try {</span> |
| <span class="source-line-no">073</span><span id="line-73"> if (this.m_mutator != null) {</span> |
| <span class="source-line-no">074</span><span id="line-74"> this.m_mutator.close();</span> |
| <span class="source-line-no">075</span><span id="line-75"> }</span> |
| <span class="source-line-no">076</span><span id="line-76"> } finally {</span> |
| <span class="source-line-no">077</span><span id="line-77"> if (conn != null) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> this.conn.close();</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"> }</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> public void write(ImmutableBytesWritable key, Put value) throws IOException {</span> |
| <span class="source-line-no">084</span><span id="line-84"> m_mutator.mutate(new Put(value));</span> |
| <span class="source-line-no">085</span><span id="line-85"> }</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"> /**</span> |
| <span class="source-line-no">089</span><span id="line-89"> * Creates a new record writer. Be aware that the baseline javadoc gives the impression that there</span> |
| <span class="source-line-no">090</span><span id="line-90"> * is a single {@link RecordWriter} per job but in HBase, it is more natural if we give you a new</span> |
| <span class="source-line-no">091</span><span id="line-91"> * RecordWriter per call of this method. You must close the returned RecordWriter when done.</span> |
| <span class="source-line-no">092</span><span id="line-92"> * Failure to do so will drop writes.</span> |
| <span class="source-line-no">093</span><span id="line-93"> * @param ignored Ignored filesystem</span> |
| <span class="source-line-no">094</span><span id="line-94"> * @param job Current JobConf</span> |
| <span class="source-line-no">095</span><span id="line-95"> * @param name Name of the job</span> |
| <span class="source-line-no">096</span><span id="line-96"> * @return The newly created writer instance.</span> |
| <span class="source-line-no">097</span><span id="line-97"> * @throws IOException When creating the writer fails.</span> |
| <span class="source-line-no">098</span><span id="line-98"> */</span> |
| <span class="source-line-no">099</span><span id="line-99"> @Override</span> |
| <span class="source-line-no">100</span><span id="line-100"> public RecordWriter getRecordWriter(FileSystem ignored, JobConf job, String name,</span> |
| <span class="source-line-no">101</span><span id="line-101"> Progressable progress) throws IOException {</span> |
| <span class="source-line-no">102</span><span id="line-102"> // Clear write buffer on fail is true by default so no need to reset it.</span> |
| <span class="source-line-no">103</span><span id="line-103"> return new TableRecordWriter(job);</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> @Override</span> |
| <span class="source-line-no">107</span><span id="line-107"> public void checkOutputSpecs(FileSystem ignored, JobConf job)</span> |
| <span class="source-line-no">108</span><span id="line-108"> throws FileAlreadyExistsException, InvalidJobConfException, IOException {</span> |
| <span class="source-line-no">109</span><span id="line-109"> String tableName = job.get(OUTPUT_TABLE);</span> |
| <span class="source-line-no">110</span><span id="line-110"> if (tableName == null) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> throw new IOException("Must specify table name");</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
