| <!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: IndexBuilder, class: Map"> |
| <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.TreeMap;</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.hbase.HBaseConfiguration;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.Put;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.Result;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.Scan;</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.hbase.util.Bytes;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.mapreduce.Job;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.mapreduce.Mapper;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.util.Tool;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.util.ToolRunner;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36">/**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * Example map/reduce job to construct index tables that can be used to quickly find a row based on</span> |
| <span class="source-line-no">038</span><span id="line-38"> * the value of a column. It demonstrates:</span> |
| <span class="source-line-no">039</span><span id="line-39"> * <ul></span> |
| <span class="source-line-no">040</span><span id="line-40"> * <li>Using TableInputFormat and TableMapReduceUtil to use an HTable as input to a map/reduce</span> |
| <span class="source-line-no">041</span><span id="line-41"> * job.</li></span> |
| <span class="source-line-no">042</span><span id="line-42"> * <li>Passing values from main method to children via the configuration.</li></span> |
| <span class="source-line-no">043</span><span id="line-43"> * <li>Using MultiTableOutputFormat to output to multiple tables from a map/reduce job.</li></span> |
| <span class="source-line-no">044</span><span id="line-44"> * <li>A real use case of building a secondary index over a table.</li></span> |
| <span class="source-line-no">045</span><span id="line-45"> * </ul></span> |
| <span class="source-line-no">046</span><span id="line-46"> * <h3>Usage</h3></span> |
| <span class="source-line-no">047</span><span id="line-47"> * <p></span> |
| <span class="source-line-no">048</span><span id="line-48"> * Modify ${HADOOP_HOME}/conf/hadoop-env.sh to include the hbase jar, the zookeeper jar (can be</span> |
| <span class="source-line-no">049</span><span id="line-49"> * found in lib/ directory under HBase root, the examples output directory, and the hbase conf</span> |
| <span class="source-line-no">050</span><span id="line-50"> * directory in HADOOP_CLASSPATH, and then run</span> |
| <span class="source-line-no">051</span><span id="line-51"> * <tt><strong>bin/hadoop org.apache.hadoop.hbase.mapreduce.IndexBuilder</span> |
| <span class="source-line-no">052</span><span id="line-52"> * TABLE_NAME COLUMN_FAMILY ATTR [ATTR ...]</strong></tt></span> |
| <span class="source-line-no">053</span><span id="line-53"> * </p></span> |
| <span class="source-line-no">054</span><span id="line-54"> * <p></span> |
| <span class="source-line-no">055</span><span id="line-55"> * To run with the sample data provided in index-builder-setup.rb, use the arguments</span> |
| <span class="source-line-no">056</span><span id="line-56"> * <strong><tt>people attributes name email phone</tt></strong>.</span> |
| <span class="source-line-no">057</span><span id="line-57"> * </p></span> |
| <span class="source-line-no">058</span><span id="line-58"> * <p></span> |
| <span class="source-line-no">059</span><span id="line-59"> * This code was written against HBase 0.21 trunk.</span> |
| <span class="source-line-no">060</span><span id="line-60"> * </p></span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62">@InterfaceAudience.Private</span> |
| <span class="source-line-no">063</span><span id="line-63">public class IndexBuilder extends Configured implements Tool {</span> |
| <span class="source-line-no">064</span><span id="line-64"> /** the column family containing the indexed row key */</span> |
| <span class="source-line-no">065</span><span id="line-65"> public static final byte[] INDEX_COLUMN = Bytes.toBytes("INDEX");</span> |
| <span class="source-line-no">066</span><span id="line-66"> /** the qualifier containing the indexed row key */</span> |
| <span class="source-line-no">067</span><span id="line-67"> public static final byte[] INDEX_QUALIFIER = Bytes.toBytes("ROW");</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"> * Internal Mapper to be run by Hadoop.</span> |
| <span class="source-line-no">071</span><span id="line-71"> */</span> |
| <span class="source-line-no">072</span><span id="line-72"> public static class Map</span> |
| <span class="source-line-no">073</span><span id="line-73"> extends Mapper<ImmutableBytesWritable, Result, ImmutableBytesWritable, Put> {</span> |
| <span class="source-line-no">074</span><span id="line-74"> private byte[] family;</span> |
| <span class="source-line-no">075</span><span id="line-75"> private TreeMap<byte[], ImmutableBytesWritable> indexes;</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"> protected void map(ImmutableBytesWritable rowKey, Result result, Context context)</span> |
| <span class="source-line-no">079</span><span id="line-79"> throws IOException, InterruptedException {</span> |
| <span class="source-line-no">080</span><span id="line-80"> for (java.util.Map.Entry<byte[], ImmutableBytesWritable> index : indexes.entrySet()) {</span> |
| <span class="source-line-no">081</span><span id="line-81"> byte[] qualifier = index.getKey();</span> |
| <span class="source-line-no">082</span><span id="line-82"> ImmutableBytesWritable tableName = index.getValue();</span> |
| <span class="source-line-no">083</span><span id="line-83"> byte[] value = result.getValue(family, qualifier);</span> |
| <span class="source-line-no">084</span><span id="line-84"> if (value != null) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> // original: row 123 attribute:phone 555-1212</span> |
| <span class="source-line-no">086</span><span id="line-86"> // index: row 555-1212 INDEX:ROW 123</span> |
| <span class="source-line-no">087</span><span id="line-87"> Put put = new Put(value);</span> |
| <span class="source-line-no">088</span><span id="line-88"> put.addColumn(INDEX_COLUMN, INDEX_QUALIFIER, rowKey.get());</span> |
| <span class="source-line-no">089</span><span id="line-89"> context.write(tableName, put);</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</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"> @Override</span> |
| <span class="source-line-no">095</span><span id="line-95"> protected void setup(Context context) throws IOException, InterruptedException {</span> |
| <span class="source-line-no">096</span><span id="line-96"> Configuration configuration = context.getConfiguration();</span> |
| <span class="source-line-no">097</span><span id="line-97"> String tableName = configuration.get("index.tablename");</span> |
| <span class="source-line-no">098</span><span id="line-98"> String[] fields = configuration.getStrings("index.fields");</span> |
| <span class="source-line-no">099</span><span id="line-99"> String familyName = configuration.get("index.familyname");</span> |
| <span class="source-line-no">100</span><span id="line-100"> family = Bytes.toBytes(familyName);</span> |
| <span class="source-line-no">101</span><span id="line-101"> indexes = new TreeMap<>(Bytes.BYTES_COMPARATOR);</span> |
| <span class="source-line-no">102</span><span id="line-102"> for (String field : fields) {</span> |
| <span class="source-line-no">103</span><span id="line-103"> // if the table is "people" and the field to index is "email", then the</span> |
| <span class="source-line-no">104</span><span id="line-104"> // index table will be called "people-email"</span> |
| <span class="source-line-no">105</span><span id="line-105"> indexes.put(Bytes.toBytes(field),</span> |
| <span class="source-line-no">106</span><span id="line-106"> new ImmutableBytesWritable(Bytes.toBytes(tableName + "-" + field)));</span> |
| <span class="source-line-no">107</span><span id="line-107"> }</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> /**</span> |
| <span class="source-line-no">112</span><span id="line-112"> * Job configuration.</span> |
| <span class="source-line-no">113</span><span id="line-113"> */</span> |
| <span class="source-line-no">114</span><span id="line-114"> public static Job configureJob(Configuration conf, String[] args) throws IOException {</span> |
| <span class="source-line-no">115</span><span id="line-115"> String tableName = args[0];</span> |
| <span class="source-line-no">116</span><span id="line-116"> String columnFamily = args[1];</span> |
| <span class="source-line-no">117</span><span id="line-117"> System.out.println("****" + tableName);</span> |
| <span class="source-line-no">118</span><span id="line-118"> conf.set(TableInputFormat.SCAN, TableMapReduceUtil.convertScanToString(new Scan()));</span> |
| <span class="source-line-no">119</span><span id="line-119"> conf.set(TableInputFormat.INPUT_TABLE, tableName);</span> |
| <span class="source-line-no">120</span><span id="line-120"> conf.set("index.tablename", tableName);</span> |
| <span class="source-line-no">121</span><span id="line-121"> conf.set("index.familyname", columnFamily);</span> |
| <span class="source-line-no">122</span><span id="line-122"> String[] fields = new String[args.length - 2];</span> |
| <span class="source-line-no">123</span><span id="line-123"> System.arraycopy(args, 2, fields, 0, fields.length);</span> |
| <span class="source-line-no">124</span><span id="line-124"> conf.setStrings("index.fields", fields);</span> |
| <span class="source-line-no">125</span><span id="line-125"> Job job = new Job(conf, tableName);</span> |
| <span class="source-line-no">126</span><span id="line-126"> job.setJarByClass(IndexBuilder.class);</span> |
| <span class="source-line-no">127</span><span id="line-127"> job.setMapperClass(Map.class);</span> |
| <span class="source-line-no">128</span><span id="line-128"> job.setNumReduceTasks(0);</span> |
| <span class="source-line-no">129</span><span id="line-129"> job.setInputFormatClass(TableInputFormat.class);</span> |
| <span class="source-line-no">130</span><span id="line-130"> job.setOutputFormatClass(MultiTableOutputFormat.class);</span> |
| <span class="source-line-no">131</span><span id="line-131"> return job;</span> |
| <span class="source-line-no">132</span><span id="line-132"> }</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> @Override</span> |
| <span class="source-line-no">135</span><span id="line-135"> public int run(String[] args) throws Exception {</span> |
| <span class="source-line-no">136</span><span id="line-136"> Configuration conf = HBaseConfiguration.create(getConf());</span> |
| <span class="source-line-no">137</span><span id="line-137"> if (args.length < 3) {</span> |
| <span class="source-line-no">138</span><span id="line-138"> System.err.println("Only " + args.length + " arguments supplied, required: 3");</span> |
| <span class="source-line-no">139</span><span id="line-139"> System.err.println("Usage: IndexBuilder <TABLE_NAME> <COLUMN_FAMILY> <ATTR> [<ATTR> ...]");</span> |
| <span class="source-line-no">140</span><span id="line-140"> System.exit(-1);</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</span> |
| <span class="source-line-no">142</span><span id="line-142"> Job job = configureJob(conf, args);</span> |
| <span class="source-line-no">143</span><span id="line-143"> return (job.waitForCompletion(true) ? 0 : 1);</span> |
| <span class="source-line-no">144</span><span id="line-144"> }</span> |
| <span class="source-line-no">145</span><span id="line-145"></span> |
| <span class="source-line-no">146</span><span id="line-146"> public static void main(String[] args) throws Exception {</span> |
| <span class="source-line-no">147</span><span id="line-147"> int result = ToolRunner.run(HBaseConfiguration.create(), new IndexBuilder(), args);</span> |
| <span class="source-line-no">148</span><span id="line-148"> System.exit(result);</span> |
| <span class="source-line-no">149</span><span id="line-149"> }</span> |
| <span class="source-line-no">150</span><span id="line-150">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
