TableFileSystemView (hudi-common 0.15.0 API)

All Known Subinterfaces:

SyncableFileSystemView

All Known Implementing Classes:

AbstractTableFileSystemView, HoodieMetadataFileSystemView, HoodieTableFileSystemView, IncrementalTimelineSyncFileSystemView, PriorityBasedFileSystemView, RemoteHoodieTableFileSystemView, RocksDbBasedFileSystemView, SpillableMapBasedFileSystemView
```
public interface TableFileSystemView
```
Interface for viewing the table file system.

Since:

0.3.0

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`TableFileSystemView.BaseFileOnlyView` Methods to provide a view of base files only.
`static interface`	`TableFileSystemView.BaseFileOnlyViewWithLatestSlice` Methods to only access latest version of file for the instant(s) passed.
`static interface`	`TableFileSystemView.SliceView` Methods to access a combination of base files + log file slices.
`static interface`	`TableFileSystemView.SliceViewWithLatestSlice` Methods to only access latest version of file-slice for the instant(s) passed.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Stream<HoodieFileGroup>`	`getAllFileGroups(String partitionPath)` Stream all the file groups for a given partition.
`Stream<HoodieFileGroup>`	`getAllFileGroupsStateless(String partitionPath)` Stream all the file groups for a given partition without caching the file group mappings.
`Stream<HoodieFileGroup>`	`getAllReplacedFileGroups(String partitionPath)` Stream all the replaced file groups for given partition.
`Stream<Pair<HoodieFileGroupId,HoodieInstant>>`	`getFileGroupsInPendingClustering()` Filegroups that are in pending clustering.
`Option<HoodieInstant>`	`getLastInstant()` Last Known Instant on which the view is built.
`Stream<Pair<String,CompactionOperation>>`	`getPendingCompactionOperations()` Return Pending Compaction Operations.
`Stream<Pair<String,CompactionOperation>>`	`getPendingLogCompactionOperations()` Return Pending Compaction Operations.
`Stream<HoodieFileGroup>`	`getReplacedFileGroupsAfterOrOn(String minCommitTime, String partitionPath)` Stream all the replaced file groups after or on minCommitTime.
`Stream<HoodieFileGroup>`	`getReplacedFileGroupsBefore(String maxCommitTime, String partitionPath)` Stream all the replaced file groups before maxCommitTime for given partition.
`Stream<HoodieFileGroup>`	`getReplacedFileGroupsBeforeOrOn(String maxCommitTime, String partitionPath)` Stream all the replaced file groups before or on maxCommitTime for given partition.
`HoodieTimeline`	`getTimeline()` Timeline corresponding to the view.
`void`	`loadAllPartitions()` Load all partition and file slices into view
`void`	`loadPartitions(List<String> partitionPaths)` Load all partition and file slices into view for the provided partition paths

- Method Detail
  - getAllFileGroups
```
Stream<HoodieFileGroup> getAllFileGroups(String partitionPath)
```
    Stream all the file groups for a given partition.
  - getAllFileGroupsStateless
```
Stream<HoodieFileGroup> getAllFileGroupsStateless(String partitionPath)
```
    Stream all the file groups for a given partition without caching the file group mappings.
    This is useful for some table services such as cleaning, the cleaning service may search around the files to clean within some ancient data partitions, if there triggers a full table cleaning for enormous number of partitions, the cache could cause a huge memory pressure to the timeline server which induces an OOM exception.
    The caching of these file groups does not benefit to writers most often because the writers write to recent data partitions usually.
  - getPendingCompactionOperations
```
Stream<Pair<String,CompactionOperation>> getPendingCompactionOperations()
```
    Return Pending Compaction Operations.
    
    Returns:
    
    Stream>
  - getPendingLogCompactionOperations
```
Stream<Pair<String,CompactionOperation>> getPendingLogCompactionOperations()
```
    Return Pending Compaction Operations.
    
    Returns:
    
    Stream>
  - getLastInstant
```
Option<HoodieInstant> getLastInstant()
```
    Last Known Instant on which the view is built.
  - getTimeline
```
HoodieTimeline getTimeline()
```
    Timeline corresponding to the view.
  - getReplacedFileGroupsBeforeOrOn
```
Stream<HoodieFileGroup> getReplacedFileGroupsBeforeOrOn(String maxCommitTime,
                                                        String partitionPath)
```
    Stream all the replaced file groups before or on maxCommitTime for given partition.
  - getReplacedFileGroupsBefore
```
Stream<HoodieFileGroup> getReplacedFileGroupsBefore(String maxCommitTime,
                                                    String partitionPath)
```
    Stream all the replaced file groups before maxCommitTime for given partition.
  - getReplacedFileGroupsAfterOrOn
```
Stream<HoodieFileGroup> getReplacedFileGroupsAfterOrOn(String minCommitTime,
                                                       String partitionPath)
```
    Stream all the replaced file groups after or on minCommitTime.
  - getAllReplacedFileGroups
```
Stream<HoodieFileGroup> getAllReplacedFileGroups(String partitionPath)
```
    Stream all the replaced file groups for given partition.
  - getFileGroupsInPendingClustering
```
Stream<Pair<HoodieFileGroupId,HoodieInstant>> getFileGroupsInPendingClustering()
```
    Filegroups that are in pending clustering.
  - loadAllPartitions
```
void loadAllPartitions()
```
    Load all partition and file slices into view
  - loadPartitions
```
void loadPartitions(List<String> partitionPaths)
```
    Load all partition and file slices into view for the provided partition paths
    
    Parameters:
    
    partitionPaths - List of partition paths to load

Interface TableFileSystemView

Nested Class Summary

Method Summary

Method Detail

getAllFileGroups

getAllFileGroupsStateless

getPendingCompactionOperations

getPendingLogCompactionOperations

getLastInstant

getTimeline

getReplacedFileGroupsBeforeOrOn

getReplacedFileGroupsBefore

getReplacedFileGroupsAfterOrOn

getAllReplacedFileGroups

getFileGroupsInPendingClustering

loadAllPartitions

loadPartitions