org.apache.paimon.operation

Interface FileStoreScan

All Known Implementing Classes:

AbstractFileStoreScan, AppendOnlyFileStoreScan, KeyValueFileStoreScan

public interface FileStoreScan

Scan operation which produces a plan.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FileStoreScan.Plan Result plan of this scan.

Method Summary

Modifier and Type	Method and Description
default List<BinaryRow>	listPartitions()
ManifestsReader	manifestsReader()
Integer	parallelism()
FileStoreScan.Plan	plan() Produce a FileStoreScan.Plan.
List<BucketEntry>	readBucketEntries()
Iterator<ManifestEntry>	readFileIterator()
List<ManifestEntry>	readManifest(ManifestFileMeta manifest)
List<PartitionEntry>	readPartitionEntries()
List<SimpleFileEntry>	readSimpleEntries() Read SimpleFileEntrys, SimpleFileEntry only retains some critical information, so it cannot perform filtering based on statistical information.
default Long	totalRecordCount(Snapshot snapshot) Return record count of all changes occurred in this snapshot given the scan.
FileStoreScan	withBucket(int bucket)
FileStoreScan	withBucketFilter(Filter<Integer> bucketFilter)
FileStoreScan	withDataFileNameFilter(Filter<String> fileNameFilter)
FileStoreScan	withKind(ScanMode scanMode)
FileStoreScan	withLevelFilter(Filter<Integer> levelFilter)
FileStoreScan	withManifestCacheFilter(ManifestCacheFilter manifestFilter)
FileStoreScan	withManifestEntryFilter(Filter<ManifestEntry> filter)
FileStoreScan	withManifestList(List<ManifestFileMeta> manifests)
FileStoreScan	withMetrics(ScanMetrics metrics)
FileStoreScan	withPartitionBucket(BinaryRow partition, int bucket)
FileStoreScan	withPartitionFilter(List<BinaryRow> partitions)
FileStoreScan	withPartitionFilter(PartitionPredicate predicate)
FileStoreScan	withPartitionFilter(Predicate predicate)
FileStoreScan	withSnapshot(long snapshotId)
FileStoreScan	withSnapshot(Snapshot snapshot)
FileStoreScan	withTotalAwareBucketFilter(BiFilter<Integer,Integer> bucketFilter)

Method Detail

withPartitionFilter

FileStoreScan withPartitionFilter(Predicate predicate)

withPartitionFilter

FileStoreScan withPartitionFilter(List<BinaryRow> partitions)

withPartitionFilter

FileStoreScan withPartitionFilter(PartitionPredicate predicate)

withBucket

FileStoreScan withBucket(int bucket)

withBucketFilter

FileStoreScan withBucketFilter(Filter<Integer> bucketFilter)

withTotalAwareBucketFilter

FileStoreScan withTotalAwareBucketFilter(BiFilter<Integer,Integer> bucketFilter)

withPartitionBucket

FileStoreScan withPartitionBucket(BinaryRow partition,
                                  int bucket)

withSnapshot

FileStoreScan withSnapshot(long snapshotId)

withSnapshot

FileStoreScan withSnapshot(Snapshot snapshot)

withManifestList

FileStoreScan withManifestList(List<ManifestFileMeta> manifests)

withKind

FileStoreScan withKind(ScanMode scanMode)

withLevelFilter

FileStoreScan withLevelFilter(Filter<Integer> levelFilter)

withManifestEntryFilter

FileStoreScan withManifestEntryFilter(Filter<ManifestEntry> filter)

withManifestCacheFilter

FileStoreScan withManifestCacheFilter(ManifestCacheFilter manifestFilter)

withDataFileNameFilter

FileStoreScan withDataFileNameFilter(Filter<String> fileNameFilter)

withMetrics

FileStoreScan withMetrics(ScanMetrics metrics)

parallelism

@Nullable
Integer parallelism()

manifestsReader

ManifestsReader manifestsReader()

readManifest

List<ManifestEntry> readManifest(ManifestFileMeta manifest)

plan

FileStoreScan.Plan plan()

Produce a FileStoreScan.Plan.

totalRecordCount

default Long totalRecordCount(Snapshot snapshot)

Return record count of all changes occurred in this snapshot given the scan.

Returns:

total record count of Snapshot.

readSimpleEntries

List<SimpleFileEntry> readSimpleEntries()

Read SimpleFileEntrys, SimpleFileEntry only retains some critical information, so it cannot perform filtering based on statistical information.

readPartitionEntries

List<PartitionEntry> readPartitionEntries()

readBucketEntries

List<BucketEntry> readBucketEntries()

readFileIterator

Iterator<ManifestEntry> readFileIterator()

listPartitions

default List<BinaryRow> listPartitions()