| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TableSnapshotInputFormatImpl (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: TableSnapshotInputFormatImpl"> |
| <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/TableSnapshotInputFormatImpl.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><a href="#field-summary">Field</a> | </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><a href="#field-detail">Field</a> | </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 TableSnapshotInputFormatImpl" class="title">Class TableSnapshotInputFormatImpl</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.hbase.mapreduce.TableSnapshotInputFormatImpl</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-69">TableSnapshotInputFormatImpl</a></span> |
| <span class="extends-implements">extends <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></span></div> |
| <div class="block">Hadoop MR API-agnostic implementation for mapreduce over table snapshots.</div> |
| </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>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="TableSnapshotInputFormatImpl.InputSplit.html" class="type-name-link" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormatImpl.InputSplit</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Implementation class for InputSplit logic common between mapred and mapreduce.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="TableSnapshotInputFormatImpl.RecordReader.html" class="type-name-link" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormatImpl.RecordReader</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Implementation class for RecordReader logic common between mapred and mapreduce.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private static final float</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_LOCALITY_CUTOFF_MULTIPLIER" class="member-name-link">DEFAULT_LOCALITY_CUTOFF_MULTIPLIER</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOCALITY_CUTOFF_MULTIPLIER" class="member-name-link">LOCALITY_CUTOFF_MULTIPLIER</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">See <a href="#getBestLocations(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.HDFSBlocksDistribution,int)"><code>getBestLocations(Configuration, HDFSBlocksDistribution, int)</code></a></div> |
| </div> |
| <div class="col-first even-row-color"><code>static final org.slf4j.Logger</code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#NUM_SPLITS_PER_REGION" class="member-name-link">NUM_SPLITS_PER_REGION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">For MapReduce jobs running multiple mappers per region, determines number of splits to generate |
| per region.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#RESTORE_DIR_KEY" class="member-name-link">RESTORE_DIR_KEY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION" class="member-name-link">SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether to calculate the Snapshot region location by region location from meta.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION_DEFAULT" class="member-name-link">SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION_DEFAULT</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT" class="member-name-link">SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY" class="member-name-link">SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Whether to calculate the block location for splits.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_ROW_LIMIT_PER_INPUTSPLIT" class="member-name-link">SNAPSHOT_INPUTFORMAT_ROW_LIMIT_PER_INPUTSPLIT</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">In some scenario, scan limited rows on each InputSplit for sampling data extraction</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED" class="member-name-link">SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Whether to enable scan metrics on Scan, default to true</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED_DEFAULT" class="member-name-link">SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED_DEFAULT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE" class="member-name-link">SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The <a href="../client/Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client"><code>Scan.ReadType</code></a> which should be set on the <a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> to read the HBase Snapshot, |
| default STREAM.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="../client/Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE_DEFAULT" class="member-name-link">SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE_DEFAULT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#SNAPSHOT_NAME_KEY" class="member-name-link">SNAPSHOT_NAME_KEY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SPLIT_ALGO" class="member-name-link">SPLIT_ALGO</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">For MapReduce jobs running multiple mappers per region, determines what split algorithm we |
| should be using to find split points for scanners.</div> |
| </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">TableSnapshotInputFormatImpl</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-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>private static <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><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateLocationsForInputSplit(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.TableDescriptor,org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.fs.Path)" class="member-name-link">calculateLocationsForInputSplit</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> htd, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> hri, |
| org.apache.hadoop.fs.Path tableDir)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Compute block locations for snapshot files (which will get the locations for referred hfiles) |
| only when localityEnabled is true.</div> |
| </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="#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 odd-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 even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#extractScanFromConf(org.apache.hadoop.conf.Configuration)" class="member-name-link">extractScanFromConf</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 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 <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><<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getBestLocations(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.HDFSBlocksDistribution)" class="member-name-link">getBestLocations</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a> blockDistribution)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static <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><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getBestLocations(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.HDFSBlocksDistribution,int)" class="member-name-link">getBestLocations</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a> blockDistribution, |
| int numTopsAtMost)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">This computes the locations to be passed from the InputSplit.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionInfosFromManifest(org.apache.hadoop.hbase.snapshot.SnapshotManifest)" class="member-name-link">getRegionInfosFromManifest</a><wbr>(<a href="../snapshot/SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a> manifest)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../snapshot/SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSnapshotManifest(org.apache.hadoop.conf.Configuration,java.lang.String,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem)" class="member-name-link">getSnapshotManifest</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <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 rootDir, |
| org.apache.hadoop.fs.FileSystem fs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSnapshotName(org.apache.hadoop.conf.Configuration)" class="member-name-link">getSnapshotName</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../util/RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSplitAlgo(org.apache.hadoop.conf.Configuration)" class="member-name-link">getSplitAlgo</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 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 <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><<a href="TableSnapshotInputFormatImpl.InputSplit.html" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormatImpl.InputSplit</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSplits(org.apache.hadoop.conf.Configuration)" class="member-name-link">getSplits</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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><<a href="TableSnapshotInputFormatImpl.InputSplit.html" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormatImpl.InputSplit</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSplits(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.snapshot.SnapshotManifest,java.util.List,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)" class="member-name-link">getSplits</a><wbr>(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, |
| <a href="../snapshot/SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a> manifest, |
| <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><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> regionManifests, |
| org.apache.hadoop.fs.Path restoreDir, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 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 <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><<a href="TableSnapshotInputFormatImpl.InputSplit.html" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormatImpl.InputSplit</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSplits(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.snapshot.SnapshotManifest,java.util.List,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm,int)" class="member-name-link">getSplits</a><wbr>(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, |
| <a href="../snapshot/SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a> manifest, |
| <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><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> regionManifests, |
| org.apache.hadoop.fs.Path restoreDir, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="../util/RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a> sa, |
| int numSplits)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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.conf.Configuration,java.lang.String,org.apache.hadoop.fs.Path)" class="member-name-link">setInput</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <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 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 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.conf.Configuration,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.conf.Configuration conf, |
| <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 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> |
| </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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-74">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_NAME_KEY"> |
| <h3>SNAPSHOT_NAME_KEY</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-76">SNAPSHOT_NAME_KEY</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_NAME_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="RESTORE_DIR_KEY"> |
| <h3>RESTORE_DIR_KEY</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-78">RESTORE_DIR_KEY</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.RESTORE_DIR_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOCALITY_CUTOFF_MULTIPLIER"> |
| <h3>LOCALITY_CUTOFF_MULTIPLIER</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-81">LOCALITY_CUTOFF_MULTIPLIER</a></span></div> |
| <div class="block">See <a href="#getBestLocations(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.HDFSBlocksDistribution,int)"><code>getBestLocations(Configuration, HDFSBlocksDistribution, int)</code></a></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.LOCALITY_CUTOFF_MULTIPLIER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_LOCALITY_CUTOFF_MULTIPLIER"> |
| <h3>DEFAULT_LOCALITY_CUTOFF_MULTIPLIER</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">float</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-83">DEFAULT_LOCALITY_CUTOFF_MULTIPLIER</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.DEFAULT_LOCALITY_CUTOFF_MULTIPLIER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SPLIT_ALGO"> |
| <h3>SPLIT_ALGO</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-89">SPLIT_ALGO</a></span></div> |
| <div class="block">For MapReduce jobs running multiple mappers per region, determines what split algorithm we |
| should be using to find split points for scanners.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SPLIT_ALGO">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="NUM_SPLITS_PER_REGION"> |
| <h3>NUM_SPLITS_PER_REGION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-94">NUM_SPLITS_PER_REGION</a></span></div> |
| <div class="block">For MapReduce jobs running multiple mappers per region, determines number of splits to generate |
| per region.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.NUM_SPLITS_PER_REGION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY"> |
| <h3>SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-103">SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY</a></span></div> |
| <div class="block">Whether to calculate the block location for splits. Default to true. If the computing layer |
| runs outside of HBase cluster, the block locality does not master. Setting this value to false |
| could skip the calculation and save some time. Set access modifier to "public" so that these |
| could be accessed by test classes of both org.apache.hadoop.hbase.mapred and |
| org.apache.hadoop.hbase.mapreduce.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT"> |
| <h3>SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-105">SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION"> |
| <h3>SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-111">SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION</a></span></div> |
| <div class="block">Whether to calculate the Snapshot region location by region location from meta. It is much |
| faster than computing block locations for splits.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION_DEFAULT"> |
| <h3>SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-114">SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION_DEFAULT</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_INPUTFORMAT_LOCALITY_BY_REGION_LOCATION_DEFAULT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_ROW_LIMIT_PER_INPUTSPLIT"> |
| <h3>SNAPSHOT_INPUTFORMAT_ROW_LIMIT_PER_INPUTSPLIT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-119">SNAPSHOT_INPUTFORMAT_ROW_LIMIT_PER_INPUTSPLIT</a></span></div> |
| <div class="block">In some scenario, scan limited rows on each InputSplit for sampling data extraction</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_INPUTFORMAT_ROW_LIMIT_PER_INPUTSPLIT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED"> |
| <h3>SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-125">SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED</a></span></div> |
| <div class="block">Whether to enable scan metrics on Scan, default to true</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED_DEFAULT"> |
| <h3>SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-128">SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED_DEFAULT</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_INPUTFORMAT_SCAN_METRICS_ENABLED_DEFAULT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE"> |
| <h3>SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-134">SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE</a></span></div> |
| <div class="block">The <a href="../client/Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client"><code>Scan.ReadType</code></a> which should be set on the <a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> to read the HBase Snapshot, |
| default STREAM.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl.SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE_DEFAULT"> |
| <h3>SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="../client/Scan.ReadType.html" title="enum class in org.apache.hadoop.hbase.client">Scan.ReadType</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-136">SNAPSHOT_INPUTFORMAT_SCANNER_READTYPE_DEFAULT</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= 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>TableSnapshotInputFormatImpl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-70">TableSnapshotInputFormatImpl</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="getSplits(org.apache.hadoop.conf.Configuration)"> |
| <h3>getSplits</h3> |
| <div class="member-signature"><span class="modifiers">public static</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><<a href="TableSnapshotInputFormatImpl.InputSplit.html" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormatImpl.InputSplit</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-315">getSplits</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</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>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="getSplitAlgo(org.apache.hadoop.conf.Configuration)"> |
| <h3>getSplitAlgo</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../util/RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-337">getSplitAlgo</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</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>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="getRegionInfosFromManifest(org.apache.hadoop.hbase.snapshot.SnapshotManifest)"> |
| <h3>getRegionInfosFromManifest</h3> |
| <div class="member-signature"><span class="modifiers">public static</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><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-351">getRegionInfosFromManifest</a></span><wbr><span class="parameters">(<a href="../snapshot/SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a> manifest)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSnapshotManifest(org.apache.hadoop.conf.Configuration,java.lang.String,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem)"> |
| <h3>getSnapshotManifest</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../snapshot/SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-369">getSnapshotManifest</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <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 rootDir, |
| org.apache.hadoop.fs.FileSystem fs)</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>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="extractScanFromConf(org.apache.hadoop.conf.Configuration)"> |
| <h3>extractScanFromConf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-376">extractScanFromConf</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</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>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.hbase.client.Scan,org.apache.hadoop.hbase.snapshot.SnapshotManifest,java.util.List,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)"> |
| <h3>getSplits</h3> |
| <div class="member-signature"><span class="modifiers">public static</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><<a href="TableSnapshotInputFormatImpl.InputSplit.html" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormatImpl.InputSplit</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-402">getSplits</a></span><wbr><span class="parameters">(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, |
| <a href="../snapshot/SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a> manifest, |
| <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><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> regionManifests, |
| org.apache.hadoop.fs.Path restoreDir, |
| org.apache.hadoop.conf.Configuration conf)</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>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.hbase.client.Scan,org.apache.hadoop.hbase.snapshot.SnapshotManifest,java.util.List,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm,int)"> |
| <h3>getSplits</h3> |
| <div class="member-signature"><span class="modifiers">public static</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><<a href="TableSnapshotInputFormatImpl.InputSplit.html" title="class in org.apache.hadoop.hbase.mapreduce">TableSnapshotInputFormatImpl.InputSplit</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-407">getSplits</a></span><wbr><span class="parameters">(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan, |
| <a href="../snapshot/SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a> manifest, |
| <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><<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> regionManifests, |
| org.apache.hadoop.fs.Path restoreDir, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="../util/RegionSplitter.SplitAlgorithm.html" title="interface in org.apache.hadoop.hbase.util">RegionSplitter.SplitAlgorithm</a> sa, |
| int numSplits)</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>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="calculateLocationsForInputSplit(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.TableDescriptor,org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.fs.Path)"> |
| <h3>calculateLocationsForInputSplit</h3> |
| <div class="member-signature"><span class="modifiers">private static</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><<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>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-502">calculateLocationsForInputSplit</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a> htd, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> hri, |
| org.apache.hadoop.fs.Path tableDir)</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">Compute block locations for snapshot files (which will get the locations for referred hfiles) |
| only when localityEnabled is true.</div> |
| <dl class="notes"> |
| <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="getBestLocations(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.HDFSBlocksDistribution,int)"> |
| <h3>getBestLocations</h3> |
| <div class="member-signature"><span class="modifiers">private static</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><<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>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-519">getBestLocations</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a> blockDistribution, |
| int numTopsAtMost)</span></div> |
| <div class="block">This computes the locations to be passed from the InputSplit. MR/Yarn schedulers does not take |
| weights into account, thus will treat every location passed from the input split as equal. We |
| do not want to blindly pass all the locations, since we are creating one split per region, and |
| the region's blocks are all distributed throughout the cluster unless favorite node assignment |
| is used. On the expected stable case, only one location will contain most of the blocks as |
| local. On the other hand, in favored node assignment, 3 nodes will contain highly local blocks. |
| Here we are doing a simple heuristic, where we will pass all hosts which have at least 80% |
| (hbase.tablesnapshotinputformat.locality.cutoff.multiplier) as much block locality as the top |
| host with the best locality. Return at most numTopsAtMost locations if there are more than |
| that.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBestLocations(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.HDFSBlocksDistribution)"> |
| <h3>getBestLocations</h3> |
| <div class="member-signature"><span class="modifiers">public static</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><<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>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-559">getBestLocations</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a> blockDistribution)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSnapshotName(org.apache.hadoop.conf.Configuration)"> |
| <h3>getSnapshotName</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormatImpl.html#line-565">getSnapshotName</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setInput(org.apache.hadoop.conf.Configuration,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/TableSnapshotInputFormatImpl.html#line-583">setInput</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <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>conf</code> - the job to configuration</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.conf.Configuration,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/TableSnapshotInputFormatImpl.html#line-600">setInput</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <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>conf</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>numSplitsPerRegion</code> - how many input splits to generate per one region</dd> |
| <dd><code>splitAlgo</code> - SplitAlgorithm to be used when generating InputSplits</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/TableSnapshotInputFormatImpl.html#line-629">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> |
