org.apache.arrow.vector.ipc

Class ArrowStreamWriter

java.lang.Object

org.apache.arrow.vector.ipc.ArrowWriter

org.apache.arrow.vector.ipc.ArrowStreamWriter

All Implemented Interfaces:

AutoCloseable

public class ArrowStreamWriter
extends ArrowWriter

Writer for the Arrow stream format to send ArrowRecordBatches over a WriteChannel.

Field Summary

Fields inherited from class org.apache.arrow.vector.ipc.ArrowWriter

LOGGER, out, schema

Constructor Summary

Constructors

Constructor and Description
ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, OutputStream out) Construct an ArrowStreamWriter with an optional DictionaryProvider for the OutputStream.
ArrowStreamWriter(VectorSchemaRoot root, DictionaryProvider provider, WritableByteChannel out) Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.

Method Summary

Modifier and Type	Method and Description
protected void	endInternal(WriteChannel out)
static void	writeEndOfStream(WriteChannel out) Write an EOS identifier to the WriteChannel.

Methods inherited from class org.apache.arrow.vector.ipc.ArrowWriter

bytesWritten, close, end, start, startInternal, writeBatch, writeDictionaryBatch, writeRecordBatch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArrowStreamWriter

public ArrowStreamWriter(VectorSchemaRoot root,
                         DictionaryProvider provider,
                         OutputStream out)

Construct an ArrowStreamWriter with an optional DictionaryProvider for the OutputStream.

Parameters:

root - Existing VectorSchemaRoot with vectors to be written.

provider - DictionaryProvider for any vectors that are dictionary encoded. (Optional, can be null)

out - OutputStream for writing.

ArrowStreamWriter

public ArrowStreamWriter(VectorSchemaRoot root,
                         DictionaryProvider provider,
                         WritableByteChannel out)

Construct an ArrowStreamWriter with an optional DictionaryProvider for the WritableByteChannel.

Parameters:

root - Existing VectorSchemaRoot with vectors to be written.

provider - DictionaryProvider for any vectors that are dictionary encoded. (Optional, can be null)

out - WritableByteChannel for writing.

Method Detail

writeEndOfStream

public static void writeEndOfStream(WriteChannel out)
                             throws IOException

Write an EOS identifier to the WriteChannel.

Parameters:

out - Open WriteChannel with an active Arrow stream.

Throws:

IOException - on error

endInternal

protected void endInternal(WriteChannel out)
                    throws IOException

Overrides:

endInternal in class ArrowWriter

Throws:

IOException