org.bytedeco.arrow

Class RecordBatchStreamReader

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.RecordBatchReader

org.bytedeco.arrow.RecordBatchStreamReader

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::ipc")
 @Properties(inherit=arrow.class)
public class RecordBatchStreamReader
extends RecordBatchReader

\brief Synchronous batch stream reader that reads from io::InputStream This class reads the schema (plus any dictionaries) as the first messages in the stream, followed by record batches. For more granular zero-copy reads see the ReadRecordBatch functions

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
RecordBatchStreamReader(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static RecordBatchStreamReaderResult	Open(InputStream stream)
static RecordBatchStreamReaderResult	Open(InputStream stream, IpcReadOptions options) \brief Record batch stream reader from InputStream
static RecordBatchStreamReaderResult	Open(MessageReader message_reader)
static RecordBatchStreamReaderResult	Open(MessageReader message_reader, IpcReadOptions options) Create batch reader from generic MessageReader.
ReadStats	stats() \brief Return current read statistics

Methods inherited from class org.bytedeco.arrow.RecordBatchReader

Make, Make, Next, ReadAll, ReadAll, ReadNext, schema

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordBatchStreamReader

public RecordBatchStreamReader(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Open

@ByVal
public static RecordBatchStreamReaderResult Open(@UniquePtr
                                                        MessageReader message_reader,
                                                        @Const @ByRef(nullValue="arrow::ipc::IpcReadOptions::Defaults()")
                                                        IpcReadOptions options)

Create batch reader from generic MessageReader. This will take ownership of the given MessageReader.

Parameters:

message_reader - [in] a MessageReader implementation

options - [in] any IPC reading options (optional)

Returns:

the created batch reader

Open

@ByVal
public static RecordBatchStreamReaderResult Open(@UniquePtr
                                                        MessageReader message_reader)

Open

@ByVal
public static RecordBatchStreamReaderResult Open(InputStream stream,
                                                        @Const @ByRef(nullValue="arrow::ipc::IpcReadOptions::Defaults()")
                                                        IpcReadOptions options)

\brief Record batch stream reader from InputStream

Parameters:

stream - [in] an input stream instance. Must stay alive throughout lifetime of stream reader

options - [in] any IPC reading options (optional)

Returns:

the created batch reader

Open

@ByVal
public static RecordBatchStreamReaderResult Open(InputStream stream)

stats

@ByVal
public ReadStats stats()

\brief Return current read statistics