org.apache.arrow.dataset.scanner

Class ScanOptions.Builder

java.lang.Object

org.apache.arrow.dataset.scanner.ScanOptions.Builder

Enclosing class:

ScanOptions

public static class ScanOptions.Builder
extends Object

Builder for Options used during scanning.

Constructor Summary

Constructors

Constructor and Description
Builder(long batchSize) Constructor.

Method Summary

Modifier and Type	Method and Description
ScanOptions	build()
ScanOptions.Builder	columns(Optional<String[]> columns) Set the Projected columns.
ScanOptions.Builder	substraitFilter(ByteBuffer substraitFilter) Set the Substrait extended expression for Filter.
ScanOptions.Builder	substraitProjection(ByteBuffer substraitProjection) Set the Substrait extended expression for Projection new columns.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(long batchSize)

Constructor.

Parameters:

batchSize - Maximum row number of each returned ArrowRecordBatch

Method Detail

columns

public ScanOptions.Builder columns(Optional<String[]> columns)

Set the Projected columns. Empty for scanning all columns.

Parameters:

columns - Projected columns. Empty for scanning all columns.

Returns:

the ScanOptions configured.

substraitProjection

public ScanOptions.Builder substraitProjection(ByteBuffer substraitProjection)

Set the Substrait extended expression for Projection new columns.

Parameters:

substraitProjection - Expressions to evaluate for project new columns.

Returns:

the ScanOptions configured.

substraitFilter

public ScanOptions.Builder substraitFilter(ByteBuffer substraitFilter)

Set the Substrait extended expression for Filter.

Parameters:

substraitFilter - Expressions to evaluate for apply Filter.

Returns:

the ScanOptions configured.

build

public ScanOptions build()