Package org.apache.iceberg

Interface IncrementalScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>>

All Superinterfaces:
Scan<ThisT,T,G>
All Known Subinterfaces:
IncrementalAppendScan, IncrementalChangelogScan
public interface IncrementalScan<ThisT,T extends ScanTask,G extends ScanTaskGroup<T>> extends Scan<ThisT,T,G>
API for configuring an incremental scan.

  • Method Details

    • fromSnapshotInclusive

      ThisT fromSnapshotInclusive(long fromSnapshotId)
      Instructs this scan to look for changes starting from a particular snapshot (inclusive).

      If the start snapshot is not configured, it defaults to the oldest ancestor of the end snapshot (inclusive).

      Parameters:
      fromSnapshotId - the start snapshot ID (inclusive)
      Returns:
      this for method chaining
      Throws:
      IllegalArgumentException - if the start snapshot is not an ancestor of the end snapshot

    • fromSnapshotInclusive

      default ThisT fromSnapshotInclusive(String ref)
      Instructs this scan to look for changes starting from a particular snapshot (inclusive).

      If the start snapshot is not configured, it defaults to the oldest ancestor of the end snapshot (inclusive).

      Parameters:
      ref - the start ref name that points to a particular snapshot ID (inclusive)
      Returns:
      this for method chaining
      Throws:
      IllegalArgumentException - if the start snapshot is not an ancestor of the end snapshot

    • fromSnapshotExclusive

      ThisT fromSnapshotExclusive(long fromSnapshotId)
      Instructs this scan to look for changes starting from a particular snapshot (exclusive).

      If the start snapshot is not configured, it defaults to the oldest ancestor of the end snapshot (inclusive).

      Parameters:
      fromSnapshotId - the start snapshot ID (exclusive)
      Returns:
      this for method chaining
      Throws:
      IllegalArgumentException - if the start snapshot is not an ancestor of the end snapshot

    • fromSnapshotExclusive

      default ThisT fromSnapshotExclusive(String ref)
      Instructs this scan to look for changes starting from a particular snapshot (exclusive).

      If the start snapshot is not configured, it defaults to the oldest ancestor of the end snapshot (inclusive).

      Parameters:
      ref - the start ref name that points to a particular snapshot ID (exclusive)
      Returns:
      this for method chaining
      Throws:
      IllegalArgumentException - if the start snapshot is not an ancestor of the end snapshot

    • toSnapshot

      ThisT toSnapshot(long toSnapshotId)
      Instructs this scan to look for changes up to a particular snapshot (inclusive).

      If the end snapshot is not configured, it defaults to the current table snapshot (inclusive).

      Parameters:
      toSnapshotId - the end snapshot ID (inclusive)
      Returns:
      this for method chaining

    • toSnapshot

      default ThisT toSnapshot(String ref)
      Instructs this scan to look for changes up to a particular snapshot ref (inclusive).

      If the end snapshot is not configured, it defaults to the current table snapshot (inclusive).

      Parameters:
      ref - the end snapshot Ref (inclusive)
      Returns:
      this for method chaining

    • useBranch

      default ThisT useBranch(String branch)
      Use the specified branch
      Parameters:
      branch - the branch name
      Returns:
      this for method chaining