DataSplit (Paimon : 1.2-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.table.source.DataSplit

All Implemented Interfaces:

Serializable, Split

Direct Known Subclasses:

PlaceholderSplit
```
public class DataSplit
extends Object
implements Split
```
Input splits. Needed by most batch computation engines.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataSplit.Builder
Builder for DataSplit.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataSplit.Builder` Builder for `DataSplit`.

Constructor Summary

Constructors
Constructor and Description

DataSplit()

Constructors
Constructor and Description
`DataSplit()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<List<DeletionFile>>`	`beforeDeletionFiles()`
`List<DataFileMeta>`	`beforeFiles()`
`int`	`bucket()`
`String`	`bucketPath()`
`static DataSplit.Builder`	`builder()`
`Optional<List<RawFile>>`	`convertToRawFiles()` If all files in this split can be read without merging, returns an `Optional` wrapping a list of `RawFile`s to be read without merging.
`List<DataFileMeta>`	`dataFiles()`
`Optional<List<DeletionFile>>`	`deletionFiles()` Return the deletion file of the data file, indicating which row in the data file was deleted.
`static DataSplit`	`deserialize(DataInputView in)`
`OptionalLong`	`earliestFileCreationEpochMillis()`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`Optional<List<IndexFile>>`	`indexFiles()` * Return the index file of the data file, for example, bloom-filter index.
`boolean`	`isStreaming()`
`OptionalLong`	`latestFileCreationEpochMillis()`
`Object`	`maxValue(int fieldIndex, DataField dataField, SimpleStatsEvolutions evolutions)`
`long`	`mergedRowCount()`
`boolean`	`mergedRowCountAvailable()` Whether it is possible to calculate the merged row count.
`Object`	`minValue(int fieldIndex, DataField dataField, SimpleStatsEvolutions evolutions)`
`long`	`partialMergedRowCount()` Obtain merged row count as much as possible.
`BinaryRow`	`partition()`
`boolean`	`rawConvertible()`
`long`	`rowCount()`
`void`	`serialize(DataOutputView out)`
`long`	`snapshotId()`
`Integer`	`totalBuckets()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DataSplit
```
public DataSplit()
```
- Method Detail
  - snapshotId
```
public long snapshotId()
```
  - partition
```
public BinaryRow partition()
```
  - bucket
```
public int bucket()
```
  - bucketPath
```
public String bucketPath()
```
  - totalBuckets
```
@Nullable
public Integer totalBuckets()
```
  - beforeFiles
```
public List<DataFileMeta> beforeFiles()
```
  - beforeDeletionFiles
```
public Optional<List<DeletionFile>> beforeDeletionFiles()
```
  - dataFiles
```
public List<DataFileMeta> dataFiles()
```
  - deletionFiles
```
public Optional<List<DeletionFile>> deletionFiles()
```
    Description copied from interface: Split
    
    Return the deletion file of the data file, indicating which row in the data file was deleted.
    If there is no corresponding deletion file, the element will be null.
    
    Specified by:
    
    deletionFiles in interface Split
  - isStreaming
```
public boolean isStreaming()
```
  - rawConvertible
```
public boolean rawConvertible()
```
  - latestFileCreationEpochMillis
```
public OptionalLong latestFileCreationEpochMillis()
```
  - earliestFileCreationEpochMillis
```
public OptionalLong earliestFileCreationEpochMillis()
```
  - rowCount
```
public long rowCount()
```
    Specified by:
    
    rowCount in interface Split
  - mergedRowCountAvailable
```
public boolean mergedRowCountAvailable()
```
    Whether it is possible to calculate the merged row count.
  - mergedRowCount
```
public long mergedRowCount()
```
  - minValue
```
public Object minValue(int fieldIndex,
                       DataField dataField,
                       SimpleStatsEvolutions evolutions)
```
  - maxValue
```
public Object maxValue(int fieldIndex,
                       DataField dataField,
                       SimpleStatsEvolutions evolutions)
```
  - partialMergedRowCount
```
public long partialMergedRowCount()
```
    Obtain merged row count as much as possible. There are two scenarios where accurate row count can be calculated:
    1. raw file and no deletion file.
    2. raw file + deletion file with cardinality.
  - convertToRawFiles
```
public Optional<List<RawFile>> convertToRawFiles()
```
    Description copied from interface: Split
    
    If all files in this split can be read without merging, returns an Optional wrapping a list of RawFiles to be read without merging. Otherwise, returns Optional.empty().
    
    Specified by:
    
    convertToRawFiles in interface Split
  - indexFiles
```
@Nullable
public Optional<List<IndexFile>> indexFiles()
```
    Description copied from interface: Split
    
    * Return the index file of the data file, for example, bloom-filter index. All the type of indexes and columns will be stored in one single index file.
    If there is no corresponding index file, the element will be null.
    
    Specified by:
    
    indexFiles in interface Split
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - serialize
```
public void serialize(DataOutputView out)
               throws IOException
```
    Throws:
    
    IOException
  - deserialize
```
public static DataSplit deserialize(DataInputView in)
                             throws IOException
```
    Throws:
    
    IOException
  - builder
```
public static DataSplit.Builder builder()
```

Back to Paimon Website

Class DataSplit

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSplit

Method Detail

snapshotId

partition

bucket

bucketPath

totalBuckets

beforeFiles

beforeDeletionFiles

dataFiles

deletionFiles

isStreaming

rawConvertible

latestFileCreationEpochMillis

earliestFileCreationEpochMillis

rowCount

mergedRowCountAvailable

mergedRowCount

minValue

maxValue

partialMergedRowCount

convertToRawFiles

indexFiles

equals

hashCode

serialize

deserialize

builder

Back to Paimon Website