org.bytedeco.arrow

Class RecordBatchReader

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.RecordBatchReader

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

RecordBatchStreamReader, StreamingReader, TableBatchReader

@Namespace(value="arrow")
 @Properties(inherit=arrow.class)
public class RecordBatchReader
extends Pointer

\brief Abstract interface for reading stream of record batches

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
RecordBatchReader(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static RecordBatchReaderSharedResult	Make(RecordBatchVector batches)
static RecordBatchReaderSharedResult	Make(RecordBatchVector batches, Schema schema) \brief Create a RecordBatchReader from a vector of RecordBatch.
RecordBatchResult	Next() \brief Iterator interface
Status	ReadAll(RecordBatchVector batches) \brief Consume entire stream as a vector of record batches
Status	ReadAll(Table table) \brief Read all batches and concatenate as arrow::Table
Status	ReadNext(RecordBatch batch) \brief Read the next record batch in the stream.
Schema	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, 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

RecordBatchReader

public RecordBatchReader(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

schema

@SharedPtr
 @ByVal
public Schema schema()

Returns:

the shared schema of the record batches in the stream

ReadNext

@ByVal
public Status ReadNext(@SharedPtr
                               RecordBatch batch)

\brief Read the next record batch in the stream. Return null for batch when reaching end of stream

Parameters:

batch - [out] the next loaded batch, null at end of stream

Returns:

Status

Next

@ByVal
public RecordBatchResult Next()

\brief Iterator interface

ReadAll

@ByVal
public Status ReadAll(RecordBatchVector batches)

\brief Consume entire stream as a vector of record batches

ReadAll

@ByVal
public Status ReadAll(@SharedPtr
                              Table table)

\brief Read all batches and concatenate as arrow::Table

Make

@ByVal
public static RecordBatchReaderSharedResult Make(@ByVal
                                                         RecordBatchVector batches,
                                                         @SharedPtr @ByVal(nullValue="std::shared_ptr<arrow::Schema>(nullptr)")
                                                         Schema schema)

\brief Create a RecordBatchReader from a vector of RecordBatch.

Parameters:

batches - [in] the vector of RecordBatch to read from

schema - [in] schema to conform to. Will be inferred from the first element if not provided.

Make

@ByVal
public static RecordBatchReaderSharedResult Make(@ByVal
                                                         RecordBatchVector batches)