blob: 434a3ec6e4065067dc4cbdaae250c8d9e829ec03 [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 (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 -->
<title>HiveDataFragmenter</title>
<meta name="date" content="2016-04-20">
<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="HiveDataFragmenter";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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="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/hawq/pxf/plugins/hive/HiveColumnarSerdeResolver.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html" target="_top">Frames</a></li>
<li><a href="HiveDataFragmenter.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.hawq.pxf.plugins.hive</div>
<h2 title="Class HiveDataFragmenter" class="title">Class HiveDataFragmenter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">org.apache.hawq.pxf.api.utilities.Plugin</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">org.apache.hawq.pxf.api.Fragmenter</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hawq.pxf.plugins.hive.HiveDataFragmenter</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveInputFormatFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hive">HiveInputFormatFragmenter</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">HiveDataFragmenter</span>
extends <a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></pre>
<div class="block">Fragmenter class for HIVE tables. <br>
Given a Hive table and its partitions divide the data into fragments (here a
data fragment is actually a HDFS file block) and return a list of them. Each
data fragment will contain the following information:
<ol>
<li>sourceName: full HDFS path to the data file that this data fragment is
part of</li>
<li>hosts: a list of the datanode machines that hold a replica of this block</li>
<li>userData:
file_input_format_name_DELIM_serde_name_DELIM_serialization_properties</li>
</ol></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>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#filterInFragmenter">filterInFragmenter</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hawq.pxf.api.Fragmenter">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hawq.pxf.api.<a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></h3>
<code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#fragments">fragments</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hawq.pxf.api.utilities.Plugin">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></h3>
<code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#inputData">inputData</a></code></li>
</ul>
</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/hawq/pxf/plugins/hive/HiveDataFragmenter.html#HiveDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-">HiveDataFragmenter</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a>&nbsp;inputData)</code>
<div class="block">Constructs a HiveDataFragmenter object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#HiveDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-java.lang.Class-">HiveDataFragmenter</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a>&nbsp;inputData,
java.lang.Class&lt;?&gt;&nbsp;clazz)</code>
<div class="block">Constructs a HiveDataFragmenter object.</div>
</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>java.util.List&lt;<a href="../../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#getFragments--">getFragments</a></span>()</code>
<div class="block">Gets the fragments of a given path (source name and location of each
fragment).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api">FragmentsStats</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#getFragmentsStats--">getFragmentsStats</a></span>()</code>
<div class="block">Returns statistics for Hive table.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static org.apache.hadoop.mapred.InputFormat&lt;?,?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#makeInputFormat-java.lang.String-org.apache.hadoop.mapred.JobConf-">makeInputFormat</a></span>(java.lang.String&nbsp;inputFormatName,
org.apache.hadoop.mapred.JobConf&nbsp;jobConf)</code>
<div class="block">Creates the partition InputFormat.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hawq.pxf.api.utilities.Plugin">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></h3>
<code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#isThreadSafe--">isThreadSafe</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="filterInFragmenter">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>filterInFragmenter</h4>
<pre>protected&nbsp;boolean filterInFragmenter</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HiveDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HiveDataFragmenter</h4>
<pre>public&nbsp;HiveDataFragmenter(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a>&nbsp;inputData)</pre>
<div class="block">Constructs a HiveDataFragmenter object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputData</code> - all input parameters coming from the client</dd>
</dl>
</li>
</ul>
<a name="HiveDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-java.lang.Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HiveDataFragmenter</h4>
<pre>public&nbsp;HiveDataFragmenter(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a>&nbsp;inputData,
java.lang.Class&lt;?&gt;&nbsp;clazz)</pre>
<div class="block">Constructs a HiveDataFragmenter object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputData</code> - all input parameters coming from the client</dd>
<dd><code>clazz</code> - Class for JobConf</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getFragments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFragments</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>&gt;&nbsp;getFragments()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragments--">Fragmenter</a></code></span></div>
<div class="block">Gets the fragments of a given path (source name and location of each
fragment). Used to get fragments of data that could be read in parallel
from the different segments.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragments--">getFragments</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of data fragments</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if fragment list could not be retrieved</dd>
</dl>
</li>
</ul>
<a name="makeInputFormat-java.lang.String-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeInputFormat</h4>
<pre>public static&nbsp;org.apache.hadoop.mapred.InputFormat&lt;?,?&gt;&nbsp;makeInputFormat(java.lang.String&nbsp;inputFormatName,
org.apache.hadoop.mapred.JobConf&nbsp;jobConf)
throws java.lang.Exception</pre>
<div class="block">Creates the partition InputFormat.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inputFormatName</code> - input format class name</dd>
<dd><code>jobConf</code> - configuration data for the Hadoop framework</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>InputFormat</code> derived object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if failed to create input format</dd>
</dl>
</li>
</ul>
<a name="getFragmentsStats--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFragmentsStats</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api">FragmentsStats</a>&nbsp;getFragmentsStats()
throws java.lang.Exception</pre>
<div class="block">Returns statistics for Hive table. Currently it's not implemented.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragmentsStats--">getFragmentsStats</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default statistics</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if statistics cannot be gathered</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="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/hawq/pxf/plugins/hive/HiveColumnarSerdeResolver.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html" target="_top">Frames</a></li>
<li><a href="HiveDataFragmenter.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 ======= -->
</body>
</html>