| <!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>DistributedQueryQueue (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="DistributedQueryQueue (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All 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="class-use/DistributedQueryQueue.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/rm/DefaultResourceManager.DefaultResourceAllocator.html" title="class in org.apache.drill.exec.work.foreman.rm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.StatusAdapter.html" title="interface in org.apache.drill.exec.work.foreman.rm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html" target="_top">Frames</a></li> |
| <li><a href="DistributedQueryQueue.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.work.foreman.rm</div> |
| <h2 title="Class DistributedQueryQueue" class="title">Class DistributedQueryQueue</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.drill.exec.work.foreman.rm.DistributedQueryQueue</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DistributedQueryQueue</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></pre> |
| <div class="block">Distributed query queue which uses a Zookeeper distributed semaphore to |
| control queuing across the cluster. The distributed queue is actually two |
| queues: one for "small" queries, another for "large" queries. Query size is |
| determined by the Planner's estimate of query cost. |
| <p> |
| This queue is configured using system options: |
| <dl> |
| <dt><tt>exec.queue.enable</tt> |
| <dt> |
| <dd>Set to true to enable the distributed queue.</dd> |
| <dt><tt>exec.queue.large</tt> |
| <dt> |
| <dd>The maximum number of large queries to admit. Additional |
| queries wait in the queue.</dd> |
| <dt><tt>exec.queue.small</tt> |
| <dt> |
| <dd>The maximum number of small queries to admit. Additional |
| queries wait in the queue.</dd> |
| <dt><tt>exec.queue.threshold</tt> |
| <dt> |
| <dd>The cost threshold. Queries below this size are small, at |
| or above this size are large..</dd> |
| <dt><tt>exec.queue.timeout_millis</tt> |
| <dt> |
| <dd>The maximum time (in milliseconds) a query will wait in the |
| queue before failing.</dd> |
| </dl> |
| <p> |
| The above values are refreshed every five seconds. This aids performance |
| a bit in systems with very high query arrival rates.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><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></span></code> |
| <div class="block">Exposes a snapshot of internal state information for use in status |
| reporting, such as in the UI.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.work.foreman.rm.QueryQueue"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.drill.exec.work.foreman.rm.<a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></h3> |
| <code><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>, <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>, <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></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"> </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/drill/exec/work/foreman/rm/DistributedQueryQueue.html#DistributedQueryQueue-org.apache.drill.exec.server.DrillbitContext-org.apache.drill.exec.work.foreman.rm.DistributedQueryQueue.StatusAdapter-">DistributedQueryQueue</a></span>(<a href="../../../../../../../org/apache/drill/exec/server/DrillbitContext.html" title="class in org.apache.drill.exec.server">DrillbitContext</a> context, |
| <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> adapter)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html#defaultQueryMemoryPerNode-double-">defaultQueryMemoryPerNode</a></span>(double cost)</code> |
| <div class="block">Return the amount of memory per node when creating a EXPLAIN |
| query plan.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html#enabled--">enabled</a></span>()</code> |
| <div class="block">Determine if the queue is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html#enqueue-org.apache.drill.exec.proto.UserBitShared.QueryId-double-">enqueue</a></span>(<a href="../../../../../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a> queryId, |
| double cost)</code> |
| <div class="block">This limits the number of "small" and "large" queries that a Drill cluster will run |
| simultaneously, if queuing is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html#getInfo--">getInfo</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html#minimumOperatorMemory--">minimumOperatorMemory</a></span>()</code> |
| <div class="block">Optional floor on the amount of memory assigned per operator.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html#setMemoryPerNode-long-">setMemoryPerNode</a></span>(long memoryPerNode)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DistributedQueryQueue-org.apache.drill.exec.server.DrillbitContext-org.apache.drill.exec.work.foreman.rm.DistributedQueryQueue.StatusAdapter-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DistributedQueryQueue</h4> |
| <pre>public DistributedQueryQueue(<a href="../../../../../../../org/apache/drill/exec/server/DrillbitContext.html" title="class in org.apache.drill.exec.server">DrillbitContext</a> context, |
| <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> adapter)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setMemoryPerNode-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMemoryPerNode</h4> |
| <pre>public void setMemoryPerNode(long memoryPerNode)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#setMemoryPerNode-long-">setMemoryPerNode</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="defaultQueryMemoryPerNode-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defaultQueryMemoryPerNode</h4> |
| <pre>public long defaultQueryMemoryPerNode(double cost)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#defaultQueryMemoryPerNode-double-">QueryQueue</a></code></span></div> |
| <div class="block">Return the amount of memory per node when creating a EXPLAIN |
| query plan. Plans to be executed should get the query memory from |
| the lease, as the lease may adjust the default amount on a per-query |
| basis. This means that the memory used to execute the query may |
| differ from the amount shown in an EXPLAIN plan.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#defaultQueryMemoryPerNode-double-">defaultQueryMemoryPerNode</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>assumed memory per node, in bytes, to use when creating |
| an EXPLAIN plan</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="minimumOperatorMemory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>minimumOperatorMemory</h4> |
| <pre>public long minimumOperatorMemory()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#minimumOperatorMemory--">QueryQueue</a></code></span></div> |
| <div class="block">Optional floor on the amount of memory assigned per operator. |
| This ensures that operators receive a certain amount, separate from |
| any memory slicing. This can oversubscribe node memory if used |
| incorrectly.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#minimumOperatorMemory--">minimumOperatorMemory</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>minimum per-operator memory, in bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enqueue-org.apache.drill.exec.proto.UserBitShared.QueryId-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enqueue</h4> |
| <pre>public <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> enqueue(<a href="../../../../../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a> queryId, |
| double cost) |
| throws <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>, |
| <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></pre> |
| <div class="block">This limits the number of "small" and "large" queries that a Drill cluster will run |
| simultaneously, if queuing is enabled. If the query is unable to run, this will block |
| until it can. Beware that this is called under run(), and so will consume a thread |
| while it waits for the required distributed semaphore.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#enqueue-org.apache.drill.exec.proto.UserBitShared.QueryId-double-">enqueue</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queryId</code> - query identifier</dd> |
| <dd><code>cost</code> - the query plan</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the query lease which must be passed to <code>#release(QueueLease)</code> |
| upon query completion</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>QueryQueueException</code> - if the underlying ZK queuing mechanism fails</dd> |
| <dd><code>QueueTimeoutException</code> - if the query waits too long in the |
| queue</dd> |
| <dd><code><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></code></dd> |
| <dd><code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enabled</h4> |
| <pre>public boolean enabled()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#enabled--">QueryQueue</a></code></span></div> |
| <div class="block">Determine if the queue is enabled.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#enabled--">enabled</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the query is enabled, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInfo</h4> |
| <pre>public <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> getInfo()</pre> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html#close--">close</a></code> in interface <code><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/QueryQueue.html" title="interface in org.apache.drill.exec.work.foreman.rm">QueryQueue</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/DistributedQueryQueue.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/rm/DefaultResourceManager.DefaultResourceAllocator.html" title="class in org.apache.drill.exec.work.foreman.rm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.StatusAdapter.html" title="interface in org.apache.drill.exec.work.foreman.rm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/work/foreman/rm/DistributedQueryQueue.html" target="_top">Frames</a></li> |
| <li><a href="DistributedQueryQueue.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
