org.bytedeco.arrow

Class RecordBatchWriter

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.RecordBatchWriter

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

MetadataRecordBatchWriter

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

\class RecordBatchWriter \brief Abstract interface for writing a 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
RecordBatchWriter(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Status	Close() \brief Perform any logic necessary to finish the stream
WriteStats	stats() \brief Return current write statistics
Status	WriteRecordBatch(RecordBatch batch) \brief Write a record batch to the stream
Status	WriteTable(Table table) \brief Write possibly-chunked table by creating sequence of record batches
Status	WriteTable(Table table, long max_chunksize) \brief Write Table with a particular chunksize

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, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

RecordBatchWriter

public RecordBatchWriter(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

WriteRecordBatch

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

\brief Write a record batch to the stream

Parameters:

batch - [in] the record batch to write to the stream

Returns:

Status

WriteTable

@ByVal
public Status WriteTable(@Const @ByRef
                                 Table table)

\brief Write possibly-chunked table by creating sequence of record batches

Parameters:

table - [in] table to write

Returns:

Status

WriteTable

@ByVal
public Status WriteTable(@Const @ByRef
                                 Table table,
                                 @Cast(value="int64_t")
                                 long max_chunksize)

\brief Write Table with a particular chunksize

Parameters:

table - [in] table to write

max_chunksize - [in] maximum length of table chunks. To indicate that no maximum should be enforced, pass -1.

Returns:

Status

Close

@ByVal
public Status Close()

\brief Perform any logic necessary to finish the stream

Returns:

Status

stats

@ByVal
public WriteStats stats()

\brief Return current write statistics