Package dev.vortex.api

Interface ScanOptions

@Immutable public interface ScanOptions
Create a new set of options for configuring the scan.

  • Method Summary

    Modifier and Type
    Method
    Description
    static dev.vortex.api.ImmutableScanOptions.Builder
    builder()
    Creates a new builder for constructing ScanOptions instances.
    List<String>
    columns()
    Columns to project out.
    static ScanOptions
    of()
    Creates a new ScanOptions instance with default values.
    Optional<Expression>
    predicate()
    Optional pruning expression that is pushed down to the scan.
    Optional<long[]>
    rowIndices()
    Optional row indices to select specific rows.
    Optional<long[]>
    rowRange()
    Optional start (inclusive) and end (exclusive) row indices to select a range of rows in the scan.

  • Method Details

    • columns

      List<String> columns()
      Columns to project out.

    • predicate

      Optional<Expression> predicate()
      Optional pruning expression that is pushed down to the scan.

    • rowRange

      Optional<long[]> rowRange()
      Optional start (inclusive) and end (exclusive) row indices to select a range of rows in the scan.

    • rowIndices

      Optional<long[]> rowIndices()
      Optional row indices to select specific rows. These must be sorted in ascending order.

    • of

      static ScanOptions of()
      Creates a new ScanOptions instance with default values.
      Returns:
      a ScanOptions instance with empty columns list, no predicate, no row range, and no row indices

    • builder

      static dev.vortex.api.ImmutableScanOptions.Builder builder()
      Creates a new builder for constructing ScanOptions instances.
      Returns:
      a new builder instance that can be used to configure and build ScanOptions