org.bytedeco.arrow

Class RecordBatchFileWriter

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.RecordBatchWriter

org.bytedeco.arrow.RecordBatchStreamWriter

org.bytedeco.arrow.RecordBatchFileWriter

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::ipc")
 @NoOffset
 @Properties(inherit=arrow.class)
public class RecordBatchFileWriter
extends RecordBatchStreamWriter

\brief Creates the Arrow record batch file format Implements the random access file format, which structurally is a record batch stream followed by a metadata footer at the end of the file. Magic numbers are written at the start and end of the file

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

Method Summary

Modifier and Type	Method and Description
Status	Close() \brief Close the file stream by writing the file footer and magic number
static RecordBatchWriterSharedResult	Open(OutputStream sink, Schema schema) Create a new writer from stream sink and schema
static RecordBatchWriterSharedResult	Open(OutputStream sink, Schema schema, IpcOptions options)
static Status	Open(OutputStream sink, Schema schema, RecordBatchWriter out) Create a new writer from stream sink and schema
Status	WriteRecordBatch(RecordBatch batch) \brief Write a record batch to the file

Methods inherited from class org.bytedeco.arrow.RecordBatchStreamWriter

set_memory_pool

Methods inherited from class org.bytedeco.arrow.RecordBatchWriter

WriteTable, WriteTable

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordBatchFileWriter

public RecordBatchFileWriter(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

Open

@ByVal
public static Status Open(OutputStream sink,
                                 @Const @SharedPtr @ByRef
                                 Schema schema,
                                 @SharedPtr
                                 RecordBatchWriter out)

Create a new writer from stream sink and schema

Parameters:

sink - [in] output stream to write to

schema - [in] the schema of the record batches to be written

out - [out] the created stream writer

Returns:

Status

Open

@ByVal
public static RecordBatchWriterSharedResult Open(OutputStream sink,
                                                        @Const @SharedPtr @ByRef
                                                        Schema schema)

Create a new writer from stream sink and schema

Parameters:

sink - [in] output stream to write to

schema - [in] the schema of the record batches to be written

Returns:

Status

Open

@ByVal
public static RecordBatchWriterSharedResult Open(OutputStream sink,
                                                        @Const @SharedPtr @ByRef
                                                        Schema schema,
                                                        @Const @ByRef
                                                        IpcOptions options)

WriteRecordBatch

@ByVal
public Status WriteRecordBatch(@Const @ByRef
                                      RecordBatch batch)

\brief Write a record batch to the file

Overrides:

WriteRecordBatch in class RecordBatchStreamWriter

Parameters:

batch - [in] the record batch to write

Returns:

Status

Close

@ByVal
public Status Close()

\brief Close the file stream by writing the file footer and magic number

Overrides:

Close in class RecordBatchStreamWriter

Returns:

Status