| <!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>org.apache.drill.exec.work.foreman.rm (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="org.apache.drill.exec.work.foreman.rm (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/work/foreman/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/work/fragment/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/work/foreman/rm/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.drill.exec.work.foreman.rm</h1> |
| <div class="docSummary"> |
| <div class="block">Provides resource management and queuing support for the Drill foreman.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.StatusAdapter.html" title="interface in org.apache.drill.exec.work.foreman.rm">DistributedQueryQueue.StatusAdapter</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></td> |
| <td class="colLast"> |
| <div class="block">Interface which defines a queue implementation for query queues.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.QueueLease.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue.QueueLease</a></td> |
| <td class="colLast"> |
| <div class="block">The opaque lease returned once a query is admitted |
| for execution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryResourceAllocator.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryResourceAllocator</a></td> |
| <td class="colLast"> |
| <div class="block">Manages resources for an individual query in conjunction with the |
| global <a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/ResourceManager.html" title="interface in org.apache.drill.exec.work.foreman.rm"><code>ResourceManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryResourceManager.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryResourceManager</a></td> |
| <td class="colLast"> |
| <div class="block">Extends a <a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryResourceAllocator.html" title="interface in org.apache.drill.exec.work.foreman.rm"><code>QueryResourceAllocator</code></a> to provide queueing support.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/ResourceManager.html" title="interface in org.apache.drill.exec.work.foreman.rm">ResourceManager</a></td> |
| <td class="colLast"> |
| <div class="block">Drillbit-wide resource manager shared by all queries.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/AbstractResourceManager.html" title="class in org.apache.drill.exec.work.foreman.rm">AbstractResourceManager</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract base class for a resource manager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DefaultResourceManager.html" title="class in org.apache.drill.exec.work.foreman.rm">DefaultResourceManager</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a default resource manager for clusters that do not provide query |
| queues.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DefaultResourceManager.DefaultQueryResourceManager.html" title="class in org.apache.drill.exec.work.foreman.rm">DefaultResourceManager.DefaultQueryResourceManager</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DefaultResourceManager.DefaultResourceAllocator.html" title="class in org.apache.drill.exec.work.foreman.rm">DefaultResourceManager.DefaultResourceAllocator</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html" title="class in org.apache.drill.exec.work.foreman.rm">DistributedQueryQueue</a></td> |
| <td class="colLast"> |
| <div class="block">Distributed query queue which uses a Zookeeper distributed semaphore to |
| control queuing across the cluster.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.ZKQueueInfo.html" title="class in org.apache.drill.exec.work.foreman.rm">DistributedQueryQueue.ZKQueueInfo</a></td> |
| <td class="colLast"> |
| <div class="block">Exposes a snapshot of internal state information for use in status |
| reporting, such as in the UI.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedResourceManager.html" title="class in org.apache.drill.exec.work.foreman.rm">DistributedResourceManager</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DynamicResourceManager.html" title="class in org.apache.drill.exec.work.foreman.rm">DynamicResourceManager</a></td> |
| <td class="colLast"> |
| <div class="block">Wrapper around the default and/or distributed resource managers |
| to allow dynamically enabling and disabling queueing.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/EmbeddedQueryQueue.html" title="class in org.apache.drill.exec.work.foreman.rm">EmbeddedQueryQueue</a></td> |
| <td class="colLast"> |
| <div class="block">Query queue to be used in an embedded Drillbit.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/ResourceManagerBuilder.html" title="class in org.apache.drill.exec.work.foreman.rm">ResourceManagerBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Builds the proper resource manager and queue implementation for the configured |
| system options.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/ThrottledResourceManager.html" title="class in org.apache.drill.exec.work.foreman.rm">ThrottledResourceManager</a></td> |
| <td class="colLast"> |
| <div class="block">Global resource manager that provides basic admission control (AC) via a |
| configured queue: either the Zookeeper-based distributed queue or the |
| in-process embedded Drillbit queue.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/ThrottledResourceManager.QueuedQueryResourceManager.html" title="class in org.apache.drill.exec.work.foreman.rm">ThrottledResourceManager.QueuedQueryResourceManager</a></td> |
| <td class="colLast"> |
| <div class="block">Per-query resource manager.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/ThrottledResourceManager.QueuedResourceAllocator.html" title="class in org.apache.drill.exec.work.foreman.rm">ThrottledResourceManager.QueuedResourceAllocator</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/ThrottledResourceManager.QueuedResourceAllocator.BufferedOpFinder.html" title="class in org.apache.drill.exec.work.foreman.rm">ThrottledResourceManager.QueuedResourceAllocator.BufferedOpFinder</a></td> |
| <td class="colLast"> |
| <div class="block">Searches a fragment operator tree to find buffered within that fragment.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.QueryQueueException.html" title="class in org.apache.drill.exec.work.foreman.rm">QueryQueue.QueryQueueException</a></td> |
| <td class="colLast"> |
| <div class="block">Exception thrown for all non-timeout error conditions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.QueueTimeoutException.html" title="class in org.apache.drill.exec.work.foreman.rm">QueryQueue.QueueTimeoutException</a></td> |
| <td class="colLast"> |
| <div class="block">Exception thrown if a query exceeds the configured wait time |
| in the query queue.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.drill.exec.work.foreman.rm Description">Package org.apache.drill.exec.work.foreman.rm Description</h2> |
| <div class="block">Provides resource management and queuing support for the Drill foreman. |
| The resource manager tracks total resources available to Drill. Several |
| implementations are available: a default implementation for systems without |
| queueing and an access-controlled (AC) version for systems with queues. |
| <p> |
| Each resource manager provides a per-query manager that is responsible |
| for queuing the query (if needed) and memory allocation to the query based |
| on query characteristics and memory assigned to the query. |
| <p> |
| Provides two different queue implementations. A distributed ZooKeeper queue |
| and a local queue useful for embedded Drillbits (and for testing.)</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/work/foreman/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/work/fragment/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/work/foreman/rm/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All 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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
