Module org.apache.arrow.dataset

Package org.apache.arrow.dataset.scanner

Class ScanOptions

java.lang.Object

org.apache.arrow.dataset.scanner.ScanOptions

public class ScanOptions
extends Object

Options used during scanning.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScanOptions.Builder	Builder for Options used during scanning.

Constructor Summary

Constructors

Constructor	Description
ScanOptions(long batchSize)
ScanOptions(long batchSize, Optional<String[]> columns)	Constructor.
ScanOptions(String[] columns, long batchSize)	Deprecated. Deprecated.

Method Summary

Modifier and Type	Method	Description
long	getBatchSize()
Optional<String[]>	getColumns()
Optional<FragmentScanOptions>	getFragmentScanOptions()
Optional<ByteBuffer>	getSubstraitFilter()
Optional<ByteBuffer>	getSubstraitProjection()

Methods inherited from class java.lang.Object

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

Constructor Details

ScanOptions

@Deprecated
public ScanOptions(String[] columns,
 long batchSize)

Deprecated.

Deprecated. Use ScanOptions(long, Optional) instead.

Constructor.

Parameters:

columns - Projected columns. Empty for scanning all columns.

batchSize - Maximum row number of each returned ArrowRecordBatch

ScanOptions

public ScanOptions(long batchSize,
 Optional<String[]> columns)

Constructor.

Parameters:

batchSize - Maximum row number of each returned ArrowRecordBatch

columns - (Optional) Projected columns. Optional.empty() for scanning all columns. Otherwise, Only columns present in the Array will be scanned.

ScanOptions

public ScanOptions(long batchSize)

Method Details

getColumns

public Optional<String[]> getColumns()

getBatchSize

public long getBatchSize()

getSubstraitProjection

public Optional<ByteBuffer> getSubstraitProjection()

getSubstraitFilter

public Optional<ByteBuffer> getSubstraitFilter()

getFragmentScanOptions

public Optional<FragmentScanOptions> getFragmentScanOptions()