| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TableSnapshotInputFormat (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.mapreduce, class: TableSnapshotInputFormat"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/TableSnapshotInputFormat.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.mapreduce</a></div> |
| <h1 title="Class TableSnapshotInputFormat" class="title">Class TableSnapshotInputFormat</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.mapreduce.InputFormat<<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>> |
| <div class="inheritance">org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormat</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="MultiTableSnapshotInputFormat.html" title="class in org.apache.hadoop.hbase.mapreduce">MultiTableSnapshotInputFormat</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Public |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html#line-82">TableSnapshotInputFormat</a></span> |
| <span class="extends-implements">extends org.apache.hadoop.mapreduce.InputFormat<<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></span></div> |
| <div class="block">TableSnapshotInputFormat allows a MapReduce job to run over a table snapshot. The job bypasses |
| HBase servers, and directly accesses the underlying files (hfile, recovered edits, wals, etc) |
| directly to provide maximum performance. The snapshot is not required to be restored to the live |
| cluster or cloned. This also allows to run the mapreduce job from an online or offline hbase |
| cluster. The snapshot files can be exported by using the |
| <a href="../snapshot/ExportSnapshot.html" title="class in org.apache.hadoop.hbase.snapshot"><code>ExportSnapshot</code></a> tool, to a pure-hdfs cluster, and this |
| InputFormat can be used to run the mapreduce job directly over the snapshot files. The snapshot |
| should not be deleted while there are jobs reading from snapshot files. |
| <p> |
| Usage is similar to TableInputFormat, and |
| <a href="TableMapReduceUtil.html#initTableSnapshotMapperJob(java.lang.String,org.apache.hadoop.hbase.client.Scan,java.lang.Class,java.lang.Class,java.lang.Class,org.apache.hadoop.mapreduce.Job,boolean,org.apache.hadoop.fs.Path)"><code>TableMapReduceUtil.initTableSnapshotMapperJob(String, Scan, Class, Class, Class, Job, boolean, Path)</code></a> |
| can be used to configure the job. |
| |
| <pre> |
| { |
| @code |
| Job job = new Job(conf); |
| Scan scan = new Scan(); |
| TableMapReduceUtil.initTableSnapshotMapperJob(snapshotName, scan, MyTableMapper.class, |
| MyMapKeyOutput.class, MyMapOutputValueWritable.class, job, true); |
| } |
| </pre> |
| <p> |
| Internally, this input format restores the snapshot into the given tmp directory. By default, and |
| similar to <a href="TableInputFormat.html" title="class in org.apache.hadoop.hbase.mapreduce"><code>TableInputFormat</code></a> an InputSplit is created per region, but optionally you can |
| run N mapper tasks per every region, in which case the region key range will be split to N |
| sub-ranges and an InputSplit will be created per sub-range. The region is opened for reading from |
| each RecordReader. An internal RegionScanner is used to execute the |
| <a href="../CellScanner.html" title="interface in org.apache.hadoop.hbase"><code>CellScanner</code></a> obtained from the user. |
| <p> |
| HBase owns all the data and snapshot files on the filesystem. Only the 'hbase' user can read from |
| snapshot files and data files. To read from snapshot files directly from the file system, the |
| user who is running the MR job must have sufficient permissions to access snapshot and reference |
| files. This means that to run mapreduce over snapshot files, the MR job has to be run as the |
| HBase user or the user must have group or other privileges in the filesystem (See HBASE-8369). |
| Note that, given other users access to read from snapshot/data files will completely circumvent |
| the access control enforced by HBase.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../client/TableSnapshotScanner.html" title="class in org.apache.hadoop.hbase.client"><code>TableSnapshotScanner</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>(package private) static class </code></div> |
| <div class="col-second even-row-color"><code><a href="TableSnapshotInputFormat.TableSnapshotRegionRecordReader.html" class="type-name-link" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormat.TableSnapshotRegionRecordReader</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="TableSnapshotInputFormat.TableSnapshotRegionSplit.html" class="type-name-link" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormat.TableSnapshotRegionSplit</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">TableSnapshotInputFormat</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#cleanRestoreDir(org.apache.hadoop.mapreduce.Job,java.lang.String)" class="member-name-link">cleanRestoreDir</a><wbr>(org.apache.hadoop.mapreduce.Job job, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">clean restore directory after snapshot scan job</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.mapreduce.RecordReader<<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createRecordReader(org.apache.hadoop.mapreduce.InputSplit,org.apache.hadoop.mapreduce.TaskAttemptContext)" class="member-name-link">createRecordReader</a><wbr>(org.apache.hadoop.mapreduce.InputSplit split, |
| org.apache.hadoop.mapreduce.TaskAttemptContext context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.mapreduce.InputSplit></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSplits(org.apache.hadoop.mapreduce.JobContext)" class="member-name-link">getSplits</a><wbr>(org.apache.hadoop.mapreduce.JobContext job)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setInput(org.apache.hadoop.mapreduce.Job,java.lang.String,org.apache.hadoop.fs.Path)" class="member-name-link">setInput</a><wbr>(org.apache.hadoop.mapreduce.Job job, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName, |
| org.apache.hadoop.fs.Path restoreDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Configures the job to use TableSnapshotInputFormat to read from a snapshot.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setInput(org.apache.hadoop.mapreduce.Job,java.lang.String,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm,int)" class="member-name-link">setInput</a><wbr>(org.apache.hadoop.mapreduce.Job job, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName, |
| org.apache.hadoop.fs.Path restoreDir, |
| <a href="../util/RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a> splitAlgo, |
| int numSplitsPerRegion)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Configures the job to use TableSnapshotInputFormat to read from a snapshot.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>TableSnapshotInputFormat</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html#line-83">TableSnapshotInputFormat</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createRecordReader(org.apache.hadoop.mapreduce.InputSplit,org.apache.hadoop.mapreduce.TaskAttemptContext)"> |
| <h3>createRecordReader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.mapreduce.RecordReader<<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html#line-179">createRecordReader</a></span><wbr><span class="parameters">(org.apache.hadoop.mapreduce.InputSplit split, |
| org.apache.hadoop.mapreduce.TaskAttemptContext context)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>createRecordReader</code> in class <code>org.apache.hadoop.mapreduce.InputFormat<<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSplits(org.apache.hadoop.mapreduce.JobContext)"> |
| <h3>getSplits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.mapreduce.InputSplit></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html#line-185">getSplits</a></span><wbr><span class="parameters">(org.apache.hadoop.mapreduce.JobContext job)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getSplits</code> in class <code>org.apache.hadoop.mapreduce.InputFormat<<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setInput(org.apache.hadoop.mapreduce.Job,java.lang.String,org.apache.hadoop.fs.Path)"> |
| <h3>setInput</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html#line-205">setInput</a></span><wbr><span class="parameters">(org.apache.hadoop.mapreduce.Job job, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName, |
| org.apache.hadoop.fs.Path restoreDir)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Configures the job to use TableSnapshotInputFormat to read from a snapshot.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>job</code> - the job to configure</dd> |
| <dd><code>snapshotName</code> - the name of the snapshot to read from</dd> |
| <dd><code>restoreDir</code> - a temporary directory to restore the snapshot into. Current user should |
| have write permissions to this directory, and this should not be a |
| subdirectory of rootdir. After the job is finished, restoreDir can be |
| deleted.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setInput(org.apache.hadoop.mapreduce.Job,java.lang.String,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm,int)"> |
| <h3>setInput</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html#line-221">setInput</a></span><wbr><span class="parameters">(org.apache.hadoop.mapreduce.Job job, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName, |
| org.apache.hadoop.fs.Path restoreDir, |
| <a href="../util/RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a> splitAlgo, |
| int numSplitsPerRegion)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Configures the job to use TableSnapshotInputFormat to read from a snapshot.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>job</code> - the job to configure</dd> |
| <dd><code>snapshotName</code> - the name of the snapshot to read from</dd> |
| <dd><code>restoreDir</code> - a temporary directory to restore the snapshot into. Current user |
| should have write permissions to this directory, and this should not |
| be a subdirectory of rootdir. After the job is finished, restoreDir |
| can be deleted.</dd> |
| <dd><code>splitAlgo</code> - split algorithm to generate splits from region</dd> |
| <dd><code>numSplitsPerRegion</code> - how many input splits to generate per one region</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanRestoreDir(org.apache.hadoop.mapreduce.Job,java.lang.String)"> |
| <h3>cleanRestoreDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html#line-233">cleanRestoreDir</a></span><wbr><span class="parameters">(org.apache.hadoop.mapreduce.Job job, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> snapshotName)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">clean restore directory after snapshot scan job</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>job</code> - the snapshot scan job</dd> |
| <dd><code>snapshotName</code> - the name of the snapshot to read from</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an error occurs</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
