Module org.apache.arrow.dataset
Package 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 Details

    • Builder

      public Builder(long batchSize)
      Constructor.
      Parameters:
      batchSize - Maximum row number of each returned ArrowRecordBatch

  • Method Details

    • 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.

    • fragmentScanOptions

      public ScanOptions.Builder fragmentScanOptions(FragmentScanOptions fragmentScanOptions)
      Set the FragmentScanOptions.
      Parameters:
      fragmentScanOptions - fragment scan options
      Returns:
      the ScanOptions configured.

    • build

      public ScanOptions build()