| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.mapreduce;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.TreeMap;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configuration;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configured;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseConfiguration;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.Put;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.Result;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.io.ImmutableBytesWritable;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.mapreduce.Job;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.mapreduce.Mapper;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.util.Tool;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.util.ToolRunner;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Example map/reduce job to construct index tables that can be used to quickly<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * find a row based on the value of a column. It demonstrates:<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <ul><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <li>Using TableInputFormat and TableMapReduceUtil to use an HTable as input<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * to a map/reduce job.</li><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <li>Passing values from main method to children via the configuration.</li><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <li>Using MultiTableOutputFormat to output to multiple tables from a<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * map/reduce job.</li><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <li>A real use case of building a secondary index over a table.</li><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * </ul><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <h3>Usage</h3><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Modify ${HADOOP_HOME}/conf/hadoop-env.sh to include the hbase jar, the<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * zookeeper jar (can be found in lib/ directory under HBase root, the examples output directory,<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * and the hbase conf directory in HADOOP_CLASSPATH, and then run<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <tt><strong>bin/hadoop org.apache.hadoop.hbase.mapreduce.IndexBuilder<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * TABLE_NAME COLUMN_FAMILY ATTR [ATTR ...]</strong></tt><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * </p><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> *<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * <p><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * To run with the sample data provided in index-builder-setup.rb, use the<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * arguments <strong><tt>people attributes name email phone</tt></strong>.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * </p><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> *<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <p><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * This code was written against HBase 0.21 trunk.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * </p><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span>@InterfaceAudience.Private<a name="line.68"></a> |
| <span class="sourceLineNo">069</span>public class IndexBuilder extends Configured implements Tool {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /** the column family containing the indexed row key */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static final byte[] INDEX_COLUMN = Bytes.toBytes("INDEX");<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> /** the qualifier containing the indexed row key */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public static final byte[] INDEX_QUALIFIER = Bytes.toBytes("ROW");<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Internal Mapper to be run by Hadoop.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public static class Map extends<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> Mapper<ImmutableBytesWritable, Result, ImmutableBytesWritable, Put> {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> private byte[] family;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private TreeMap<byte[], ImmutableBytesWritable> indexes;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> @Override<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> protected void map(ImmutableBytesWritable rowKey, Result result, Context context)<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> throws IOException, InterruptedException {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> for(java.util.Map.Entry<byte[], ImmutableBytesWritable> index : indexes.entrySet()) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> byte[] qualifier = index.getKey();<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> ImmutableBytesWritable tableName = index.getValue();<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> byte[] value = result.getValue(family, qualifier);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> if (value != null) {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> // original: row 123 attribute:phone 555-1212<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> // index: row 555-1212 INDEX:ROW 123<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> Put put = new Put(value);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> put.addColumn(INDEX_COLUMN, INDEX_QUALIFIER, rowKey.get());<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> context.write(tableName, put);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> @Override<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> protected void setup(Context context) throws IOException,<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> InterruptedException {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> Configuration configuration = context.getConfiguration();<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> String tableName = configuration.get("index.tablename");<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> String[] fields = configuration.getStrings("index.fields");<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> String familyName = configuration.get("index.familyname");<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> family = Bytes.toBytes(familyName);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> indexes = new TreeMap<>(Bytes.BYTES_COMPARATOR);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> for(String field : fields) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> // if the table is "people" and the field to index is "email", then the<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> // index table will be called "people-email"<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> indexes.put(Bytes.toBytes(field),<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> new ImmutableBytesWritable(Bytes.toBytes(tableName + "-" + field)));<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * Job configuration.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public static Job configureJob(Configuration conf, String [] args) throws IOException {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> String tableName = args[0];<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> String columnFamily = args[1];<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> System.out.println("****" + tableName);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> conf.set(TableInputFormat.SCAN, TableMapReduceUtil.convertScanToString(new Scan()));<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> conf.set(TableInputFormat.INPUT_TABLE, tableName);<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> conf.set("index.tablename", tableName);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> conf.set("index.familyname", columnFamily);<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> String[] fields = new String[args.length - 2];<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> System.arraycopy(args, 2, fields, 0, fields.length);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> conf.setStrings("index.fields", fields);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> Job job = new Job(conf, tableName);<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> job.setJarByClass(IndexBuilder.class);<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> job.setMapperClass(Map.class);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> job.setNumReduceTasks(0);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> job.setInputFormatClass(TableInputFormat.class);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> job.setOutputFormatClass(MultiTableOutputFormat.class);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> return job;<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> public int run(String[] args) throws Exception {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> Configuration conf = HBaseConfiguration.create(getConf());<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> if(args.length < 3) {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> System.err.println("Only " + args.length + " arguments supplied, required: 3");<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> System.err.println("Usage: IndexBuilder <TABLE_NAME> <COLUMN_FAMILY> <ATTR> [<ATTR> ...]");<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> System.exit(-1);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> Job job = configureJob(conf, args);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return (job.waitForCompletion(true) ? 0 : 1);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> public static void main(String[] args) throws Exception {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> int result = ToolRunner.run(HBaseConfiguration.create(), new IndexBuilder(), args);<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> System.exit(result);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span>}<a name="line.156"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
