| <!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>ResultSetOptionBuilder (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="ResultSetOptionBuilder (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/ResultSetOptionBuilder.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/physical/resultSet/impl/ResultSetLoaderImpl.ResultSetOptions.html" title="class in org.apache.drill.exec.physical.resultSet.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultVectorCacheImpl.html" title="class in org.apache.drill.exec.physical.resultSet.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" target="_top">Frames</a></li> |
| <li><a href="ResultSetOptionBuilder.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.physical.resultSet.impl</div> |
| <h2 title="Class ResultSetOptionBuilder" class="title">Class ResultSetOptionBuilder</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.physical.resultSet.impl.ResultSetOptionBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ResultSetOptionBuilder</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></pre> |
| <div class="block">Builder for the options for the row set loader. Reasonable defaults |
| are provided for all options; use the default options for test code or |
| for clients that don't need special settings.</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"> </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 <a href="../../../../../../../org/apache/drill/common/exceptions/CustomErrorContext.html" title="interface in org.apache.drill.common.exceptions">CustomErrorContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#errorContext">errorContext</a></span></code> |
| <div class="block">Error message context</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#maxBatchSize">maxBatchSize</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ProjectionFilter.html" title="interface in org.apache.drill.exec.physical.resultSet.impl">ProjectionFilter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#projectionFilter">projectionFilter</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedTuple.html" title="interface in org.apache.drill.exec.physical.resultSet.project">RequestedTuple</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#projectionSet">projectionSet</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/drill/exec/record/metadata/TupleMetadata.html" title="interface in org.apache.drill.exec.record.metadata">TupleMetadata</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#readerSchema">readerSchema</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#rowCountLimit">rowCountLimit</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#scanLimit">scanLimit</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/ResultVectorCache.html" title="interface in org.apache.drill.exec.physical.resultSet">ResultVectorCache</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#vectorCache">vectorCache</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#vectorSizeLimit">vectorSizeLimit</a></span></code> </td> |
| </tr> |
| </table> |
| </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/physical/resultSet/impl/ResultSetOptionBuilder.html#ResultSetOptionBuilder--">ResultSetOptionBuilder</a></span>()</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><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#batchSizeLimit-int-">batchSizeLimit</a></span>(int bytes)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetLoaderImpl.ResultSetOptions.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetLoaderImpl.ResultSetOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#build--">build</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#errorContext-org.apache.drill.common.exceptions.CustomErrorContext-">errorContext</a></span>(<a href="../../../../../../../org/apache/drill/common/exceptions/CustomErrorContext.html" title="interface in org.apache.drill.common.exceptions">CustomErrorContext</a> context)</code> |
| <div class="block">Provides context for error messages.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#limit-long-">limit</a></span>(long limit)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#projection-org.apache.drill.exec.physical.resultSet.project.RequestedTuple-">projection</a></span>(<a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedTuple.html" title="interface in org.apache.drill.exec.physical.resultSet.project">RequestedTuple</a> projSet)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#projectionFilter-org.apache.drill.exec.physical.resultSet.impl.ProjectionFilter-">projectionFilter</a></span>(<a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ProjectionFilter.html" title="interface in org.apache.drill.exec.physical.resultSet.impl">ProjectionFilter</a> projectionFilter)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#readerSchema-org.apache.drill.exec.record.metadata.TupleMetadata-">readerSchema</a></span>(<a href="../../../../../../../org/apache/drill/exec/record/metadata/TupleMetadata.html" title="interface in org.apache.drill.exec.record.metadata">TupleMetadata</a> readerSchema)</code> |
| <div class="block">Clients can use the row set builder in several ways: |
| |
| Provide the schema up front, when known, by using this method to |
| provide the schema. |
| Discover the schema on the fly, adding columns during the write |
| operation.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#rowCountLimit-int-">rowCountLimit</a></span>(int limit)</code> |
| <div class="block">Specify the maximum number of rows per batch.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html#vectorCache-org.apache.drill.exec.physical.resultSet.ResultVectorCache-">vectorCache</a></span>(<a href="../../../../../../../org/apache/drill/exec/physical/resultSet/ResultVectorCache.html" title="interface in org.apache.drill.exec.physical.resultSet">ResultVectorCache</a> vectorCache)</code> |
| <div class="block">Downstream operators require "vector persistence": the same vector |
| must represent the same column in every batch.</div> |
| </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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="vectorSizeLimit"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>vectorSizeLimit</h4> |
| <pre>protected int vectorSizeLimit</pre> |
| </li> |
| </ul> |
| <a name="rowCountLimit"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rowCountLimit</h4> |
| <pre>protected int rowCountLimit</pre> |
| </li> |
| </ul> |
| <a name="vectorCache"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>vectorCache</h4> |
| <pre>protected <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/ResultVectorCache.html" title="interface in org.apache.drill.exec.physical.resultSet">ResultVectorCache</a> vectorCache</pre> |
| </li> |
| </ul> |
| <a name="projectionSet"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>projectionSet</h4> |
| <pre>protected <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedTuple.html" title="interface in org.apache.drill.exec.physical.resultSet.project">RequestedTuple</a> projectionSet</pre> |
| </li> |
| </ul> |
| <a name="projectionFilter"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>projectionFilter</h4> |
| <pre>protected <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ProjectionFilter.html" title="interface in org.apache.drill.exec.physical.resultSet.impl">ProjectionFilter</a> projectionFilter</pre> |
| </li> |
| </ul> |
| <a name="readerSchema"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readerSchema</h4> |
| <pre>protected <a href="../../../../../../../org/apache/drill/exec/record/metadata/TupleMetadata.html" title="interface in org.apache.drill.exec.record.metadata">TupleMetadata</a> readerSchema</pre> |
| </li> |
| </ul> |
| <a name="maxBatchSize"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxBatchSize</h4> |
| <pre>protected long maxBatchSize</pre> |
| </li> |
| </ul> |
| <a name="scanLimit"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scanLimit</h4> |
| <pre>protected long scanLimit</pre> |
| </li> |
| </ul> |
| <a name="errorContext"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>errorContext</h4> |
| <pre>protected <a href="../../../../../../../org/apache/drill/common/exceptions/CustomErrorContext.html" title="interface in org.apache.drill.common.exceptions">CustomErrorContext</a> errorContext</pre> |
| <div class="block">Error message context</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ResultSetOptionBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ResultSetOptionBuilder</h4> |
| <pre>public ResultSetOptionBuilder()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="rowCountLimit-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rowCountLimit</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a> rowCountLimit(int limit)</pre> |
| <div class="block">Specify the maximum number of rows per batch. Defaults to |
| <a href="../../../../../../../org/apache/drill/exec/vector/BaseValueVector.html#INITIAL_VALUE_ALLOCATION"><code>BaseValueVector.INITIAL_VALUE_ALLOCATION</code></a>. Batches end either |
| when this limit is reached, or when a vector overflows, whichever |
| occurs first. The limit is capped at <a href="../../../../../../../org/apache/drill/exec/vector/ValueVector.html#MAX_ROW_COUNT"><code>ValueVector.MAX_ROW_COUNT</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>limit</code> - the row count limit</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="batchSizeLimit-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>batchSizeLimit</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a> batchSizeLimit(int bytes)</pre> |
| </li> |
| </ul> |
| <a name="vectorCache-org.apache.drill.exec.physical.resultSet.ResultVectorCache-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>vectorCache</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a> vectorCache(<a href="../../../../../../../org/apache/drill/exec/physical/resultSet/ResultVectorCache.html" title="interface in org.apache.drill.exec.physical.resultSet">ResultVectorCache</a> vectorCache)</pre> |
| <div class="block">Downstream operators require "vector persistence": the same vector |
| must represent the same column in every batch. For the scan operator, |
| which creates multiple readers, this can be a challenge. The vector |
| cache provides a transparent mechanism to enable vector persistence |
| by returning the same vector for a set of independent readers. By |
| default, the code uses a "null" cache which creates a new vector on |
| each request. If a true cache is needed, the caller must provide one |
| here.</div> |
| </li> |
| </ul> |
| <a name="readerSchema-org.apache.drill.exec.record.metadata.TupleMetadata-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readerSchema</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a> readerSchema(<a href="../../../../../../../org/apache/drill/exec/record/metadata/TupleMetadata.html" title="interface in org.apache.drill.exec.record.metadata">TupleMetadata</a> readerSchema)</pre> |
| <div class="block">Clients can use the row set builder in several ways: |
| <ul> |
| <li>Provide the schema up front, when known, by using this method to |
| provide the schema.</li> |
| <li>Discover the schema on the fly, adding columns during the write |
| operation. Leave this method unset to start with an empty schema.</li> |
| <li>A combination of the above.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>readerSchema</code> - the initial schema for the loader</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="projection-org.apache.drill.exec.physical.resultSet.project.RequestedTuple-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>projection</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a> projection(<a href="../../../../../../../org/apache/drill/exec/physical/resultSet/project/RequestedTuple.html" title="interface in org.apache.drill.exec.physical.resultSet.project">RequestedTuple</a> projSet)</pre> |
| </li> |
| </ul> |
| <a name="projectionFilter-org.apache.drill.exec.physical.resultSet.impl.ProjectionFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>projectionFilter</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a> projectionFilter(<a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ProjectionFilter.html" title="interface in org.apache.drill.exec.physical.resultSet.impl">ProjectionFilter</a> projectionFilter)</pre> |
| </li> |
| </ul> |
| <a name="limit-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>limit</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a> limit(long limit)</pre> |
| </li> |
| </ul> |
| <a name="errorContext-org.apache.drill.common.exceptions.CustomErrorContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>errorContext</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetOptionBuilder</a> errorContext(<a href="../../../../../../../org/apache/drill/common/exceptions/CustomErrorContext.html" title="interface in org.apache.drill.common.exceptions">CustomErrorContext</a> context)</pre> |
| <div class="block">Provides context for error messages.</div> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultSetLoaderImpl.ResultSetOptions.html" title="class in org.apache.drill.exec.physical.resultSet.impl">ResultSetLoaderImpl.ResultSetOptions</a> build()</pre> |
| </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/ResultSetOptionBuilder.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/physical/resultSet/impl/ResultSetLoaderImpl.ResultSetOptions.html" title="class in org.apache.drill.exec.physical.resultSet.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/drill/exec/physical/resultSet/impl/ResultVectorCacheImpl.html" title="class in org.apache.drill.exec.physical.resultSet.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/drill/exec/physical/resultSet/impl/ResultSetOptionBuilder.html" target="_top">Frames</a></li> |
| <li><a href="ResultSetOptionBuilder.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
