org.bytedeco.arrow

Class RecordBatch

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.RecordBatch

All Implemented Interfaces:

AutoCloseable

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

\class RecordBatch \brief Collection of equal-length arrays matching a particular Schema A record batch is table-like data structure that is semantically a sequence of fields, each a contiguous Arrow array

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

Method Summary

Modifier and Type	Method and Description
Status	AddColumn(int i, BytePointer field_name, Array column, RecordBatch out)
Status	AddColumn(int i, Field field, Array column, RecordBatch out) \brief Add column to the record batch, producing a new RecordBatch
Status	AddColumn(int i, String field_name, Array column, RecordBatch out) \brief Add new nullable column to the record batch, producing a new RecordBatch.
boolean	ApproxEquals(RecordBatch other) \brief Determine if two record batches are approximately equal
ArrayData	column_data(int i) \brief Retrieve an array's internaldata from the record batch
String	column_name(int i) \brief Name in i-th column
Array	column(int i) \brief Retrieve an array from the record batch
boolean	Equals(RecordBatch other) \brief Determine if two record batches are exactly equal
static Status	FromStructArray(Array array, RecordBatch out) \brief Construct record batch by copying vector of array data
Array	GetColumnByName(BytePointer name)
Array	GetColumnByName(String name) \brief Retrieve an array from the record batch
static RecordBatch	Make(Schema schema, long num_rows, ArrayDataVector columns) \brief Construct record batch from vector of internal data structures
static RecordBatch	Make(Schema schema, long num_rows, ArrayVector columns)
int	num_columns()
long	num_rows()
Status	RemoveColumn(int i, RecordBatch out) \brief Remove column from the record batch, producing a new RecordBatch
RecordBatch	ReplaceSchemaMetadata(KeyValueMetadata metadata)
Schema	schema()
RecordBatch	Slice(long offset) \brief Slice each of the arrays in the record batch
RecordBatch	Slice(long offset, long length) \brief Slice each of the arrays in the record batch
Status	Validate() \brief Perform cheap validation checks to determine obvious inconsistencies within the record batch's schema and internal data.
Status	ValidateFull() \brief Perform extensive validation checks to determine inconsistencies within the record batch's schema and internal data.

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

RecordBatch

public RecordBatch(Pointer p)

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

Method Detail

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
public static RecordBatch Make(@Const @SharedPtr @ByRef
                                                                                                   Schema schema,
                                                                                                   @Cast(value="int64_t")
                                                                                                   long num_rows,
                                                                                                   @Const @ByRef
                                                                                                   ArrayVector columns)

Parameters:

schema - [in] The record batch schema

num_rows - [in] length of fields in the record batch. Each array should have the same length as num_rows

columns - [in] the record batch fields as vector of arrays

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
public static RecordBatch Make(@Const @SharedPtr @ByRef
                                                                                                   Schema schema,
                                                                                                   @Cast(value="int64_t")
                                                                                                   long num_rows,
                                                                                                   @ByVal
                                                                                                   ArrayDataVector columns)

\brief Construct record batch from vector of internal data structures

Parameters:

schema - the record batch schema

num_rows - the number of semantic rows in the record batch. This should be equal to the length of each field

columns - the data for the batch's columns

Since:

0.5.0 This class is only provided with an rvalue-reference for the input data, and is intended for internal use, or advanced users.

FromStructArray

@ByVal
public static Status FromStructArray(@SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                                            Array array,
                                            @SharedPtr
                                            RecordBatch out)

\brief Construct record batch by copying vector of array data

Since:

0.5.0

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                          RecordBatch other)

\brief Determine if two record batches are exactly equal

Returns:

true if batches are equal

ApproxEquals

@Cast(value="bool")
public boolean ApproxEquals(@Const @ByRef
                                                RecordBatch other)

\brief Determine if two record batches are approximately equal

schema

@SharedPtr
 @ByVal
public Schema schema()

Returns:

true if batches are equal

column

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array column(int i)

\brief Retrieve an array from the record batch

Parameters:

i - [in] field index, does not boundscheck

Returns:

an Array object

GetColumnByName

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array GetColumnByName(@StdString
                                                                                           String name)

\brief Retrieve an array from the record batch

Parameters:

name - [in] field name

Returns:

an Array or null if no field was found

GetColumnByName

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::Array>"})
public Array GetColumnByName(@StdString
                                                                                           BytePointer name)

column_data

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::ArrayData>"})
public ArrayData column_data(int i)

\brief Retrieve an array's internaldata from the record batch

Parameters:

i - [in] field index, does not boundscheck

Returns:

an internal ArrayData object

AddColumn

@ByVal
public Status AddColumn(int i,
                               @Const @SharedPtr @ByRef
                               Field field,
                               @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                               Array column,
                               @SharedPtr
                               RecordBatch out)

\brief Add column to the record batch, producing a new RecordBatch

Parameters:

i - [in] field index, which will be boundschecked

field - [in] field to be added

column - [in] column to be added

out - [out] record batch with column added

AddColumn

@ByVal
public Status AddColumn(int i,
                               @StdString
                               String field_name,
                               @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                               Array column,
                               @SharedPtr
                               RecordBatch out)

\brief Add new nullable column to the record batch, producing a new RecordBatch. For non-nullable columns, use the Field-based version of this method.

Parameters:

i - [in] field index, which will be boundschecked

field_name - [in] name of field to be added

column - [in] column to be added

out - [out] record batch with column added

AddColumn

@ByVal
public Status AddColumn(int i,
                               @StdString
                               BytePointer field_name,
                               @SharedPtr @Cast(value={"","std::shared_ptr<arrow::Array>"})
                               Array column,
                               @SharedPtr
                               RecordBatch out)

RemoveColumn

@ByVal
public Status RemoveColumn(int i,
                                  @SharedPtr
                                  RecordBatch out)

\brief Remove column from the record batch, producing a new RecordBatch

Parameters:

i - [in] field index, does boundscheck

out - [out] record batch with column removed

ReplaceSchemaMetadata

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
public RecordBatch ReplaceSchemaMetadata(@Const @Cast(value="const arrow::KeyValueMetadata*") @SharedPtr @ByRef
                                                                                                             KeyValueMetadata metadata)

column_name

@StdString
public String column_name(int i)

\brief Name in i-th column

num_columns

public int num_columns()

Returns:

the number of columns in the table

num_rows

@Cast(value="int64_t")
public long num_rows()

Returns:

the number of rows (the corresponding length of each column)

Slice

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
public RecordBatch Slice(@Cast(value="int64_t")
                                                                                             long offset)

\brief Slice each of the arrays in the record batch

Parameters:

offset - [in] the starting offset to slice, through end of batch

Returns:

new record batch

Slice

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
public RecordBatch Slice(@Cast(value="int64_t")
                                                                                             long offset,
                                                                                             @Cast(value="int64_t")
                                                                                             long length)

\brief Slice each of the arrays in the record batch

Parameters:

offset - [in] the starting offset to slice

length - [in] the number of elements to slice from offset

Returns:

new record batch

Validate

@ByVal
public Status Validate()

\brief Perform cheap validation checks to determine obvious inconsistencies within the record batch's schema and internal data. This is O(k) where k is the total number of fields and array descendents.

Returns:

Status

ValidateFull

@ByVal
public Status ValidateFull()

\brief Perform extensive validation checks to determine inconsistencies within the record batch's schema and internal data. This is potentially O(k*n) where n is the number of rows.

Returns:

Status