public interface BatchScan extends Scan<BatchScan,ScanTask,ScanTaskGroup<ScanTask>>
Modifier and Type | Method and Description |
---|---|
BatchScan |
asOfTime(long timestampMillis)
Create a new
BatchScan from this scan's configuration that will use the most recent
snapshot as of the given time in milliseconds on the branch in the scan or main if no branch is
set. |
Snapshot |
snapshot()
Returns the
Snapshot that will be used by this scan. |
Table |
table()
Returns the
Table from which this scan loads data. |
BatchScan |
useRef(java.lang.String ref)
Create a new
BatchScan from this scan's configuration that will use the given
reference. |
BatchScan |
useSnapshot(long snapshotId)
Create a new
BatchScan from this scan's configuration that will use a snapshot with the
given ID. |
caseSensitive, filter, filter, ignoreResiduals, includeColumnStats, isCaseSensitive, metricsReporter, option, planFiles, planTasks, planWith, project, schema, select, select, splitLookback, splitOpenFileCost, targetSplitSize
BatchScan useSnapshot(long snapshotId)
BatchScan
from this scan's configuration that will use a snapshot with the
given ID.snapshotId
- a snapshot IDjava.lang.IllegalArgumentException
- if the snapshot cannot be foundBatchScan useRef(java.lang.String ref)
BatchScan
from this scan's configuration that will use the given
reference.ref
- a referencejava.lang.IllegalArgumentException
- if the reference with the given name could not be foundBatchScan asOfTime(long timestampMillis)
BatchScan
from this scan's configuration that will use the most recent
snapshot as of the given time in milliseconds on the branch in the scan or main if no branch is
set.timestampMillis
- a timestamp in millisecondsjava.lang.IllegalArgumentException
- if the snapshot cannot be found or time travel is attempted on
a tagSnapshot snapshot()
Snapshot
that will be used by this scan.
If the snapshot was not configured using asOfTime(long)
or useSnapshot(long)
, the current table snapshot will be used.