| <!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: TableSnapshotInputFormat"> |
| <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.DataInput;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.DataOutput;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.List;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.RegionInfo;</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.client.TableDescriptor;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.io.ImmutableBytesWritable;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.util.RegionSplitter;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.mapred.InputFormat;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.mapred.InputSplit;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.mapred.JobConf;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.mapred.RecordReader;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.mapred.Reporter;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39">/**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * TableSnapshotInputFormat allows a MapReduce job to run over a table snapshot. Further</span> |
| <span class="source-line-no">041</span><span id="line-41"> * documentation available on {@link org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat}.</span> |
| <span class="source-line-no">042</span><span id="line-42"> * @see org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat</span> |
| <span class="source-line-no">043</span><span id="line-43"> */</span> |
| <span class="source-line-no">044</span><span id="line-44">@InterfaceAudience.Public</span> |
| <span class="source-line-no">045</span><span id="line-45">public class TableSnapshotInputFormat implements InputFormat<ImmutableBytesWritable, Result> {</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> public static class TableSnapshotRegionSplit implements InputSplit {</span> |
| <span class="source-line-no">048</span><span id="line-48"> private TableSnapshotInputFormatImpl.InputSplit delegate;</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> // constructor for mapreduce framework / Writable</span> |
| <span class="source-line-no">051</span><span id="line-51"> public TableSnapshotRegionSplit() {</span> |
| <span class="source-line-no">052</span><span id="line-52"> this.delegate = new TableSnapshotInputFormatImpl.InputSplit();</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"> public TableSnapshotRegionSplit(TableSnapshotInputFormatImpl.InputSplit delegate) {</span> |
| <span class="source-line-no">056</span><span id="line-56"> this.delegate = delegate;</span> |
| <span class="source-line-no">057</span><span id="line-57"> }</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> public TableSnapshotRegionSplit(TableDescriptor htd, RegionInfo regionInfo,</span> |
| <span class="source-line-no">060</span><span id="line-60"> List<String> locations, Scan scan, Path restoreDir) {</span> |
| <span class="source-line-no">061</span><span id="line-61"> this.delegate =</span> |
| <span class="source-line-no">062</span><span id="line-62"> new TableSnapshotInputFormatImpl.InputSplit(htd, regionInfo, locations, scan, restoreDir);</span> |
| <span class="source-line-no">063</span><span id="line-63"> }</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> @Override</span> |
| <span class="source-line-no">066</span><span id="line-66"> public long getLength() throws IOException {</span> |
| <span class="source-line-no">067</span><span id="line-67"> return delegate.getLength();</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"> @Override</span> |
| <span class="source-line-no">071</span><span id="line-71"> public String[] getLocations() throws IOException {</span> |
| <span class="source-line-no">072</span><span id="line-72"> return delegate.getLocations();</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 void write(DataOutput out) throws IOException {</span> |
| <span class="source-line-no">077</span><span id="line-77"> delegate.write(out);</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> @Override</span> |
| <span class="source-line-no">081</span><span id="line-81"> public void readFields(DataInput in) throws IOException {</span> |
| <span class="source-line-no">082</span><span id="line-82"> delegate.readFields(in);</span> |
| <span class="source-line-no">083</span><span id="line-83"> }</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"> static class TableSnapshotRecordReader implements RecordReader<ImmutableBytesWritable, Result> {</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> private TableSnapshotInputFormatImpl.RecordReader delegate;</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> public TableSnapshotRecordReader(TableSnapshotRegionSplit split, JobConf job)</span> |
| <span class="source-line-no">091</span><span id="line-91"> throws IOException {</span> |
| <span class="source-line-no">092</span><span id="line-92"> delegate = new TableSnapshotInputFormatImpl.RecordReader();</span> |
| <span class="source-line-no">093</span><span id="line-93"> delegate.initialize(split.delegate, job);</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> @Override</span> |
| <span class="source-line-no">097</span><span id="line-97"> public boolean next(ImmutableBytesWritable key, Result value) throws IOException {</span> |
| <span class="source-line-no">098</span><span id="line-98"> if (!delegate.nextKeyValue()) {</span> |
| <span class="source-line-no">099</span><span id="line-99"> return false;</span> |
| <span class="source-line-no">100</span><span id="line-100"> }</span> |
| <span class="source-line-no">101</span><span id="line-101"> ImmutableBytesWritable currentKey = delegate.getCurrentKey();</span> |
| <span class="source-line-no">102</span><span id="line-102"> key.set(currentKey.get(), currentKey.getOffset(), currentKey.getLength());</span> |
| <span class="source-line-no">103</span><span id="line-103"> value.copyFrom(delegate.getCurrentValue());</span> |
| <span class="source-line-no">104</span><span id="line-104"> return true;</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> @Override</span> |
| <span class="source-line-no">108</span><span id="line-108"> public ImmutableBytesWritable createKey() {</span> |
| <span class="source-line-no">109</span><span id="line-109"> return new ImmutableBytesWritable();</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"> @Override</span> |
| <span class="source-line-no">113</span><span id="line-113"> public Result createValue() {</span> |
| <span class="source-line-no">114</span><span id="line-114"> return new Result();</span> |
| <span class="source-line-no">115</span><span id="line-115"> }</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> @Override</span> |
| <span class="source-line-no">118</span><span id="line-118"> public long getPos() throws IOException {</span> |
| <span class="source-line-no">119</span><span id="line-119"> return delegate.getPos();</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"></span> |
| <span class="source-line-no">122</span><span id="line-122"> @Override</span> |
| <span class="source-line-no">123</span><span id="line-123"> public void close() throws IOException {</span> |
| <span class="source-line-no">124</span><span id="line-124"> delegate.close();</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> @Override</span> |
| <span class="source-line-no">128</span><span id="line-128"> public float getProgress() throws IOException {</span> |
| <span class="source-line-no">129</span><span id="line-129"> return delegate.getProgress();</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> @Override</span> |
| <span class="source-line-no">134</span><span id="line-134"> public InputSplit[] getSplits(JobConf job, int numSplits) throws IOException {</span> |
| <span class="source-line-no">135</span><span id="line-135"> List<TableSnapshotInputFormatImpl.InputSplit> splits =</span> |
| <span class="source-line-no">136</span><span id="line-136"> TableSnapshotInputFormatImpl.getSplits(job);</span> |
| <span class="source-line-no">137</span><span id="line-137"> InputSplit[] results = new InputSplit[splits.size()];</span> |
| <span class="source-line-no">138</span><span id="line-138"> for (int i = 0; i < splits.size(); i++) {</span> |
| <span class="source-line-no">139</span><span id="line-139"> results[i] = new TableSnapshotRegionSplit(splits.get(i));</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</span> |
| <span class="source-line-no">141</span><span id="line-141"> return results;</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143"></span> |
| <span class="source-line-no">144</span><span id="line-144"> @Override</span> |
| <span class="source-line-no">145</span><span id="line-145"> public RecordReader<ImmutableBytesWritable, Result> getRecordReader(InputSplit split, JobConf job,</span> |
| <span class="source-line-no">146</span><span id="line-146"> Reporter reporter) throws IOException {</span> |
| <span class="source-line-no">147</span><span id="line-147"> return new TableSnapshotRecordReader((TableSnapshotRegionSplit) split, job);</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</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> |
| <span class="source-line-no">151</span><span id="line-151"> * Configures the job to use TableSnapshotInputFormat to read from a snapshot.</span> |
| <span class="source-line-no">152</span><span id="line-152"> * @param job the job to configure</span> |
| <span class="source-line-no">153</span><span id="line-153"> * @param snapshotName the name of the snapshot to read from</span> |
| <span class="source-line-no">154</span><span id="line-154"> * @param restoreDir a temporary directory to restore the snapshot into. Current user should</span> |
| <span class="source-line-no">155</span><span id="line-155"> * have write permissions to this directory, and this should not be a</span> |
| <span class="source-line-no">156</span><span id="line-156"> * subdirectory of rootdir. After the job is finished, restoreDir can be</span> |
| <span class="source-line-no">157</span><span id="line-157"> * deleted.</span> |
| <span class="source-line-no">158</span><span id="line-158"> * @throws IOException if an error occurs</span> |
| <span class="source-line-no">159</span><span id="line-159"> */</span> |
| <span class="source-line-no">160</span><span id="line-160"> public static void setInput(JobConf job, String snapshotName, Path restoreDir)</span> |
| <span class="source-line-no">161</span><span id="line-161"> throws IOException {</span> |
| <span class="source-line-no">162</span><span id="line-162"> TableSnapshotInputFormatImpl.setInput(job, snapshotName, restoreDir);</span> |
| <span class="source-line-no">163</span><span id="line-163"> }</span> |
| <span class="source-line-no">164</span><span id="line-164"></span> |
| <span class="source-line-no">165</span><span id="line-165"> /**</span> |
| <span class="source-line-no">166</span><span id="line-166"> * Configures the job to use TableSnapshotInputFormat to read from a snapshot.</span> |
| <span class="source-line-no">167</span><span id="line-167"> * @param job the job to configure</span> |
| <span class="source-line-no">168</span><span id="line-168"> * @param snapshotName the name of the snapshot to read from</span> |
| <span class="source-line-no">169</span><span id="line-169"> * @param restoreDir a temporary directory to restore the snapshot into. Current user</span> |
| <span class="source-line-no">170</span><span id="line-170"> * should have write permissions to this directory, and this should not</span> |
| <span class="source-line-no">171</span><span id="line-171"> * be a subdirectory of rootdir. After the job is finished, restoreDir</span> |
| <span class="source-line-no">172</span><span id="line-172"> * can be deleted.</span> |
| <span class="source-line-no">173</span><span id="line-173"> * @param splitAlgo split algorithm to generate splits from region</span> |
| <span class="source-line-no">174</span><span id="line-174"> * @param numSplitsPerRegion how many input splits to generate per one region</span> |
| <span class="source-line-no">175</span><span id="line-175"> * @throws IOException if an error occurs</span> |
| <span class="source-line-no">176</span><span id="line-176"> */</span> |
| <span class="source-line-no">177</span><span id="line-177"> public static void setInput(JobConf job, String snapshotName, Path restoreDir,</span> |
| <span class="source-line-no">178</span><span id="line-178"> RegionSplitter.SplitAlgorithm splitAlgo, int numSplitsPerRegion) throws IOException {</span> |
| <span class="source-line-no">179</span><span id="line-179"> TableSnapshotInputFormatImpl.setInput(job, snapshotName, restoreDir, splitAlgo,</span> |
| <span class="source-line-no">180</span><span id="line-180"> numSplitsPerRegion);</span> |
| <span class="source-line-no">181</span><span id="line-181"> }</span> |
| <span class="source-line-no">182</span><span id="line-182">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
