blob: eaaa976fc37d83b4fd44782c8340f923fda16ab9 [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>RecordBatchSizerManager (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="RecordBatchSizerManager (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,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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/RecordBatchSizerManager.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/store/parquet/columnreaders/batchsizing/RecordBatchOverflow.RecordOverflowDefinition.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.ColumnMemoryQuota.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html" target="_top">Frames</a></li>
<li><a href="RecordBatchSizerManager.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.store.parquet.columnreaders.batchsizing</div>
<h2 title="Class RecordBatchSizerManager" class="title">Class RecordBatchSizerManager</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.store.parquet.columnreaders.batchsizing.RecordBatchSizerManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">RecordBatchSizerManager</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">This class is tasked with managing all aspects of flat Parquet reader record batch sizing logic.
Currently a record batch size is constrained with two parameters: Number of rows and Memory usage.</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">Class 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/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.ColumnMemoryQuota.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.ColumnMemoryQuota</a></span></code>
<div class="block">Field memory quota</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.FieldOverflowState.html" title="interface in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.FieldOverflowState</a></span></code>
<div class="block">An abstraction to allow column readers attach custom field overflow state</div>
</td>
</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/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.FieldOverflowStateContainer.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.FieldOverflowStateContainer</a></span></code>
<div class="block">Container object to hold current field overflow state</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.VarLenColumnBatchStats.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.VarLenColumnBatchStats</a></span></code>
<div class="block">Container object to supply variable columns statistics to the batch sizer</div>
</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">&nbsp;</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/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#RecordBatchSizerManager-org.apache.drill.exec.server.options.OptionManager-org.apache.drill.exec.store.parquet.columnreaders.ParquetSchema-long-org.apache.drill.exec.util.record.RecordBatchStats.RecordBatchStatsContext-">RecordBatchSizerManager</a></span>(<a href="../../../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a>&nbsp;options,
<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/ParquetSchema.html" title="class in org.apache.drill.exec.store.parquet.columnreaders">ParquetSchema</a>&nbsp;schema,
long&nbsp;totalRecordsToRead,
<a href="../../../../../../../../org/apache/drill/exec/util/record/RecordBatchStats.RecordBatchStatsContext.html" title="class in org.apache.drill.exec.util.record">RecordBatchStats.RecordBatchStatsContext</a>&nbsp;batchStatsContext)</code>
<div class="block">Constructor.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#allocate-java.util.Map-">allocate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>&gt;&nbsp;vectorMap)</code>
<div class="block">Allocates value vectors for the current batch.</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/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#close--">close</a></span>()</code>
<div class="block">Closes all resources managed by this object</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/drill/exec/util/record/RecordBatchStats.RecordBatchStatsContext.html" title="class in org.apache.drill.exec.util.record">RecordBatchStats.RecordBatchStatsContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getBatchStatsContext--">getBatchStatsContext</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getConfigMemorySizePerBatch--">getConfigMemorySizePerBatch</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getConfigRecordsPerBatch--">getConfigRecordsPerBatch</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.ColumnMemoryQuota.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.ColumnMemoryQuota</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getCurrentFieldBatchMemory-java.lang.String-">getCurrentFieldBatchMemory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;field)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getCurrentMemorySizePerBatch--">getCurrentMemorySizePerBatch</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getCurrentRecordsPerBatch--">getCurrentRecordsPerBatch</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.FieldOverflowStateContainer.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.FieldOverflowStateContainer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getFieldOverflowContainer-java.lang.String-">getFieldOverflowContainer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;field)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.FieldOverflowStateContainer.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.FieldOverflowStateContainer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getFieldOverflowMap--">getFieldOverflowMap</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/ParquetSchema.html" title="class in org.apache.drill.exec.store.parquet.columnreaders">ParquetSchema</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#getSchema--">getSchema</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#onEndOfBatch-int-java.util.List-">onEndOfBatch</a></span>(int&nbsp;batchNumRecords,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.VarLenColumnBatchStats.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.VarLenColumnBatchStats</a>&gt;&nbsp;batchStats)</code>
<div class="block">Enables this object to optimize the impact of overflows by computing more
accurate VL column precision.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#releaseFieldOverflowContainer-java.lang.String-">releaseFieldOverflowContainer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;field)</code>
<div class="block">Releases the overflow data resources associated with this field; also removes the overflow
container from the overflow containers map.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html#setup--">setup</a></span>()</code>
<div class="block">Tunes record batch parameters based on configuration and schema.</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&nbsp;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="RecordBatchSizerManager-org.apache.drill.exec.server.options.OptionManager-org.apache.drill.exec.store.parquet.columnreaders.ParquetSchema-long-org.apache.drill.exec.util.record.RecordBatchStats.RecordBatchStatsContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RecordBatchSizerManager</h4>
<pre>public&nbsp;RecordBatchSizerManager(<a href="../../../../../../../../org/apache/drill/exec/server/options/OptionManager.html" title="interface in org.apache.drill.exec.server.options">OptionManager</a>&nbsp;options,
<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/ParquetSchema.html" title="class in org.apache.drill.exec.store.parquet.columnreaders">ParquetSchema</a>&nbsp;schema,
long&nbsp;totalRecordsToRead,
<a href="../../../../../../../../org/apache/drill/exec/util/record/RecordBatchStats.RecordBatchStatsContext.html" title="class in org.apache.drill.exec.util.record">RecordBatchStats.RecordBatchStatsContext</a>&nbsp;batchStatsContext)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>options</code> - drill options</dd>
<dd><code>schema</code> - current reader schema</dd>
<dd><code>totalRecordsToRead</code> - total number of rows to read</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="setup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setup</h4>
<pre>public&nbsp;void&nbsp;setup()</pre>
<div class="block">Tunes record batch parameters based on configuration and schema.</div>
</li>
</ul>
<a name="getSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
<pre>public&nbsp;<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/ParquetSchema.html" title="class in org.apache.drill.exec.store.parquet.columnreaders">ParquetSchema</a>&nbsp;getSchema()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the schema</dd>
</dl>
</li>
</ul>
<a name="getBatchStatsContext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatchStatsContext</h4>
<pre>public&nbsp;<a href="../../../../../../../../org/apache/drill/exec/util/record/RecordBatchStats.RecordBatchStatsContext.html" title="class in org.apache.drill.exec.util.record">RecordBatchStats.RecordBatchStatsContext</a>&nbsp;getBatchStatsContext()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>batch statistics context</dd>
</dl>
</li>
</ul>
<a name="allocate-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocate</h4>
<pre>public&nbsp;void&nbsp;allocate(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../../../org/apache/drill/exec/vector/ValueVector.html" title="interface in org.apache.drill.exec.vector">ValueVector</a>&gt;&nbsp;vectorMap)
throws <a href="../../../../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<div class="block">Allocates value vectors for the current batch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vectorMap</code> - a collection of value vectors keyed by their field names</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="getFieldOverflowMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldOverflowMap</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.FieldOverflowStateContainer.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.FieldOverflowStateContainer</a>&gt;&nbsp;getFieldOverflowMap()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the field overflow state map</dd>
</dl>
</li>
</ul>
<a name="getFieldOverflowContainer-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldOverflowContainer</h4>
<pre>public&nbsp;<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.FieldOverflowStateContainer.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.FieldOverflowStateContainer</a>&nbsp;getFieldOverflowContainer(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;field)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>field</code> - materialized field</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>field overflow state container</dd>
</dl>
</li>
</ul>
<a name="releaseFieldOverflowContainer-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>releaseFieldOverflowContainer</h4>
<pre>public&nbsp;boolean&nbsp;releaseFieldOverflowContainer(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;field)</pre>
<div class="block">Releases the overflow data resources associated with this field; also removes the overflow
container from the overflow containers map.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>field</code> - materialized field</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this field's overflow container was removed from the overflow containers map</dd>
</dl>
</li>
</ul>
<a name="getCurrentFieldBatchMemory-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentFieldBatchMemory</h4>
<pre>public&nbsp;<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.ColumnMemoryQuota.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.ColumnMemoryQuota</a>&nbsp;getCurrentFieldBatchMemory(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;field)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>field</code> - materialized field</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>field batch memory quota</dd>
</dl>
</li>
</ul>
<a name="getCurrentRecordsPerBatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentRecordsPerBatch</h4>
<pre>public&nbsp;int&nbsp;getCurrentRecordsPerBatch()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current number of records per batch (may change across batches)</dd>
</dl>
</li>
</ul>
<a name="getCurrentMemorySizePerBatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentMemorySizePerBatch</h4>
<pre>public&nbsp;long&nbsp;getCurrentMemorySizePerBatch()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current total memory per batch (may change across batches)</dd>
</dl>
</li>
</ul>
<a name="getConfigRecordsPerBatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigRecordsPerBatch</h4>
<pre>public&nbsp;int&nbsp;getConfigRecordsPerBatch()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured number of records per batch (may be different from the enforced one)</dd>
</dl>
</li>
</ul>
<a name="getConfigMemorySizePerBatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigMemorySizePerBatch</h4>
<pre>public&nbsp;long&nbsp;getConfigMemorySizePerBatch()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured memory size per batch (may be different from the enforced one)</dd>
</dl>
</li>
</ul>
<a name="onEndOfBatch-int-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onEndOfBatch</h4>
<pre>public&nbsp;void&nbsp;onEndOfBatch(int&nbsp;batchNumRecords,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.VarLenColumnBatchStats.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing">RecordBatchSizerManager.VarLenColumnBatchStats</a>&gt;&nbsp;batchStats)</pre>
<div class="block">Enables this object to optimize the impact of overflows by computing more
accurate VL column precision.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>batchNumRecords</code> - number of records in this batch</dd>
<dd><code>batchStats</code> - columns statistics</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block">Closes all resources managed by this object</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/RecordBatchSizerManager.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/store/parquet/columnreaders/batchsizing/RecordBatchOverflow.RecordOverflowDefinition.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.ColumnMemoryQuota.html" title="class in org.apache.drill.exec.store.parquet.columnreaders.batchsizing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/drill/exec/store/parquet/columnreaders/batchsizing/RecordBatchSizerManager.html" target="_top">Frames</a></li>
<li><a href="RecordBatchSizerManager.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>