Package dev.vortex.api

Interface ScanOptions

@Immutable public interface ScanOptions
Scan configuration passed to DataSource.scan(ScanOptions).

All fields are optional. A call to of() returns a default that reads every row and column.

  • Method Details

    • projection

      Optional<Expression> projection()
      Projection expression. If empty, all columns are returned.

    • filter

      Optional<Expression> filter()
      Filter expression applied before returning rows.

    • rowRangeBegin

      OptionalLong rowRangeBegin()
      Inclusive start of the row range to read.

    • rowRangeEnd

      OptionalLong rowRangeEnd()
      Exclusive end of the row range to read.

    • selectionIndices

      Optional<long[]> selectionIndices()
      Sorted ascending row indices that should be included in (or excluded from) the scan, depending on selectionMode().

    • selectionMode

      @Default default ScanOptions.SelectionMode selectionMode()
      Meaning of selectionIndices().

    • limit

      OptionalLong limit()
      Maximum row count to return. Absent means "no limit".

    • ordered

      @Default default boolean ordered()
      If true, the scan preserves the original row order across partitions.

    • of

      static ScanOptions of()

    • builder

      static dev.vortex.api.ImmutableScanOptions.Builder builder()