io.delta.kernel.data

Class DataReadResult

java.lang.Object

io.delta.kernel.data.DataReadResult

public class DataReadResult
extends java.lang.Object

Data read from Delta table file. Data is in ColumnarBatch format with an optional selection vector to select only a subset of rows for this columnar batch. The selection vector is of type boolean and has the same size as the data in the corresponding ColumnarBatch. For each row index, a value of true in the selection vector indicates the row at the same index in the data ColumnarBatch is valid; a value of false indicates the row should be ignored. If there is no selection vector then all the rows are valid.

Constructor Summary

Constructors

Constructor and Description
DataReadResult(ColumnarBatch data, java.util.Optional<ColumnVector> selectionVector)

Method Summary

Modifier and Type	Method and Description
ColumnarBatch	getData() Return the data as ColumnarBatch.
java.util.Optional<ColumnVector>	getSelectionVector() Optional selection vector containing one entry for each row in data indicating whether a row is selected or not selected.
ColumnarBatch	rewriteWithoutSelectionVector() Helper method to rewrite the data in this result by removing the rows that are not selected.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataReadResult

public DataReadResult(ColumnarBatch data,
                      java.util.Optional<ColumnVector> selectionVector)

Method Detail

getData

public ColumnarBatch getData()

Return the data as ColumnarBatch. Not all rows in the data are valid for this result. An optional selectionVector determines which rows are selected. If there is no selection vector that means all rows in this columnar batch are valid for this result.

Returns:

all the data read from the file

getSelectionVector

public java.util.Optional<ColumnVector> getSelectionVector()

Optional selection vector containing one entry for each row in data indicating whether a row is selected or not selected. If there is no selection vector then all the rows are valid.

Returns:

an optional ColumnVector indicating which rows are valid

rewriteWithoutSelectionVector

public ColumnarBatch rewriteWithoutSelectionVector()

Helper method to rewrite the data in this result by removing the rows that are not selected.

Returns:

A ColumnarBatch with only the selected rows according to the getSelectionVector()