org.apache.kyuubi.jdbc.hive.arrow

Class ArrowColumnarBatch

java.lang.Object

org.apache.kyuubi.jdbc.hive.arrow.ArrowColumnarBatch

All Implemented Interfaces:

AutoCloseable

public class ArrowColumnarBatch
extends Object
implements AutoCloseable

This class wraps multiple ColumnVectors as a row-wise table. It provides a row view of this batch so that Spark can access the data row by row. Instance of it is meant to be reused during the entire data loading process. A data source may extend this class with customized logic.

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrowColumnVector[]	columns
protected int	numRows
protected ArrowColumnarBatchRow	row

Constructor Summary

Constructors

Constructor and Description
ArrowColumnarBatch(ArrowColumnVector[] columns)
ArrowColumnarBatch(ArrowColumnVector[] columns, int numRows) Create a new batch from existing column vectors.

Method Summary

Modifier and Type	Method and Description
void	close() Called to close all the columns in this batch.
ArrowColumnVector	column(int ordinal) Returns the column at `ordinal`.
ArrowColumnarBatchRow	getRow(int rowId) Returns the row in this batch at `rowId`.
int	numCols() Returns the number of columns that make up this batch.
int	numRows() Returns the number of rows for read, including filtered rows.
Iterator<ArrowColumnarBatchRow>	rowIterator() Returns an iterator over the rows in this batch.
void	setNumRows(int numRows) Sets the number of rows in this batch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

numRows

protected int numRows

columns

protected final ArrowColumnVector[] columns

row

protected final ArrowColumnarBatchRow row

Constructor Detail

ArrowColumnarBatch

public ArrowColumnarBatch(ArrowColumnVector[] columns)

ArrowColumnarBatch

public ArrowColumnarBatch(ArrowColumnVector[] columns,
                          int numRows)

Create a new batch from existing column vectors.

Parameters:

columns - The columns of this batch

numRows - The number of rows in this batch

Method Detail

close

public void close()

Called to close all the columns in this batch. It is not valid to access the data after calling this. This must be called at the end to clean up memory allocations.

Specified by:

close in interface AutoCloseable

rowIterator

public Iterator<ArrowColumnarBatchRow> rowIterator()

Returns an iterator over the rows in this batch.

setNumRows

public void setNumRows(int numRows)

Sets the number of rows in this batch.

numCols

public int numCols()

Returns the number of columns that make up this batch.

numRows

public int numRows()

Returns the number of rows for read, including filtered rows.

column

public ArrowColumnVector column(int ordinal)

Returns the column at `ordinal`.

getRow

public ArrowColumnarBatchRow getRow(int rowId)

Returns the row in this batch at `rowId`. Returned row is reused across calls.