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
RecordBatchResult	AddColumn(int i, BytePointer field_name, Array column)
RecordBatchResult	AddColumn(int i, Field field, Array column) \brief Add column to the record batch, producing a new RecordBatch
RecordBatchResult	AddColumn(int i, String field_name, Array column) \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
ArrayDataVector	column_data() \brief Retrieve all arrays' internal data from the record batch.
ArrayData	column_data(int i) \brief Retrieve an array's internal data 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
ArrayVector	columns() \brief Retrieve all columns at once
boolean	Equals(RecordBatch other)
boolean	Equals(RecordBatch other, boolean check_metadata) \brief Determine if two record batches are exactly equal
static RecordBatchResult	FromStructArray(Array array) \brief Construct record batch from struct array This constructs a record batch using the child arrays of the given array, which must be a struct array.
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()
RecordBatchResult	RemoveColumn(int i) \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
String	ToString()
StructArrayResult	ToStructArray() \brief Convert record batch to struct array Create a struct array whose child arrays are the record batch's columns.
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, 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

RecordBatch

public RecordBatch(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Make

@SharedPtr
 @Cast(value={"","std::shared_ptr<arrow::RecordBatch>"})
public static RecordBatch Make(@SharedPtr @ByVal
                                                                                                     Schema schema,
                                                                                                     @Cast(value="int64_t")
                                                                                                     long num_rows,
                                                                                                     @ByVal
                                                                                                     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(@SharedPtr @ByVal
                                                                                                     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 intended for internal use, or advanced users.

ToStructArray

@ByVal
public StructArrayResult ToStructArray()

\brief Convert record batch to struct array Create a struct array whose child arrays are the record batch's columns. Note that the record batch's top-level field metadata cannot be reflected in the resulting struct array.

FromStructArray

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

\brief Construct record batch from struct array This constructs a record batch using the child arrays of the given array, which must be a struct array. Note that the struct array's own null bitmap is not reflected in the resulting record batch.

Equals

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

\brief Determine if two record batches are exactly equal

Parameters:

other - [in] the RecordBatch to compare with

check_metadata - [in] if true, check that Schema metadata is the same

Returns:

true if batches are equal

Equals

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

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

columns

@ByVal
public ArrayVector columns()

\brief Retrieve all columns at once

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 internal data from the record batch

Parameters:

i - [in] field index, does not boundscheck

Returns:

an internal ArrayData object

column_data

@ByVal
public ArrayDataVector column_data()

\brief Retrieve all arrays' internal data from the record batch.

AddColumn

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

\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

AddColumn

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

\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

AddColumn

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

RemoveColumn

@ByVal
public RecordBatchResult RemoveColumn(int i)

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

Parameters:

i - [in] field index, does boundscheck

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

ToString

@StdString
public String ToString()

Returns:

PrettyPrint representation suitable for debugging

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