blob: 68394980c33aba888ee6b630c008bd7c96bae726 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TableMapReduceUtil (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TableMapReduceUtil (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9,"i28":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TableMapReduceUtil.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableOutputCommitter.html" title="class in org.apache.hadoop.hbase.mapreduce"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html" target="_top">Frames</a></li>
<li><a href="TableMapReduceUtil.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.mapreduce</div>
<h2 title="Class TableMapReduceUtil" class="title">Class TableMapReduceUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.Public
public class <a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.70">TableMapReduceUtil</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Utility for <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce"><code>TableMapper</code></a> and <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce"><code>TableReducer</code></a></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#TABLE_INPUT_CLASS_KEY">TABLE_INPUT_CLASS_KEY</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#TableMapReduceUtil--">TableMapReduceUtil</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#addDependencyJars-org.apache.hadoop.mapreduce.Job-">addDependencyJars</a></span>(org.apache.hadoop.mapreduce.Job&nbsp;job)</code>
<div class="block">Add the HBase dependency jars as well as jars for any of the configured job classes to the job
configuration, so that JobClient will ship them to the cluster and add them to the
DistributedCache.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#addHBaseDependencyJars-org.apache.hadoop.conf.Configuration-">addHBaseDependencyJars</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Add HBase and its dependencies (only) to the job configuration.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#buildDependencyClasspath-org.apache.hadoop.conf.Configuration-">buildDependencyClasspath</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Returns a classpath string built from the content of the "tmpjars" value in <code>conf</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#convertScanToString-org.apache.hadoop.hbase.client.Scan-">convertScanToString</a></span>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan)</code>
<div class="block">Writes the given scan into a Base64 encoded string.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#convertStringToScan-java.lang.String-">convertStringToScan</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;base64)</code>
<div class="block">Converts the given Base64 string back into a Scan instance.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initCredentials-org.apache.hadoop.mapreduce.Job-">initCredentials</a></span>(org.apache.hadoop.mapreduce.Job&nbsp;job)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initCredentialsForCluster-org.apache.hadoop.mapreduce.Job-org.apache.hadoop.conf.Configuration-">initCredentialsForCluster</a></span>(org.apache.hadoop.mapreduce.Job&nbsp;job,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Obtain an authentication token, for the specified cluster, on behalf of the current user and
add it to the credentials for the given map reduce job.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initMultiTableSnapshotMapperJob-java.util.Map-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-org.apache.hadoop.fs.Path-">initMultiTableSnapshotMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&gt;&gt;&nbsp;snapshotScans,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
org.apache.hadoop.fs.Path&nbsp;tmpRestoreDir)</code>
<div class="block">Sets up the job for reading from one or more table snapshots, with one or more scans per
snapshot.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-byte:A-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-">initTableMapperJob</a></span>(byte[]&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job)</code>
<div class="block">Use this before submitting a TableMap job.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-byte:A-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-">initTableMapperJob</a></span>(byte[]&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars)</code>
<div class="block">Use this before submitting a TableMap job.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-byte:A-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-java.lang.Class-">initTableMapperJob</a></span>(byte[]&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends org.apache.hadoop.mapreduce.InputFormat&gt;&nbsp;inputFormatClass)</code>
<div class="block">Use this before submitting a TableMap job.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-java.util.List-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-">initTableMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&gt;&nbsp;scans,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job)</code>
<div class="block">Use this before submitting a Multi TableMap job.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-java.util.List-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-">initTableMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&gt;&nbsp;scans,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars)</code>
<div class="block">Use this before submitting a Multi TableMap job.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-java.util.List-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-boolean-">initTableMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&gt;&nbsp;scans,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
boolean&nbsp;initCredentials)</code>
<div class="block">Use this before submitting a Multi TableMap job.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-java.lang.String-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-">initTableMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job)</code>
<div class="block">Use this before submitting a TableMap job.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-java.lang.String-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-">initTableMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars)</code>
<div class="block">Use this before submitting a TableMap job.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-java.lang.String-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-boolean-java.lang.Class-">initTableMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
boolean&nbsp;initCredentials,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends org.apache.hadoop.mapreduce.InputFormat&gt;&nbsp;inputFormatClass)</code>
<div class="block">Use this before submitting a TableMap job.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-java.lang.String-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-java.lang.Class-">initTableMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends org.apache.hadoop.mapreduce.InputFormat&gt;&nbsp;inputFormatClass)</code>
<div class="block">Use this before submitting a TableMap job.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableMapperJob-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-">initTableMapperJob</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job)</code>
<div class="block">Use this before submitting a TableMap job.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableReducerJob-java.lang.String-java.lang.Class-org.apache.hadoop.mapreduce.Job-">initTableReducerJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce">TableReducer</a>&gt;&nbsp;reducer,
org.apache.hadoop.mapreduce.Job&nbsp;job)</code>
<div class="block">Use this before submitting a TableReduce job.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableReducerJob-java.lang.String-java.lang.Class-org.apache.hadoop.mapreduce.Job-java.lang.Class-">initTableReducerJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce">TableReducer</a>&gt;&nbsp;reducer,
org.apache.hadoop.mapreduce.Job&nbsp;job,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;partitioner)</code>
<div class="block">Use this before submitting a TableReduce job.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableReducerJob-java.lang.String-java.lang.Class-org.apache.hadoop.mapreduce.Job-java.lang.Class-java.lang.String-java.lang.String-java.lang.String-">initTableReducerJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce">TableReducer</a>&gt;&nbsp;reducer,
org.apache.hadoop.mapreduce.Job&nbsp;job,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;partitioner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;quorumAddress,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serverClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serverImpl)</code>
<div class="block">Use this before submitting a TableReduce job.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#initTableReducerJob-java.lang.String-java.lang.Class-org.apache.hadoop.mapreduce.Job-java.lang.Class-java.lang.String-java.lang.String-java.lang.String-boolean-">initTableReducerJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce">TableReducer</a>&gt;&nbsp;reducer,
org.apache.hadoop.mapreduce.Job&nbsp;job,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;partitioner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;quorumAddress,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serverClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serverImpl,
boolean&nbsp;addDependencyJars)</code>
<div class="block">Use this before submitting a TableReduce job.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/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-">initTableSnapshotMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;snapshotName,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
org.apache.hadoop.fs.Path&nbsp;tmpRestoreDir)</code>
<div class="block">Sets up the job for reading from a table snapshot.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/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-org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm-int-">initTableSnapshotMapperJob</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;snapshotName,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
org.apache.hadoop.fs.Path&nbsp;tmpRestoreDir,
org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm&nbsp;splitAlgo,
int&nbsp;numSplitsPerRegion)</code>
<div class="block">Sets up the job for reading from a table snapshot.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#limitNumReduceTasks-java.lang.String-org.apache.hadoop.mapreduce.Job-">limitNumReduceTasks</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
org.apache.hadoop.mapreduce.Job&nbsp;job)</code>
<div class="block">Ensures that the given number of reduce tasks for the given job configuration does not exceed
the number of regions for the given table.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#resetCacheConfig-org.apache.hadoop.conf.Configuration-">resetCacheConfig</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Enable a basic on-heap cache for these jobs.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#setNumReduceTasks-java.lang.String-org.apache.hadoop.mapreduce.Job-">setNumReduceTasks</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
org.apache.hadoop.mapreduce.Job&nbsp;job)</code>
<div class="block">Sets the number of reduce tasks for the given job configuration to the number of regions the
given table has.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#setScannerCaching-org.apache.hadoop.mapreduce.Job-int-">setScannerCaching</a></span>(org.apache.hadoop.mapreduce.Job&nbsp;job,
int&nbsp;batchSize)</code>
<div class="block">Sets the number of rows to return and cache with each scanner iteration.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TABLE_INPUT_CLASS_KEY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TABLE_INPUT_CLASS_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.72">TABLE_INPUT_CLASS_KEY</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil.TABLE_INPUT_CLASS_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TableMapReduceUtil--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TableMapReduceUtil</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.70">TableMapReduceUtil</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="initTableMapperJob-java.lang.String-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.85">initTableMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The table name to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.102">initTableMapperJob</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The table name to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-byte:A-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.120">initTableMapperJob</a>(byte[]&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - Binary representation of the table name to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-java.lang.String-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.140">initTableMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends org.apache.hadoop.mapreduce.InputFormat&gt;&nbsp;inputFormatClass)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The table name to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-java.lang.String-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-boolean-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.163">initTableMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
boolean&nbsp;initCredentials,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends org.apache.hadoop.mapreduce.InputFormat&gt;&nbsp;inputFormatClass)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The table name to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dd><code>initCredentials</code> - whether to initialize hbase auth credentials for the job</dd>
<dd><code>inputFormatClass</code> - the input format</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-byte:A-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.203">initTableMapperJob</a>(byte[]&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends org.apache.hadoop.mapreduce.InputFormat&gt;&nbsp;inputFormatClass)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - Binary representation of the table name to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dd><code>inputFormatClass</code> - The class of the input format</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-byte:A-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.224">initTableMapperJob</a>(byte[]&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - Binary representation of the table name to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-java.lang.String-org.apache.hadoop.hbase.client.Scan-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.253">initTableMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The table name to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="resetCacheConfig-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetCacheConfig</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.266">resetCacheConfig</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Enable a basic on-heap cache for these jobs. Any BlockCache implementation based on direct
memory will likely cause the map tasks to OOM when opening the region. This is done here
instead of in TableSnapshotRegionRecordReader in case an advanced user wants to override this
behavior in their job.</div>
</li>
</ul>
<a name="initMultiTableSnapshotMapperJob-java.util.Map-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-org.apache.hadoop.fs.Path-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initMultiTableSnapshotMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.284">initMultiTableSnapshotMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&gt;&gt;&nbsp;snapshotScans,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
org.apache.hadoop.fs.Path&nbsp;tmpRestoreDir)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Sets up the job for reading from one or more table snapshots, with one or more scans per
snapshot. It bypasses hbase servers and read directly from snapshot files.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>snapshotScans</code> - map of snapshot name to scans on that snapshot.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="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-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableSnapshotMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.327">initTableSnapshotMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;snapshotName,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
org.apache.hadoop.fs.Path&nbsp;tmpRestoreDir)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Sets up the job for reading from a table snapshot. It bypasses hbase servers and read directly
from snapshot files.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>snapshotName</code> - The name of the snapshot (of a table) to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dd><code>tmpRestoreDir</code> - a temporary directory to copy the snapshot files into. Current user
should have write permissions to this directory, and this should not
be a subdirectory of rootdir. After the job is finished, restore
directory can be deleted.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html" title="class in org.apache.hadoop.hbase.mapreduce"><code>TableSnapshotInputFormat</code></a></dd>
</dl>
</li>
</ul>
<a name="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-org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableSnapshotMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.357">initTableSnapshotMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;snapshotName,
<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
org.apache.hadoop.fs.Path&nbsp;tmpRestoreDir,
org.apache.hadoop.hbase.util.RegionSplitter.SplitAlgorithm&nbsp;splitAlgo,
int&nbsp;numSplitsPerRegion)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Sets up the job for reading from a table snapshot. It bypasses hbase servers and read directly
from snapshot files.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>snapshotName</code> - The name of the snapshot (of a table) to read from.</dd>
<dd><code>scan</code> - The scan instance with the columns, time range etc.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dd><code>tmpRestoreDir</code> - a temporary directory to copy the snapshot files into. Current user
should have write permissions to this directory, and this should not
be a subdirectory of rootdir. After the job is finished, restore
directory can be deleted.</dd>
<dd><code>splitAlgo</code> - algorithm to split</dd>
<dd><code>numSplitsPerRegion</code> - how many input splits to generate per one region</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html" title="class in org.apache.hadoop.hbase.mapreduce"><code>TableSnapshotInputFormat</code></a></dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-java.util.List-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.378">initTableMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&gt;&nbsp;scans,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a Multi TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scans</code> - The list of <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> objects to read from.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-java.util.List-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.395">initTableMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&gt;&nbsp;scans,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a Multi TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scans</code> - The list of <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> objects to read from.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initTableMapperJob-java.util.List-java.lang.Class-java.lang.Class-java.lang.Class-org.apache.hadoop.mapreduce.Job-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableMapperJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.415">initTableMapperJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&gt;&nbsp;scans,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce">TableMapper</a>&gt;&nbsp;mapper,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputKeyClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;outputValueClass,
org.apache.hadoop.mapreduce.Job&nbsp;job,
boolean&nbsp;addDependencyJars,
boolean&nbsp;initCredentials)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a Multi TableMap job. It will appropriately set up the job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scans</code> - The list of <a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> objects to read from.</dd>
<dd><code>mapper</code> - The mapper class to use.</dd>
<dd><code>outputKeyClass</code> - The class of the output key.</dd>
<dd><code>outputValueClass</code> - The class of the output value.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dd><code>initCredentials</code> - whether to initialize hbase auth credentials for the job</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When setting up the details fails.</dd>
</dl>
</li>
</ul>
<a name="initCredentials-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initCredentials</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.445">initCredentials</a>(org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="initCredentialsForCluster-org.apache.hadoop.mapreduce.Job-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initCredentialsForCluster</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.491">initCredentialsForCluster</a>(org.apache.hadoop.mapreduce.Job&nbsp;job,
org.apache.hadoop.conf.Configuration&nbsp;conf)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Obtain an authentication token, for the specified cluster, on behalf of the current user and
add it to the credentials for the given map reduce job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - The job that requires the permission.</dd>
<dd><code>conf</code> - The configuration to use in connecting to the peer cluster</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When the authentication token cannot be obtained.</dd>
</dl>
</li>
</ul>
<a name="convertScanToString-org.apache.hadoop.hbase.client.Scan-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertScanToString</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.514">convertScanToString</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes the given scan into a Base64 encoded string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scan</code> - The scan to write out.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The scan saved in a Base64 encoded string.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When writing the scan fails.</dd>
</dl>
</li>
</ul>
<a name="convertStringToScan-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertStringToScan</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/hadoop/hbase/client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.525">convertStringToScan</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;base64)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Converts the given Base64 string back into a Scan instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>base64</code> - The scan details.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The newly created Scan instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When reading the scan instance fails.</dd>
</dl>
</li>
</ul>
<a name="initTableReducerJob-java.lang.String-java.lang.Class-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableReducerJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.537">initTableReducerJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce">TableReducer</a>&gt;&nbsp;reducer,
org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableReduce job. It will appropriately set up the JobConf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The output table.</dd>
<dd><code>reducer</code> - The reducer class to use.</dd>
<dd><code>job</code> - The current job to adjust.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When determining the region count fails.</dd>
</dl>
</li>
</ul>
<a name="initTableReducerJob-java.lang.String-java.lang.Class-org.apache.hadoop.mapreduce.Job-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableReducerJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.550">initTableReducerJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce">TableReducer</a>&gt;&nbsp;reducer,
org.apache.hadoop.mapreduce.Job&nbsp;job,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;partitioner)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableReduce job. It will appropriately set up the JobConf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The output table.</dd>
<dd><code>reducer</code> - The reducer class to use.</dd>
<dd><code>job</code> - The current job to adjust.</dd>
<dd><code>partitioner</code> - Partitioner to use. Pass <code>null</code> to use default partitioner.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When determining the region count fails.</dd>
</dl>
</li>
</ul>
<a name="initTableReducerJob-java.lang.String-java.lang.Class-org.apache.hadoop.mapreduce.Job-java.lang.Class-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableReducerJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.576">initTableReducerJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce">TableReducer</a>&gt;&nbsp;reducer,
org.apache.hadoop.mapreduce.Job&nbsp;job,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;partitioner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;quorumAddress,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serverClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serverImpl)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableReduce job. It will appropriately set up the JobConf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The output table.</dd>
<dd><code>reducer</code> - The reducer class to use.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>partitioner</code> - Partitioner to use. Pass <code>null</code> to use default partitioner.</dd>
<dd><code>quorumAddress</code> - Distant cluster to write to; default is null for output to the cluster
that is designated in <code>hbase-site.xml</code>. Set this String to the
zookeeper ensemble of an alternate remote cluster when you would have the
reduce write a cluster that is other than the default; e.g. copying tables
between clusters, the source would be designated by
<code>hbase-site.xml</code> and this param would have the ensemble address
of the remote cluster. The format to pass is particular. Pass
<code> &lt;hbase.zookeeper.quorum&gt;:&lt;
hbase.zookeeper.client.port&gt;:&lt;zookeeper.znode.parent&gt;
</code> such as <code>server,server2,server3:2181:/hbase</code>.</dd>
<dd><code>serverClass</code> - redefined hbase.regionserver.class</dd>
<dd><code>serverImpl</code> - redefined hbase.regionserver.impl</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When determining the region count fails.</dd>
</dl>
</li>
</ul>
<a name="initTableReducerJob-java.lang.String-java.lang.Class-org.apache.hadoop.mapreduce.Job-java.lang.Class-java.lang.String-java.lang.String-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initTableReducerJob</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.606">initTableReducerJob</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableReducer.html" title="class in org.apache.hadoop.hbase.mapreduce">TableReducer</a>&gt;&nbsp;reducer,
org.apache.hadoop.mapreduce.Job&nbsp;job,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;partitioner,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;quorumAddress,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serverClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serverImpl,
boolean&nbsp;addDependencyJars)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Use this before submitting a TableReduce job. It will appropriately set up the JobConf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The output table.</dd>
<dd><code>reducer</code> - The reducer class to use.</dd>
<dd><code>job</code> - The current job to adjust. Make sure the passed job is carrying all
necessary HBase configuration.</dd>
<dd><code>partitioner</code> - Partitioner to use. Pass <code>null</code> to use default partitioner.</dd>
<dd><code>quorumAddress</code> - Distant cluster to write to; default is null for output to the cluster
that is designated in <code>hbase-site.xml</code>. Set this String to
the zookeeper ensemble of an alternate remote cluster when you would
have the reduce write a cluster that is other than the default; e.g.
copying tables between clusters, the source would be designated by
<code>hbase-site.xml</code> and this param would have the ensemble
address of the remote cluster. The format to pass is particular. Pass
<code> &lt;hbase.zookeeper.quorum&gt;:&lt;
hbase.zookeeper.client.port&gt;:&lt;zookeeper.znode.parent&gt;
</code> such as <code>server,server2,server3:2181:/hbase</code>.</dd>
<dd><code>serverClass</code> - redefined hbase.regionserver.class</dd>
<dd><code>serverImpl</code> - redefined hbase.regionserver.impl</dd>
<dd><code>addDependencyJars</code> - upload HBase jars and jars for any of the configured job classes via
the distributed cache (tmpjars).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When determining the region count fails.</dd>
</dl>
</li>
</ul>
<a name="limitNumReduceTasks-java.lang.String-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limitNumReduceTasks</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.653">limitNumReduceTasks</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Ensures that the given number of reduce tasks for the given job configuration does not exceed
the number of regions for the given table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The table to get the region count for.</dd>
<dd><code>job</code> - The current job to adjust.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When retrieving the table details fails.</dd>
</dl>
</li>
</ul>
<a name="setNumReduceTasks-java.lang.String-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumReduceTasks</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.667">setNumReduceTasks</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;table,
org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Sets the number of reduce tasks for the given job configuration to the number of regions the
given table has.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>table</code> - The table to get the region count for.</dd>
<dd><code>job</code> - The current job to adjust.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When retrieving the table details fails.</dd>
</dl>
</li>
</ul>
<a name="setScannerCaching-org.apache.hadoop.mapreduce.Job-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScannerCaching</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.678">setScannerCaching</a>(org.apache.hadoop.mapreduce.Job&nbsp;job,
int&nbsp;batchSize)</pre>
<div class="block">Sets the number of rows to return and cache with each scanner iteration. Higher caching values
will enable faster mapreduce jobs at the expense of requiring more heap to contain the cached
rows.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - The current job to adjust.</dd>
<dd><code>batchSize</code> - The number of rows to return in batch with each scanner iteration.</dd>
</dl>
</li>
</ul>
<a name="addHBaseDependencyJars-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addHBaseDependencyJars</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.693">addHBaseDependencyJars</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Add HBase and its dependencies (only) to the job configuration.
<p>
This is intended as a low-level API, facilitating code reuse between this class and its mapred
counterpart. It also of use to external tools that need to build a MapReduce job that interacts
with HBase but want fine-grained control over the jars shipped to the cluster.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - The Configuration object to extend with dependencies.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/mapred/TableMapReduceUtil.html" title="class in org.apache.hadoop.hbase.mapred"><code>TableMapReduceUtil</code></a>,
<a href="https://issues.apache.org/jira/browse/PIG-3285">PIG-3285</a></dd>
</dl>
</li>
</ul>
<a name="buildDependencyClasspath-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildDependencyClasspath</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.726">buildDependencyClasspath</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Returns a classpath string built from the content of the "tmpjars" value in <code>conf</code>. Also
exposed to shell scripts via `bin/hbase mapredcp`.</div>
</li>
</ul>
<a name="addDependencyJars-org.apache.hadoop.mapreduce.Job-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addDependencyJars</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html#line.750">addDependencyJars</a>(org.apache.hadoop.mapreduce.Job&nbsp;job)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Add the HBase dependency jars as well as jars for any of the configured job classes to the job
configuration, so that JobClient will ship them to the cluster and add them to the
DistributedCache.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TableMapReduceUtil.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableMapper.html" title="class in org.apache.hadoop.hbase.mapreduce"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/mapreduce/TableOutputCommitter.html" title="class in org.apache.hadoop.hbase.mapreduce"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/mapreduce/TableMapReduceUtil.html" target="_top">Frames</a></li>
<li><a href="TableMapReduceUtil.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>