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 Summary

Modifier and Type	Method	Description
ThisT	fromSnapshotExclusive(long fromSnapshotId)	Instructs this scan to look for changes starting from a particular snapshot (exclusive).
ThisT	fromSnapshotInclusive(long fromSnapshotId)	Instructs this scan to look for changes starting from a particular snapshot (inclusive).
ThisT	toSnapshot(long toSnapshotId)	Instructs this scan to look for changes up to a particular snapshot (inclusive).

Methods inherited from interface org.apache.iceberg.Scan

caseSensitive, filter, filter, ignoreResiduals, includeColumnStats, isCaseSensitive, option, planFiles, planTasks, planWith, project, schema, select, select, splitLookback, splitOpenFileCost, targetSplitSize

Method Detail

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 is defaulted to the oldest ancestor of the end snapshot (inclusive).

Parameters:

fromSnapshotId - the start snapshot ID (inclusive)

Returns:

this for method chaining

Throws:

java.lang.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 is defaulted to the oldest ancestor of the end snapshot (inclusive).

Parameters:

fromSnapshotId - the start snapshot ID (exclusive)

Returns:

this for method chaining

Throws:

java.lang.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 is defaulted to the current table snapshot (inclusive).

Parameters:

toSnapshotId - the end snapshot ID (inclusive)

Returns:

this for method chaining