| <!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 --> |
| <title>ArrowReader</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="ArrowReader"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":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="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>Prev Class</li> |
| <li><a href="../../../../../org/apache/iceberg/arrow/vectorized/ArrowVectorAccessor.html" title="class in org.apache.iceberg.arrow.vectorized"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/iceberg/arrow/vectorized/ArrowReader.html" target="_top">Frames</a></li> |
| <li><a href="ArrowReader.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>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg.arrow.vectorized</div> |
| <h2 title="Class ArrowReader" class="title">Class ArrowReader</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/iceberg/io/CloseableGroup.html" title="class in org.apache.iceberg.io">org.apache.iceberg.io.CloseableGroup</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.arrow.vectorized.ArrowReader</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Closeable, java.lang.AutoCloseable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ArrowReader</span> |
| extends <a href="../../../../../org/apache/iceberg/io/CloseableGroup.html" title="class in org.apache.iceberg.io">CloseableGroup</a></pre> |
| <div class="block">Vectorized reader that returns an iterator of <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a>. |
| See <a href="../../../../../org/apache/iceberg/arrow/vectorized/ArrowReader.html#open-org.apache.iceberg.io.CloseableIterable-"><code>open(CloseableIterable)</code></a> ()} to learn about the |
| behavior of the iterator. |
| |
| <p>The following Iceberg data types are supported and have been tested: |
| <ul> |
| <li>Iceberg: <code>Types.BooleanType</code>, Arrow: <code>Types.MinorType.BIT</code></li> |
| <li>Iceberg: <code>Types.IntegerType</code>, Arrow: <code>Types.MinorType.INT</code></li> |
| <li>Iceberg: <code>Types.LongType</code>, Arrow: <code>Types.MinorType.BIGINT</code></li> |
| <li>Iceberg: <code>Types.FloatType</code>, Arrow: <code>Types.MinorType.FLOAT4</code></li> |
| <li>Iceberg: <code>Types.DoubleType</code>, Arrow: <code>Types.MinorType.FLOAT8</code></li> |
| <li>Iceberg: <code>Types.StringType</code>, Arrow: <code>Types.MinorType.VARCHAR</code></li> |
| <li>Iceberg: <code>Types.TimestampType</code> (both with and without timezone), |
| Arrow: <code>Types.MinorType.TIMEMICRO</code></li> |
| <li>Iceberg: <code>Types.BinaryType</code>, Arrow: <code>Types.MinorType.VARBINARY</code></li> |
| <li>Iceberg: <code>Types.DateType</code>, Arrow: <code>Types.MinorType.DATEDAY</code></li> |
| <li>Iceberg: <code>Types.TimeType</code>, Arrow: <code>Types.MinorType.TIMEMICRO</code></li> |
| <li>Iceberg: <code>Types.UUIDType</code>, Arrow: <code>Types.MinorType.FIXEDSIZEBINARY</code>(16)</li> |
| </ul> |
| |
| <p>Features that don't work in this implementation: |
| <ul> |
| <li>Type promotion: In case of type promotion, the Arrow vector corresponding to |
| the data type in the parquet file is returned instead of the data type in the latest schema. |
| See https://github.com/apache/iceberg/issues/2483.</li> |
| <li>Columns with constant values are physically encoded as a dictionary. The Arrow vector |
| type is int32 instead of the type as per the schema. |
| See https://github.com/apache/iceberg/issues/2484.</li> |
| <li>Data types: <code>Types.ListType</code>, <code>Types.MapType</code>, |
| <code>Types.StructType</code>, <code>Types.FixedType</code> and |
| <code>Types.DecimalType</code> |
| See https://github.com/apache/iceberg/issues/2485 and https://github.com/apache/iceberg/issues/2486.</li> |
| <li>Delete files are not supported. |
| See https://github.com/apache/iceberg/issues/2487.</li> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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/iceberg/arrow/vectorized/ArrowReader.html#ArrowReader-org.apache.iceberg.TableScan-int-boolean-">ArrowReader</a></span>(<a href="../../../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a> scan, |
| int batchSize, |
| boolean reuseContainers)</code> |
| <div class="block">Create a new instance of the reader.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/arrow/vectorized/ArrowReader.html#close--">close</a></span>()</code> |
| <div class="block">Close all the registered resources.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/iceberg/io/CloseableIterator.html" title="interface in org.apache.iceberg.io">CloseableIterator</a><<a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized">ColumnarBatch</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/arrow/vectorized/ArrowReader.html#open-org.apache.iceberg.io.CloseableIterable-">open</a></span>(<a href="../../../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a><<a href="../../../../../org/apache/iceberg/CombinedScanTask.html" title="interface in org.apache.iceberg">CombinedScanTask</a>> tasks)</code> |
| <div class="block">Returns a new iterator of <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> objects.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.io.CloseableGroup"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.iceberg.io.<a href="../../../../../org/apache/iceberg/io/CloseableGroup.html" title="class in org.apache.iceberg.io">CloseableGroup</a></h3> |
| <code><a href="../../../../../org/apache/iceberg/io/CloseableGroup.html#addCloseable-java.lang.AutoCloseable-">addCloseable</a>, <a href="../../../../../org/apache/iceberg/io/CloseableGroup.html#addCloseable-java.io.Closeable-">addCloseable</a>, <a href="../../../../../org/apache/iceberg/io/CloseableGroup.html#setSuppressCloseFailure-boolean-">setSuppressCloseFailure</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="ArrowReader-org.apache.iceberg.TableScan-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ArrowReader</h4> |
| <pre>public ArrowReader(<a href="../../../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a> scan, |
| int batchSize, |
| boolean reuseContainers)</pre> |
| <div class="block">Create a new instance of the reader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scan</code> - the table scan object.</dd> |
| <dd><code>batchSize</code> - the maximum number of rows per Arrow batch.</dd> |
| <dd><code>reuseContainers</code> - whether to reuse Arrow vectors when iterating through the data. |
| If set to <code>false</code>, every <code>Iterator.next()</code> call creates |
| new instances of Arrow vectors. |
| If set to <code>true</code>, the Arrow vectors in the previous |
| <code>Iterator.next()</code> may be reused for the data returned |
| in the current <code>Iterator.next()</code>. |
| This option avoids allocating memory again and again. |
| Irrespective of the value of <code>reuseContainers</code>, the Arrow vectors |
| in the previous <code>Iterator.next()</code> call are closed before creating |
| new instances if the current <code>Iterator.next()</code>.</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="open-org.apache.iceberg.io.CloseableIterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre>public <a href="../../../../../org/apache/iceberg/io/CloseableIterator.html" title="interface in org.apache.iceberg.io">CloseableIterator</a><<a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized">ColumnarBatch</a>> open(<a href="../../../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a><<a href="../../../../../org/apache/iceberg/CombinedScanTask.html" title="interface in org.apache.iceberg">CombinedScanTask</a>> tasks)</pre> |
| <div class="block">Returns a new iterator of <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> objects. |
| <p> |
| Note that the reader owns the <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> objects and takes care of closing them. |
| The caller should not hold onto a <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> or try to close them. |
| |
| <p>If <code>reuseContainers</code> is <code>false</code>, the Arrow vectors in the |
| previous <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> are closed before returning the next <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> object. |
| This implies that the caller should either use the <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> or transfer the ownership of |
| <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> before getting the next <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a>. |
| |
| <p>If <code>reuseContainers</code> is <code>true</code>, the Arrow vectors in the |
| previous <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> may be reused for the next <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a>. |
| This implies that the caller should either use the <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> or deep copy the |
| <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a> before getting the next <a href="../../../../../org/apache/iceberg/arrow/vectorized/ColumnarBatch.html" title="class in org.apache.iceberg.arrow.vectorized"><code>ColumnarBatch</code></a>. |
| <p> |
| This method works for only when the following conditions are true: |
| <ol> |
| <li>At least one column is queried,</li> |
| <li>There are no delete files, and</li> |
| <li>Supported data types are queried (see <a href="../../../../../org/apache/iceberg/arrow/vectorized/ArrowReader.html#SUPPORTED_TYPES"><code>SUPPORTED_TYPES</code></a>).</li> |
| </ol> |
| When any of these conditions fail, an <code>UnsupportedOperationException</code> is thrown.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/iceberg/io/CloseableGroup.html#close--">CloseableGroup</a></code></span></div> |
| <div class="block">Close all the registered resources. Close method of each resource will only be called once. |
| Checked exception from AutoCloseable will be wrapped to runtime exception.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.io.Closeable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/iceberg/io/CloseableGroup.html#close--">close</a></code> in class <code><a href="../../../../../org/apache/iceberg/io/CloseableGroup.html" title="class in org.apache.iceberg.io">CloseableGroup</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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>Prev Class</li> |
| <li><a href="../../../../../org/apache/iceberg/arrow/vectorized/ArrowVectorAccessor.html" title="class in org.apache.iceberg.arrow.vectorized"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/iceberg/arrow/vectorized/ArrowReader.html" target="_top">Frames</a></li> |
| <li><a href="ArrowReader.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>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
