Google Git
Sign in
apache / hbase-site / 0082cda45f48d1755543336c908ec6d80d4ec0a9 / . / devapidocs / org / apache / hadoop / hbase / mapreduce / TableInputFormat.html
blob: 7265e4d967ee2451837e33b103ebf17e22df5f2e [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TableInputFormat (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.hadoop.hbase.mapreduce, class: TableInputFormat">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/TableInputFormat.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&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="sub-nav-list">
<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>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.mapreduce</a></div>
<h1 title="Class TableInputFormat" class="title">Class TableInputFormat</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.hadoop.mapreduce.InputFormat&lt;<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;
<div class="inheritance"><a href="TableInputFormatBase.html" title="class in org.apache.hadoop.hbase.mapreduce">org.apache.hadoop.hbase.mapreduce.TableInputFormatBase</a>
<div class="inheritance">org.apache.hadoop.hbase.mapreduce.TableInputFormat</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>org.apache.hadoop.conf.Configurable</code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="RoundRobinTableInputFormat.html" title="class in org.apache.hadoop.hbase.mapreduce">RoundRobinTableInputFormat</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@Public
</span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-45">TableInputFormat</a></span>
<span class="extends-implements">extends <a href="TableInputFormatBase.html" title="class in org.apache.hadoop.hbase.mapreduce">TableInputFormatBase</a>
implements org.apache.hadoop.conf.Configurable</span></div>
<div class="block">Convert HBase tabular data into a format that is consumable by Map/Reduce.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private org.apache.hadoop.conf.Configuration</code></div>
<div class="col-second even-row-color"><code><a href="#conf" class="member-name-link">conf</a></code></div>
<div class="col-last even-row-color">
<div class="block">The configuration.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#INPUT_TABLE" class="member-name-link">INPUT_TABLE</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Job parameter that specifies the input table.</div>
</div>
<div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div>
<div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#SCAN" class="member-name-link">SCAN</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Base-64 encoded scanner.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#SCAN_BATCHSIZE" class="member-name-link">SCAN_BATCHSIZE</a></code></div>
<div class="col-last even-row-color">
<div class="block">Set the maximum number of values to return for each call to next().</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#SCAN_CACHEBLOCKS" class="member-name-link">SCAN_CACHEBLOCKS</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Set to false to disable server-side caching of blocks for this scan.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#SCAN_CACHEDROWS" class="member-name-link">SCAN_CACHEDROWS</a></code></div>
<div class="col-last even-row-color">
<div class="block">The number of rows for caching that will be passed to scanners.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#SCAN_COLUMN_FAMILY" class="member-name-link">SCAN_COLUMN_FAMILY</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Column Family to Scan</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#SCAN_COLUMNS" class="member-name-link">SCAN_COLUMNS</a></code></div>
<div class="col-last even-row-color">
<div class="block">Space delimited list of columns and column families to scan.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#SCAN_MAXVERSIONS" class="member-name-link">SCAN_MAXVERSIONS</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The maximum number of version to return.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#SCAN_ROW_START" class="member-name-link">SCAN_ROW_START</a></code></div>
<div class="col-last even-row-color">
<div class="block">Scan start row</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#SCAN_ROW_STOP" class="member-name-link">SCAN_ROW_STOP</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Scan stop row</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#SCAN_TIMERANGE_END" class="member-name-link">SCAN_TIMERANGE_END</a></code></div>
<div class="col-last even-row-color">
<div class="block">The ending timestamp used to filter columns with a specific range of versions.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#SCAN_TIMERANGE_START" class="member-name-link">SCAN_TIMERANGE_START</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The starting timestamp used to filter columns with a specific range of versions.</div>
</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#SCAN_TIMESTAMP" class="member-name-link">SCAN_TIMESTAMP</a></code></div>
<div class="col-last even-row-color">
<div class="block">The timestamp used to filter columns with a specific timestamp.</div>
</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#SHUFFLE_MAPS" class="member-name-link">SHUFFLE_MAPS</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Specify if we have to shuffle the map tasks.</div>
</div>
<div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#SPLIT_TABLE" class="member-name-link">SPLIT_TABLE</a></code></div>
<div class="col-last even-row-color">
<div class="block">If specified, use start keys of this table to split.</div>
</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.mapreduce.TableInputFormatBase">Fields inherited from class&nbsp;org.apache.hadoop.hbase.mapreduce.<a href="TableInputFormatBase.html" title="class in org.apache.hadoop.hbase.mapreduce">TableInputFormatBase</a></h3>
<code><a href="TableInputFormatBase.html#MAPREDUCE_INPUT_AUTOBALANCE">MAPREDUCE_INPUT_AUTOBALANCE</a>, <a href="TableInputFormatBase.html#MAX_AVERAGE_REGION_SIZE">MAX_AVERAGE_REGION_SIZE</a>, <a href="TableInputFormatBase.html#NUM_MAPPERS_PER_REGION">NUM_MAPPERS_PER_REGION</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">TableInputFormat</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#addColumn(org.apache.hadoop.hbase.client.Scan,byte%5B%5D)" class="member-name-link">addColumn</a><wbr>(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
byte[]&nbsp;familyAndQualifier)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Parses a combined family and qualifier and adds either both or just the family in case there is
no qualifier.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#addColumns(org.apache.hadoop.hbase.client.Scan,byte%5B%5D%5B%5D)" class="member-name-link">addColumns</a><wbr>(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
byte[][]&nbsp;columns)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Adds an array of columns specified using old format, family:qualifier.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#addColumns(org.apache.hadoop.hbase.client.Scan,java.lang.String)" class="member-name-link">addColumns</a><wbr>(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columns)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Convenience method to parse a string representation of an array of column specifiers.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#configureSplitTable(org.apache.hadoop.mapreduce.Job,org.apache.hadoop.hbase.TableName)" class="member-name-link">configureSplitTable</a><wbr>(org.apache.hadoop.mapreduce.Job&nbsp;job,
<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Sets split table in map-reduce job.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createScanFromConfiguration(org.apache.hadoop.conf.Configuration)" class="member-name-link">createScanFromConfiguration</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Sets up a <a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> instance, applying settings from the configuration property constants
defined in <code>TableInputFormat</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.conf.Configuration</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConf()" class="member-name-link">getConf</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the current configuration.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;org.apache.hadoop.mapreduce.InputSplit&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSplits(org.apache.hadoop.mapreduce.JobContext)" class="member-name-link">getSplits</a><wbr>(org.apache.hadoop.mapreduce.JobContext&nbsp;context)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Calculates the splits that will serve as input for the map tasks.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a>&lt;byte[][],<wbr>byte[][]&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStartEndKeys()" class="member-name-link">getStartEndKeys</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize(org.apache.hadoop.mapreduce.JobContext)" class="member-name-link">initialize</a><wbr>(org.apache.hadoop.mapreduce.JobContext&nbsp;context)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Handle subclass specific set up.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConf(org.apache.hadoop.conf.Configuration)" class="member-name-link">setConf</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;configuration)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the configuration.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.mapreduce.TableInputFormatBase">Methods inherited from class&nbsp;org.apache.hadoop.hbase.mapreduce.<a href="TableInputFormatBase.html" title="class in org.apache.hadoop.hbase.mapreduce">TableInputFormatBase</a></h3>
<code><a href="TableInputFormatBase.html#calculateAutoBalancedSplits(java.util.List,long)">calculateAutoBalancedSplits</a>, <a href="TableInputFormatBase.html#closeTable()">closeTable</a>, <a href="TableInputFormatBase.html#createNInputSplitsUniform(org.apache.hadoop.mapreduce.InputSplit,int)">createNInputSplitsUniform</a>, <a href="TableInputFormatBase.html#createRecordReader(org.apache.hadoop.mapreduce.InputSplit,org.apache.hadoop.mapreduce.TaskAttemptContext)">createRecordReader</a>, <a href="TableInputFormatBase.html#createRegionSizeCalculator(org.apache.hadoop.hbase.client.RegionLocator,org.apache.hadoop.hbase.client.Admin)">createRegionSizeCalculator</a>, <a href="TableInputFormatBase.html#getAdmin()">getAdmin</a>, <a href="TableInputFormatBase.html#getRegionLocator()">getRegionLocator</a>, <a href="TableInputFormatBase.html#getScan()">getScan</a>, <a href="TableInputFormatBase.html#getTable()">getTable</a>, <a href="TableInputFormatBase.html#includeRegionInSplit(byte%5B%5D,byte%5B%5D)">includeRegionInSplit</a>, <a href="TableInputFormatBase.html#initializeTable(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.TableName)">initializeTable</a>, <a href="TableInputFormatBase.html#reverseDNS(java.net.InetAddress)">reverseDNS</a>, <a href="TableInputFormatBase.html#setScan(org.apache.hadoop.hbase.client.Scan)">setScan</a>, <a href="TableInputFormatBase.html#setTableRecordReader(org.apache.hadoop.hbase.mapreduce.TableRecordReader)">setTableRecordReader</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="LOG">
<h3>LOG</h3>
<div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type">org.slf4j.Logger</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-48">LOG</a></span></div>
</section>
</li>
<li>
<section class="detail" id="INPUT_TABLE">
<h3>INPUT_TABLE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-52">INPUT_TABLE</a></span></div>
<div class="block">Job parameter that specifies the input table.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.INPUT_TABLE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SPLIT_TABLE">
<h3>SPLIT_TABLE</h3>
<div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-57">SPLIT_TABLE</a></span></div>
<div class="block">If specified, use start keys of this table to split. This is useful when you are preparing data
for bulkload.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SPLIT_TABLE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN">
<h3>SCAN</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-62">SCAN</a></span></div>
<div class="block">Base-64 encoded scanner. All other SCAN_ confs are ignored if this is specified. See
<a href="TableMapReduceUtil.html#convertScanToString(org.apache.hadoop.hbase.client.Scan)"><code>TableMapReduceUtil.convertScanToString(Scan)</code></a> for more details.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_ROW_START">
<h3>SCAN_ROW_START</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-64">SCAN_ROW_START</a></span></div>
<div class="block">Scan start row</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_ROW_START">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_ROW_STOP">
<h3>SCAN_ROW_STOP</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-66">SCAN_ROW_STOP</a></span></div>
<div class="block">Scan stop row</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_ROW_STOP">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_COLUMN_FAMILY">
<h3>SCAN_COLUMN_FAMILY</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-68">SCAN_COLUMN_FAMILY</a></span></div>
<div class="block">Column Family to Scan</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_COLUMN_FAMILY">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_COLUMNS">
<h3>SCAN_COLUMNS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-70">SCAN_COLUMNS</a></span></div>
<div class="block">Space delimited list of columns and column families to scan.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_COLUMNS">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_TIMESTAMP">
<h3>SCAN_TIMESTAMP</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-72">SCAN_TIMESTAMP</a></span></div>
<div class="block">The timestamp used to filter columns with a specific timestamp.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_TIMESTAMP">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_TIMERANGE_START">
<h3>SCAN_TIMERANGE_START</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-74">SCAN_TIMERANGE_START</a></span></div>
<div class="block">The starting timestamp used to filter columns with a specific range of versions.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_TIMERANGE_START">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_TIMERANGE_END">
<h3>SCAN_TIMERANGE_END</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-76">SCAN_TIMERANGE_END</a></span></div>
<div class="block">The ending timestamp used to filter columns with a specific range of versions.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_TIMERANGE_END">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_MAXVERSIONS">
<h3>SCAN_MAXVERSIONS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-78">SCAN_MAXVERSIONS</a></span></div>
<div class="block">The maximum number of version to return.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_MAXVERSIONS">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_CACHEBLOCKS">
<h3>SCAN_CACHEBLOCKS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-80">SCAN_CACHEBLOCKS</a></span></div>
<div class="block">Set to false to disable server-side caching of blocks for this scan.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_CACHEBLOCKS">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_CACHEDROWS">
<h3>SCAN_CACHEDROWS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-82">SCAN_CACHEDROWS</a></span></div>
<div class="block">The number of rows for caching that will be passed to scanners.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_CACHEDROWS">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SCAN_BATCHSIZE">
<h3>SCAN_BATCHSIZE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-84">SCAN_BATCHSIZE</a></span></div>
<div class="block">Set the maximum number of values to return for each call to next().</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SCAN_BATCHSIZE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SHUFFLE_MAPS">
<h3>SHUFFLE_MAPS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-86">SHUFFLE_MAPS</a></span></div>
<div class="block">Specify if we have to shuffle the map tasks.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapreduce.TableInputFormat.SHUFFLE_MAPS">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="conf">
<h3>conf</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">org.apache.hadoop.conf.Configuration</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-89">conf</a></span></div>
<div class="block">The configuration.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>TableInputFormat</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-46">TableInputFormat</a></span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getConf()">
<h3>getConf</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.hadoop.conf.Configuration</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-96">getConf</a></span>()</div>
<div class="block">Returns the current configuration.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code>getConf</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.conf.Configurable</code></dd>
<dt>Returns:</dt>
<dd>The current configuration.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><code>Configurable.getConf()</code></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setConf(org.apache.hadoop.conf.Configuration)">
<h3>setConf</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-106">setConf</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;configuration)</span></div>
<div class="block">Sets the configuration. This is used to set the details for the table to be scanned.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code>setConf</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.conf.Configurable</code></dd>
<dt>Parameters:</dt>
<dd><code>configuration</code> - The configuration to set.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><code>Configurable.setConf(org.apache.hadoop.conf.Configuration)</code></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createScanFromConfiguration(org.apache.hadoop.conf.Configuration)">
<h3>createScanFromConfiguration</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-141">createScanFromConfiguration</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Sets up a <a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> instance, applying settings from the configuration property constants
defined in <code>TableInputFormat</code>. This allows specifying things such as:
<ul>
<li>start and stop rows</li>
<li>column qualifiers or families</li>
<li>timestamps or timerange</li>
<li>scanner caching and batch size</li>
</ul></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="initialize(org.apache.hadoop.mapreduce.JobContext)">
<h3>initialize</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-187">initialize</a></span><wbr><span class="parameters">(org.apache.hadoop.mapreduce.JobContext&nbsp;context)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="TableInputFormatBase.html#initialize(org.apache.hadoop.mapreduce.JobContext)">TableInputFormatBase</a></code></span></div>
<div class="block">Handle subclass specific set up. Each of the entry points used by the MapReduce framework,
<a href="TableInputFormatBase.html#createRecordReader(org.apache.hadoop.mapreduce.InputSplit,org.apache.hadoop.mapreduce.TaskAttemptContext)"><code>TableInputFormatBase.createRecordReader(InputSplit, TaskAttemptContext)</code></a> and <a href="TableInputFormatBase.html#getSplits(org.apache.hadoop.mapreduce.JobContext)"><code>TableInputFormatBase.getSplits(JobContext)</code></a>,
will call <a href="TableInputFormatBase.html#initialize(org.apache.hadoop.mapreduce.JobContext)"><code>TableInputFormatBase.initialize(JobContext)</code></a> as a convenient centralized location to handle
retrieving the necessary configuration information and calling
<a href="TableInputFormatBase.html#initializeTable(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.TableName)"><code>TableInputFormatBase.initializeTable(Connection, TableName)</code></a>. Subclasses should implement their initialize
call such that it is safe to call multiple times. The current TableInputFormatBase
implementation relies on a non-null table reference to decide if an initialize call is needed,
but this behavior may change in the future. In particular, it is critical that initializeTable
not be called multiple times since this will leak Connection instances.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TableInputFormatBase.html#initialize(org.apache.hadoop.mapreduce.JobContext)">initialize</a></code>&nbsp;in class&nbsp;<code><a href="TableInputFormatBase.html" title="class in org.apache.hadoop.hbase.mapreduce">TableInputFormatBase</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addColumn(org.apache.hadoop.hbase.client.Scan,byte[])">
<h3>addColumn</h3>
<div class="member-signature"><span class="modifiers">private static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-206">addColumn</a></span><wbr><span class="parameters">(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
byte[]&nbsp;familyAndQualifier)</span></div>
<div class="block">Parses a combined family and qualifier and adds either both or just the family in case there is
no qualifier. This assumes the older colon divided notation, e.g. "family:qualifier".</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scan</code> - The Scan to update.</dd>
<dd><code>familyAndQualifier</code> - family and qualifier</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - When familyAndQualifier is invalid.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addColumns(org.apache.hadoop.hbase.client.Scan,byte[][])">
<h3>addColumns</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-226">addColumns</a></span><wbr><span class="parameters">(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
byte[][]&nbsp;columns)</span></div>
<div class="block">Adds an array of columns specified using old format, family:qualifier.
<p>
Overrides previous calls to <a href="../client/Scan.html#addColumn(byte%5B%5D,byte%5B%5D)"><code>Scan.addColumn(byte[], byte[])</code></a>for any families in the
input.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scan</code> - The Scan to update.</dd>
<dd><code>columns</code> - array of columns, formatted as <code>family:qualifier</code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../client/Scan.html#addColumn(byte%5B%5D,byte%5B%5D)"><code>Scan.addColumn(byte[], byte[])</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSplits(org.apache.hadoop.mapreduce.JobContext)">
<h3>getSplits</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;org.apache.hadoop.mapreduce.InputSplit&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-240">getSplits</a></span><wbr><span class="parameters">(org.apache.hadoop.mapreduce.JobContext&nbsp;context)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Calculates the splits that will serve as input for the map tasks. The number of splits matches
the number of regions in a table. Splits are shuffled if required.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TableInputFormatBase.html#getSplits(org.apache.hadoop.mapreduce.JobContext)">getSplits</a></code>&nbsp;in class&nbsp;<code><a href="TableInputFormatBase.html" title="class in org.apache.hadoop.hbase.mapreduce">TableInputFormatBase</a></code></dd>
<dt>Parameters:</dt>
<dd><code>context</code> - The current job context.</dd>
<dt>Returns:</dt>
<dd>The list of input splits.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - When creating the list of splits fails.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><code>InputFormat.getSplits(org.apache.hadoop.mapreduce.JobContext)</code></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addColumns(org.apache.hadoop.hbase.client.Scan,java.lang.String)">
<h3>addColumns</h3>
<div class="member-signature"><span class="modifiers">private static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-257">addColumns</a></span><wbr><span class="parameters">(<a href="../client/Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a>&nbsp;scan,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;columns)</span></div>
<div class="block">Convenience method to parse a string representation of an array of column specifiers.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scan</code> - The Scan to update.</dd>
<dd><code>columns</code> - The columns to parse.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getStartEndKeys()">
<h3>getStartEndKeys</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a>&lt;byte[][],<wbr>byte[][]&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-264">getStartEndKeys</a></span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="TableInputFormatBase.html#getStartEndKeys()">getStartEndKeys</a></code>&nbsp;in class&nbsp;<code><a href="TableInputFormatBase.html" title="class in org.apache.hadoop.hbase.mapreduce">TableInputFormatBase</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="configureSplitTable(org.apache.hadoop.mapreduce.Job,org.apache.hadoop.hbase.TableName)">
<h3>configureSplitTable</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/TableInputFormat.html#line-281">configureSplitTable</a></span><wbr><span class="parameters">(org.apache.hadoop.mapreduce.Job&nbsp;job,
<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</span></div>
<div class="block">Sets split table in map-reduce job.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>