| <!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>ArrowStreamWriter (Apache Arrow Java Root POM 17.0.0-SNAPSHOT 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="ArrowStreamWriter (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ArrowStreamWriter.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/arrow/vector/ipc/ArrowStreamReader.html" title="class in org.apache.arrow.vector.ipc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/vector/ipc/ArrowStreamWriter.html" target="_top">Frames</a></li> |
| <li><a href="ArrowStreamWriter.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="#fields.inherited.from.class.org.apache.arrow.vector.ipc.ArrowWriter">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>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.arrow.vector.ipc</div> |
| <h2 title="Class ArrowStreamWriter" class="title">Class ArrowStreamWriter</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><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc">org.apache.arrow.vector.ipc.ArrowWriter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.arrow.vector.ipc.ArrowStreamWriter</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ArrowStreamWriter</span> |
| extends <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc">ArrowWriter</a></pre> |
| <div class="block">Writer for the Arrow stream format to send ArrowRecordBatches over a WriteChannel.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.arrow.vector.ipc.ArrowWriter"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.arrow.vector.ipc.<a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc">ArrowWriter</a></h3> |
| <code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#LOGGER">LOGGER</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#option">option</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#out">out</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#schema">schema</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.io.OutputStream-">ArrowStreamWriter</a></span>(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out)</code> |
| <div class="block">Construct an ArrowStreamWriter with an optional DictionaryProvider for the OutputStream.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-">ArrowStreamWriter</a></span>(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a> out)</code> |
| <div class="block">Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-">ArrowStreamWriter</a></span>(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a> out, |
| <a href="../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> option)</code> |
| <div class="block">Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-">ArrowStreamWriter</a></span>(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a> out, |
| <a href="../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> option, |
| <a href="../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a> compressionFactory, |
| <a href="../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a> codecType)</code> |
| <div class="block">Construct an ArrowStreamWriter with compression enabled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-java.util.Optional-">ArrowStreamWriter</a></span>(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a> out, |
| <a href="../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> option, |
| <a href="../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a> compressionFactory, |
| <a href="../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a> codecType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> compressionLevel)</code> |
| <div class="block">Construct an ArrowStreamWriter with compression enabled.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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/arrow/vector/ipc/ArrowStreamWriter.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#endInternal-org.apache.arrow.vector.ipc.WriteChannel-">endInternal</a></span>(<a href="../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a> out)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#ensureDictionariesWritten-org.apache.arrow.vector.dictionary.DictionaryProvider-java.util.Set-">ensureDictionariesWritten</a></span>(<a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> dictionaryIdsUsed)</code> |
| <div class="block">Write dictionaries after schema and before recordBatches, dictionaries won't be |
| written if empty stream (only has schema data in IPC).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/vector/ipc/ArrowStreamWriter.html#writeEndOfStream-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.IpcOption-">writeEndOfStream</a></span>(<a href="../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a> out, |
| <a href="../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> option)</code> |
| <div class="block">Write an EOS identifier to the WriteChannel.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.ipc.ArrowWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.arrow.vector.ipc.<a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc">ArrowWriter</a></h3> |
| <code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#bytesWritten--">bytesWritten</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#end--">end</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#start--">start</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#startInternal-org.apache.arrow.vector.ipc.WriteChannel-">startInternal</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#writeBatch--">writeBatch</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#writeDictionaryBatch-org.apache.arrow.vector.ipc.message.ArrowDictionaryBatch-">writeDictionaryBatch</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#writeDictionaryBatch-org.apache.arrow.vector.dictionary.Dictionary-">writeDictionaryBatch</a>, <a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#writeRecordBatch-org.apache.arrow.vector.ipc.message.ArrowRecordBatch-">writeRecordBatch</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.<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="ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.io.OutputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ArrowStreamWriter</h4> |
| <pre>public ArrowStreamWriter(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out)</pre> |
| <div class="block">Construct an ArrowStreamWriter with an optional DictionaryProvider for the OutputStream.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - Existing VectorSchemaRoot with vectors to be written.</dd> |
| <dd><code>provider</code> - DictionaryProvider for any vectors that are dictionary encoded. |
| (Optional, can be null)</dd> |
| <dd><code>out</code> - OutputStream for writing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ArrowStreamWriter</h4> |
| <pre>public ArrowStreamWriter(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a> out)</pre> |
| <div class="block">Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.</div> |
| </li> |
| </ul> |
| <a name="ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ArrowStreamWriter</h4> |
| <pre>public ArrowStreamWriter(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a> out, |
| <a href="../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> option)</pre> |
| <div class="block">Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - Existing VectorSchemaRoot with vectors to be written.</dd> |
| <dd><code>provider</code> - DictionaryProvider for any vectors that are dictionary encoded. |
| (Optional, can be null)</dd> |
| <dd><code>option</code> - IPC write options</dd> |
| <dd><code>out</code> - WritableByteChannel for writing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ArrowStreamWriter</h4> |
| <pre>public ArrowStreamWriter(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a> out, |
| <a href="../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> option, |
| <a href="../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a> compressionFactory, |
| <a href="../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a> codecType)</pre> |
| <div class="block">Construct an ArrowStreamWriter with compression enabled.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - Existing VectorSchemaRoot with vectors to be written.</dd> |
| <dd><code>provider</code> - DictionaryProvider for any vectors that are dictionary encoded. |
| (Optional, can be null)</dd> |
| <dd><code>option</code> - IPC write options</dd> |
| <dd><code>compressionFactory</code> - Compression codec factory</dd> |
| <dd><code>codecType</code> - Codec type</dd> |
| <dd><code>out</code> - WritableByteChannel for writing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ArrowStreamWriter-org.apache.arrow.vector.VectorSchemaRoot-org.apache.arrow.vector.dictionary.DictionaryProvider-java.nio.channels.WritableByteChannel-org.apache.arrow.vector.ipc.message.IpcOption-org.apache.arrow.vector.compression.CompressionCodec.Factory-org.apache.arrow.vector.compression.CompressionUtil.CodecType-java.util.Optional-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ArrowStreamWriter</h4> |
| <pre>public ArrowStreamWriter(<a href="../../../../../org/apache/arrow/vector/VectorSchemaRoot.html" title="class in org.apache.arrow.vector">VectorSchemaRoot</a> root, |
| <a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html?is-external=true" title="class or interface in java.nio.channels">WritableByteChannel</a> out, |
| <a href="../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> option, |
| <a href="../../../../../org/apache/arrow/vector/compression/CompressionCodec.Factory.html" title="interface in org.apache.arrow.vector.compression">CompressionCodec.Factory</a> compressionFactory, |
| <a href="../../../../../org/apache/arrow/vector/compression/CompressionUtil.CodecType.html" title="enum in org.apache.arrow.vector.compression">CompressionUtil.CodecType</a> codecType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> compressionLevel)</pre> |
| <div class="block">Construct an ArrowStreamWriter with compression enabled.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>root</code> - Existing VectorSchemaRoot with vectors to be written.</dd> |
| <dd><code>provider</code> - DictionaryProvider for any vectors that are dictionary encoded. |
| (Optional, can be null)</dd> |
| <dd><code>option</code> - IPC write options</dd> |
| <dd><code>compressionFactory</code> - Compression codec factory</dd> |
| <dd><code>codecType</code> - Codec type</dd> |
| <dd><code>compressionLevel</code> - Compression level</dd> |
| <dd><code>out</code> - WritableByteChannel for writing.</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="writeEndOfStream-org.apache.arrow.vector.ipc.WriteChannel-org.apache.arrow.vector.ipc.message.IpcOption-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeEndOfStream</h4> |
| <pre>public static void writeEndOfStream(<a href="../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a> out, |
| <a href="../../../../../org/apache/arrow/vector/ipc/message/IpcOption.html" title="class in org.apache.arrow.vector.ipc.message">IpcOption</a> option) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Write an EOS identifier to the WriteChannel.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - Open WriteChannel with an active Arrow stream.</dd> |
| <dd><code>option</code> - IPC write option</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endInternal-org.apache.arrow.vector.ipc.WriteChannel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endInternal</h4> |
| <pre>protected void endInternal(<a href="../../../../../org/apache/arrow/vector/ipc/WriteChannel.html" title="class in org.apache.arrow.vector.ipc">WriteChannel</a> out) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#endInternal-org.apache.arrow.vector.ipc.WriteChannel-">endInternal</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc">ArrowWriter</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ensureDictionariesWritten-org.apache.arrow.vector.dictionary.DictionaryProvider-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ensureDictionariesWritten</h4> |
| <pre>protected void ensureDictionariesWritten(<a href="../../../../../org/apache/arrow/vector/dictionary/DictionaryProvider.html" title="interface in org.apache.arrow.vector.dictionary">DictionaryProvider</a> provider, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> dictionaryIdsUsed) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#ensureDictionariesWritten-org.apache.arrow.vector.dictionary.DictionaryProvider-java.util.Set-">ArrowWriter</a></code></span></div> |
| <div class="block">Write dictionaries after schema and before recordBatches, dictionaries won't be |
| written if empty stream (only has schema data in IPC).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#ensureDictionariesWritten-org.apache.arrow.vector.dictionary.DictionaryProvider-java.util.Set-">ensureDictionariesWritten</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc">ArrowWriter</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html#close--">close</a></code> in class <code><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc">ArrowWriter</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ArrowStreamWriter.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/arrow/vector/ipc/ArrowStreamReader.html" title="class in org.apache.arrow.vector.ipc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/arrow/vector/ipc/ArrowWriter.html" title="class in org.apache.arrow.vector.ipc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/arrow/vector/ipc/ArrowStreamWriter.html" target="_top">Frames</a></li> |
| <li><a href="ArrowStreamWriter.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="#fields.inherited.from.class.org.apache.arrow.vector.ipc.ArrowWriter">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>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
