blob: 8881bf2d41e72458aaa3659603b2c2e856684689 [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>QueryParallelizer (Drill : 1.20.3 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="QueryParallelizer (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/QueryParallelizer.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/drill/exec/planner/fragment/PlanningSet.html" title="class in org.apache.drill.exec.planner.fragment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/planner/fragment/QueueQueryParallelizer.html" title="class in org.apache.drill.exec.planner.fragment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/planner/fragment/QueryParallelizer.html" target="_top">Frames</a></li>
<li><a href="QueryParallelizer.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.drill.exec.planner.fragment</div>
<h2 title="Interface QueryParallelizer" class="title">Interface QueryParallelizer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/planner/fragment/ParallelizationParameters.html" title="interface in org.apache.drill.exec.planner.fragment">ParallelizationParameters</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/drill/exec/planner/fragment/DefaultQueryParallelizer.html" title="class in org.apache.drill.exec.planner.fragment">DefaultQueryParallelizer</a>, <a href="../../../../../../org/apache/drill/exec/planner/fragment/QueueQueryParallelizer.html" title="class in org.apache.drill.exec.planner.fragment">QueueQueryParallelizer</a>, <a href="../../../../../../org/apache/drill/exec/planner/fragment/SimpleParallelizer.html" title="class in org.apache.drill.exec.planner.fragment">SimpleParallelizer</a>, <a href="../../../../../../org/apache/drill/exec/planner/fragment/contrib/SplittingParallelizer.html" title="class in org.apache.drill.exec.planner.fragment.contrib">SplittingParallelizer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">QueryParallelizer</span>
extends <a href="../../../../../../org/apache/drill/exec/planner/fragment/ParallelizationParameters.html" title="interface in org.apache.drill.exec.planner.fragment">ParallelizationParameters</a></pre>
<div class="block">Parallelizes the query plan. Once the optimizer finishes its job by producing a
optimized plan, it is the job of this parallelizer to generate a parallel plan out of the
optimized physical plan. It does so by using the optimizers estimates for row count etc.
There are two kinds of parallelizers as explained below. Currently the difference in
both of these parallelizers is only in the memory assignment for the physical operators.
<p>
a) Default Parallelizer: It optimistically assumes that the whole cluster is running only the
current query and based on heuristics assigns the optimal memory to the buffered operators.
<p>
b) Queue Parallelizer: This parallelizer computes the memory that can be allocated at best based
on the current cluster state(as to how much memory is available) and also the configuration
of the queue that it can run on.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../../org/apache/drill/exec/work/QueryWorkUnit.html" title="class in org.apache.drill.exec.work">QueryWorkUnit</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/fragment/QueryParallelizer.html#generateWorkUnit-org.apache.drill.exec.server.options.OptionList-org.apache.drill.exec.proto.CoordinationProtos.DrillbitEndpoint-org.apache.drill.exec.proto.UserBitShared.QueryId-java.util.Collection-org.apache.drill.exec.planner.fragment.Fragment-org.apache.drill.exec.rpc.user.UserSession-org.apache.drill.exec.proto.BitControl.QueryContextInformation-">generateWorkUnit</a></span>(<a href="../../../../../../org/apache/drill/exec/server/options/OptionList.html" title="class in org.apache.drill.exec.server.options">OptionList</a>&nbsp;options,
<a href="../../../../../../org/apache/drill/exec/proto/CoordinationProtos.DrillbitEndpoint.html" title="class in org.apache.drill.exec.proto">CoordinationProtos.DrillbitEndpoint</a>&nbsp;foremanNode,
<a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a>&nbsp;queryId,
<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/drill/exec/proto/CoordinationProtos.DrillbitEndpoint.html" title="class in org.apache.drill.exec.proto">CoordinationProtos.DrillbitEndpoint</a>&gt;&nbsp;activeEndpoints,
<a href="../../../../../../org/apache/drill/exec/planner/fragment/Fragment.html" title="class in org.apache.drill.exec.planner.fragment">Fragment</a>&nbsp;rootFragment,
<a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html" title="class in org.apache.drill.exec.rpc.user">UserSession</a>&nbsp;session,
<a href="../../../../../../org/apache/drill/exec/proto/BitControl.QueryContextInformation.html" title="class in org.apache.drill.exec.proto">BitControl.QueryContextInformation</a>&nbsp;queryContextInfo)</code>
<div class="block">This is the only function exposed to the consumer of this parallelizer (currently Foreman) to parallelize
the plan.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.planner.fragment.ParallelizationParameters">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.planner.fragment.<a href="../../../../../../org/apache/drill/exec/planner/fragment/ParallelizationParameters.html" title="interface in org.apache.drill.exec.planner.fragment">ParallelizationParameters</a></h3>
<code><a href="../../../../../../org/apache/drill/exec/planner/fragment/ParallelizationParameters.html#getAffinityFactor--">getAffinityFactor</a>, <a href="../../../../../../org/apache/drill/exec/planner/fragment/ParallelizationParameters.html#getMaxGlobalWidth--">getMaxGlobalWidth</a>, <a href="../../../../../../org/apache/drill/exec/planner/fragment/ParallelizationParameters.html#getMaxWidthPerNode--">getMaxWidthPerNode</a>, <a href="../../../../../../org/apache/drill/exec/planner/fragment/ParallelizationParameters.html#getSliceTarget--">getSliceTarget</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="generateWorkUnit-org.apache.drill.exec.server.options.OptionList-org.apache.drill.exec.proto.CoordinationProtos.DrillbitEndpoint-org.apache.drill.exec.proto.UserBitShared.QueryId-java.util.Collection-org.apache.drill.exec.planner.fragment.Fragment-org.apache.drill.exec.rpc.user.UserSession-org.apache.drill.exec.proto.BitControl.QueryContextInformation-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>generateWorkUnit</h4>
<pre><a href="../../../../../../org/apache/drill/exec/work/QueryWorkUnit.html" title="class in org.apache.drill.exec.work">QueryWorkUnit</a>&nbsp;generateWorkUnit(<a href="../../../../../../org/apache/drill/exec/server/options/OptionList.html" title="class in org.apache.drill.exec.server.options">OptionList</a>&nbsp;options,
<a href="../../../../../../org/apache/drill/exec/proto/CoordinationProtos.DrillbitEndpoint.html" title="class in org.apache.drill.exec.proto">CoordinationProtos.DrillbitEndpoint</a>&nbsp;foremanNode,
<a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a>&nbsp;queryId,
<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/drill/exec/proto/CoordinationProtos.DrillbitEndpoint.html" title="class in org.apache.drill.exec.proto">CoordinationProtos.DrillbitEndpoint</a>&gt;&nbsp;activeEndpoints,
<a href="../../../../../../org/apache/drill/exec/planner/fragment/Fragment.html" title="class in org.apache.drill.exec.planner.fragment">Fragment</a>&nbsp;rootFragment,
<a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html" title="class in org.apache.drill.exec.rpc.user">UserSession</a>&nbsp;session,
<a href="../../../../../../org/apache/drill/exec/proto/BitControl.QueryContextInformation.html" title="class in org.apache.drill.exec.proto">BitControl.QueryContextInformation</a>&nbsp;queryContextInfo)
throws <a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</a></pre>
<div class="block">This is the only function exposed to the consumer of this parallelizer (currently Foreman) to parallelize
the plan. The caller transforms the plan to a fragment tree and supplies the required information for
the parallelizer to do its job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>options</code> - List of all options that are set for the current session.</dd>
<dd><code>foremanNode</code> - Endpoint information of the foreman node.</dd>
<dd><code>queryId</code> - Unique ID of the query.</dd>
<dd><code>activeEndpoints</code> - Currently active endpoints on which the plan can run.</dd>
<dd><code>rootFragment</code> - root of the fragment tree of the transformed physical plan</dd>
<dd><code>session</code> - user session object.</dd>
<dd><code>queryContextInfo</code> - query context.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Executable query plan which contains all the information like minor frags and major frags.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/common/exceptions/ExecutionSetupException.html" title="class in org.apache.drill.common.exceptions">ExecutionSetupException</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/QueryParallelizer.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/drill/exec/planner/fragment/PlanningSet.html" title="class in org.apache.drill.exec.planner.fragment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/exec/planner/fragment/QueueQueryParallelizer.html" title="class in org.apache.drill.exec.planner.fragment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/planner/fragment/QueryParallelizer.html" target="_top">Frames</a></li>
<li><a href="QueryParallelizer.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>