Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / exec / record / RecordBatch.html
blob: 84a0f7ae789a8fcd92e7072683b0c3c7f35ff8a8 [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>RecordBatch (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="RecordBatch (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":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/RecordBatch.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/record/RawFragmentBatchProvider.html" title="interface in org.apache.drill.exec.record"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/record/RecordBatch.html" target="_top">Frames</a></li>
<li><a href="RecordBatch.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.record</div>
<h2 title="Interface RecordBatch" class="title">Interface RecordBatch</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a>&lt;?&gt;&gt;, <a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/drill/exec/record/CloseableRecordBatch.html" title="interface in org.apache.drill.exec.record">CloseableRecordBatch</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/drill/exec/record/AbstractBinaryRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractBinaryRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/record/AbstractRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/record/AbstractSingleRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractSingleRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/record/AbstractTableFunctionRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractTableFunctionRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/record/AbstractUnaryRecordBatch.html" title="class in org.apache.drill.exec.record">AbstractUnaryRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/xsort/ExternalSortBatch.html" title="class in org.apache.drill.exec.physical.impl.xsort">ExternalSortBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/filter/FilterRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.filter">FilterRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/flatten/FlattenRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.flatten">FlattenRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/aggregate/HashAggBatch.html" title="class in org.apache.drill.exec.physical.impl.aggregate">HashAggBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/join/HashJoinBatch.html" title="class in org.apache.drill.exec.physical.impl.join">HashJoinBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/validate/IteratorValidatorBatchIterator.html" title="class in org.apache.drill.exec.physical.impl.validate">IteratorValidatorBatchIterator</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/join/LateralJoinBatch.html" title="class in org.apache.drill.exec.physical.impl.join">LateralJoinBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/limit/LimitRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.limit">LimitRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/join/MergeJoinBatch.html" title="class in org.apache.drill.exec.physical.impl.join">MergeJoinBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/mergereceiver/MergingRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.mergereceiver">MergingRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/metadata/MetadataControllerBatch.html" title="class in org.apache.drill.exec.physical.impl.metadata">MetadataControllerBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/metadata/MetadataHandlerBatch.html" title="class in org.apache.drill.exec.physical.impl.metadata">MetadataHandlerBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/metadata/MetadataHashAggBatch.html" title="class in org.apache.drill.exec.physical.impl.metadata">MetadataHashAggBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/metadata/MetadataStreamAggBatch.html" title="class in org.apache.drill.exec.physical.impl.metadata">MetadataStreamAggBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/join/NestedLoopJoinBatch.html" title="class in org.apache.drill.exec.physical.impl.join">NestedLoopJoinBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/protocol/OperatorRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.protocol">OperatorRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/orderedpartitioner/OrderedPartitionRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.orderedpartitioner">OrderedPartitionRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/limit/PartitionLimitRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.limit">PartitionLimitRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/producer/ProducerConsumerBatch.html" title="class in org.apache.drill.exec.physical.impl.producer">ProducerConsumerBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/project/ProjectRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.project">ProjectRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/rangepartitioner/RangePartitionRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.rangepartitioner">RangePartitionRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/svremover/RemovingRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.svremover">RemovingRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/join/RowKeyJoinBatch.html" title="class in org.apache.drill.exec.physical.impl.join">RowKeyJoinBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/filter/RuntimeFilterRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.filter">RuntimeFilterRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/ScanBatch.html" title="class in org.apache.drill.exec.physical.impl">ScanBatch</a>, <a href="../../../../../org/apache/drill/exec/record/SchemalessBatch.html" title="class in org.apache.drill.exec.record">SchemalessBatch</a>, <a href="../../../../../org/apache/drill/exec/record/SimpleRecordBatch.html" title="class in org.apache.drill.exec.record">SimpleRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/sort/SortBatch.html" title="class in org.apache.drill.exec.physical.impl.sort">SortBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/aggregate/SpilledRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.aggregate">SpilledRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/statistics/StatisticsAggBatch.html" title="class in org.apache.drill.exec.physical.impl.statistics">StatisticsAggBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/statistics/StatisticsMergeBatch.html" title="class in org.apache.drill.exec.physical.impl.statistics">StatisticsMergeBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/StatisticsWriterRecordBatch.html" title="class in org.apache.drill.exec.physical.impl">StatisticsWriterRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/aggregate/StreamingAggBatch.html" title="class in org.apache.drill.exec.physical.impl.aggregate">StreamingAggBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/TopN/TopNBatch.html" title="class in org.apache.drill.exec.physical.impl.TopN">TopNBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/TopN/TopNBatch.SimpleSV4RecordBatch.html" title="class in org.apache.drill.exec.physical.impl.TopN">TopNBatch.SimpleSV4RecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/trace/TraceRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.trace">TraceRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/union/UnionAllRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.union">UnionAllRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/unnest/UnnestRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.unnest">UnnestRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/unorderedreceiver/UnorderedReceiverBatch.html" title="class in org.apache.drill.exec.physical.impl.unorderedreceiver">UnorderedReceiverBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/unpivot/UnpivotMapsRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.unpivot">UnpivotMapsRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/window/WindowFrameRecordBatch.html" title="class in org.apache.drill.exec.physical.impl.window">WindowFrameRecordBatch</a>, <a href="../../../../../org/apache/drill/exec/physical/impl/WriterRecordBatch.html" title="class in org.apache.drill.exec.physical.impl">WriterRecordBatch</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RecordBatch</span>
extends <a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></pre>
<div class="block">A record batch contains a set of field values for a particular range of
records.
<p>
In the case of a record batch composed of ValueVectors, ideally a batch
fits within L2 cache (~256kB per core). The set of value vectors does
not change except during a call to <a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#next--"><code>next()</code></a> that returns
<a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html#OK_NEW_SCHEMA"><code>RecordBatch.IterOutcome.OK_NEW_SCHEMA</code></a> value.
</p>
<p>
A key thing to know is that the Iterator provided by a record batch must
align with the rank positions of the field IDs provided using
<a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#getValueVectorId-org.apache.drill.common.expression.SchemaPath-"><code>getValueVectorId(org.apache.drill.common.expression.SchemaPath)</code></a>.
</p></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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record">RecordBatch.IterOutcome</a></span></code>
<div class="block">Describes the outcome of incrementing RecordBatch forward by a call to
<a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#next--"><code>next()</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#MAX_BATCH_ROW_COUNT">MAX_BATCH_ROW_COUNT</a></span></code>
<div class="block">max num of rows in a batch, limited by 2-byte length in SV2: 65536 = 2^16</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#cancel--">cancel</a></span>()</code>
<div class="block">Informs child operators that no more data is needed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#dump--">dump</a></span>()</code>
<div class="block">Perform dump of this batch's state to logs.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/VectorContainer.html" title="class in org.apache.drill.exec.record">VectorContainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#getContainer--">getContainer</a></span>()</code>
<div class="block">Return the internal vector container</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/ops/FragmentContext.html" title="interface in org.apache.drill.exec.ops">FragmentContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#getContext--">getContext</a></span>()</code>
<div class="block">Gets the FragmentContext of the current query fragment.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/VectorContainer.html" title="class in org.apache.drill.exec.record">VectorContainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#getOutgoingContainer--">getOutgoingContainer</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/BatchSchema.html" title="class in org.apache.drill.exec.record">BatchSchema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#getSchema--">getSchema</a></span>()</code>
<div class="block">Gets the current schema of this record batch.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a>&lt;?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#getValueAccessorById-java.lang.Class-int...-">getValueAccessorById</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;clazz,
int...&nbsp;ids)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/TypedFieldId.html" title="class in org.apache.drill.exec.record">TypedFieldId</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#getValueVectorId-org.apache.drill.common.expression.SchemaPath-">getValueVectorId</a></span>(<a href="../../../../../org/apache/drill/common/expression/SchemaPath.html" title="class in org.apache.drill.common.expression">SchemaPath</a>&nbsp;path)</code>
<div class="block">Gets the value vector type and ID for the given schema path.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/WritableBatch.html" title="class in org.apache.drill.exec.record">WritableBatch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#getWritableBatch--">getWritableBatch</a></span>()</code>
<div class="block">Gets a writable version of this batch.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record">RecordBatch.IterOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#next--">next</a></span>()</code>
<div class="block">Updates the data in each Field reading interface for the next range of
records.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.record.VectorAccessible">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.exec.record.<a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></h3>
<code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getRecordCount--">getRecordCount</a>, <a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getSelectionVector2--">getSelectionVector2</a>, <a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getSelectionVector4--">getSelectionVector4</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</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="MAX_BATCH_ROW_COUNT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAX_BATCH_ROW_COUNT</h4>
<pre>static final&nbsp;int MAX_BATCH_ROW_COUNT</pre>
<div class="block">max num of rows in a batch, limited by 2-byte length in SV2: 65536 = 2^16</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.drill.exec.record.RecordBatch.MAX_BATCH_ROW_COUNT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre><a href="../../../../../org/apache/drill/exec/ops/FragmentContext.html" title="interface in org.apache.drill.exec.ops">FragmentContext</a>&nbsp;getContext()</pre>
<div class="block">Gets the FragmentContext of the current query fragment. Useful for
reporting failure information or other query-level information.</div>
</li>
</ul>
<a name="getSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
<pre><a href="../../../../../org/apache/drill/exec/record/BatchSchema.html" title="class in org.apache.drill.exec.record">BatchSchema</a>&nbsp;getSchema()</pre>
<div class="block">Gets the current schema of this record batch.
<p>
May be called only when the most recent call to <a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#next--"><code>next()</code></a>, if any,
returned <a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html#OK_NEW_SCHEMA"><code>RecordBatch.IterOutcome.OK_NEW_SCHEMA</code></a> or <a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html#OK"><code>RecordBatch.IterOutcome.OK</code></a>.
</p>
<p>
The schema changes when and only when <a href="../../../../../org/apache/drill/exec/record/RecordBatch.html#next--"><code>next()</code></a> returns
<a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html#OK_NEW_SCHEMA"><code>RecordBatch.IterOutcome.OK_NEW_SCHEMA</code></a>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getSchema--">getSchema</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>schema of the current batch</dd>
</dl>
</li>
</ul>
<a name="cancel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>void&nbsp;cancel()</pre>
<div class="block">Informs child operators that no more data is needed. Only called
for "normal" cancellation to avoid unnecessary compute in any worker
threads. For the error case, the fragment
executor will call close() on each child automatically.
<p>
The operator which triggers the cancel MUST send a <code>NONE</code>
status downstream, or throw an exception. It is not legal to
call <code>next()</code> on an operator after calling its
<code>cancel()</code> method.</div>
</li>
</ul>
<a name="getOutgoingContainer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutgoingContainer</h4>
<pre><a href="../../../../../org/apache/drill/exec/record/VectorContainer.html" title="class in org.apache.drill.exec.record">VectorContainer</a>&nbsp;getOutgoingContainer()</pre>
</li>
</ul>
<a name="getContainer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainer</h4>
<pre><a href="../../../../../org/apache/drill/exec/record/VectorContainer.html" title="class in org.apache.drill.exec.record">VectorContainer</a>&nbsp;getContainer()</pre>
<div class="block">Return the internal vector container</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The internal vector container</dd>
</dl>
</li>
</ul>
<a name="getValueVectorId-org.apache.drill.common.expression.SchemaPath-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueVectorId</h4>
<pre><a href="../../../../../org/apache/drill/exec/record/TypedFieldId.html" title="class in org.apache.drill.exec.record">TypedFieldId</a>&nbsp;getValueVectorId(<a href="../../../../../org/apache/drill/common/expression/SchemaPath.html" title="class in org.apache.drill.common.expression">SchemaPath</a>&nbsp;path)</pre>
<div class="block">Gets the value vector type and ID for the given schema path. The
TypedFieldId should store a fieldId which is the same as the ordinal
position of the field within the Iterator provided this class's
implementation of <code>Iterable&lt;ValueVector&gt;</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getValueVectorId-org.apache.drill.common.expression.SchemaPath-">getValueVectorId</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>path</code> - The path where the vector should be located.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The local field id associated with this vector. If no field matches this path, this will return a null
TypedFieldId</dd>
</dl>
</li>
</ul>
<a name="getValueAccessorById-java.lang.Class-int...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueAccessorById</h4>
<pre><a href="../../../../../org/apache/drill/exec/record/VectorWrapper.html" title="interface in org.apache.drill.exec.record">VectorWrapper</a>&lt;?&gt;&nbsp;getValueAccessorById(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;clazz,
int...&nbsp;ids)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html#getValueAccessorById-java.lang.Class-int...-">getValueAccessorById</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/drill/exec/record/VectorAccessible.html" title="interface in org.apache.drill.exec.record">VectorAccessible</a></code></dd>
</dl>
</li>
</ul>
<a name="next--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre><a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record">RecordBatch.IterOutcome</a>&nbsp;next()</pre>
<div class="block">Updates the data in each Field reading interface for the next range of
records.
<p>
Once a RecordBatch's <code>next()</code> has returned <a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html#NONE"><code>RecordBatch.IterOutcome.NONE</code></a>
or <code>IterOutcome#STOP</code>, the consumer should no longer call
<code>next()</code>. Behavior at this point is undefined and likely to
throw an exception.
</p>
<p>
See <a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record"><code>RecordBatch.IterOutcome</code></a> for the protocol (possible sequences of return
values).
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An IterOutcome describing the result of the iteration.</dd>
</dl>
</li>
</ul>
<a name="getWritableBatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWritableBatch</h4>
<pre><a href="../../../../../org/apache/drill/exec/record/WritableBatch.html" title="class in org.apache.drill.exec.record">WritableBatch</a>&nbsp;getWritableBatch()</pre>
<div class="block">Gets a writable version of this batch. Takes over ownership of existing
buffers.</div>
</li>
</ul>
<a name="dump--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dump</h4>
<pre>void&nbsp;dump()</pre>
<div class="block">Perform dump of this batch's state to logs.</div>
</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/RecordBatch.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/record/RawFragmentBatchProvider.html" title="interface in org.apache.drill.exec.record"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/drill/exec/record/RecordBatch.IterOutcome.html" title="enum in org.apache.drill.exec.record"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/record/RecordBatch.html" target="_top">Frames</a></li>
<li><a href="RecordBatch.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>