Package io.delta.kernel.internal.checkpoints

Class CheckpointInstance

Object

io.delta.kernel.internal.checkpoints.CheckpointInstance

All Implemented Interfaces:

Comparable<CheckpointInstance>

public class CheckpointInstance
extends Object
implements Comparable<CheckpointInstance>

Metadata about Delta checkpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CheckpointInstance.CheckpointFormat

Field Summary

Fields

Modifier and Type	Field	Description
final Optional<Path>	filePath
final CheckpointInstance.CheckpointFormat	format
static final CheckpointInstance	MAX_VALUE	Placeholder to identify the version that is always the latest on timeline
final Optional<Integer>	numParts
final long	version

Constructor Summary

Constructors

Constructor	Description
CheckpointInstance(long version)
CheckpointInstance(long version, Optional<Integer> numParts)
CheckpointInstance(String path)

Method Summary

Modifier and Type	Method	Description
int	compareTo(CheckpointInstance that)	Comparison rules: 1.
boolean	equals(Object o)
List<Path>	getCorrespondingFiles(Path path)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

MAX_VALUE

public static final CheckpointInstance MAX_VALUE

Placeholder to identify the version that is always the latest on timeline

version

public final long version

numParts

public final Optional<Integer> numParts

format

public final CheckpointInstance.CheckpointFormat format

filePath

public final Optional<Path> filePath

Constructor Details

CheckpointInstance

public CheckpointInstance(String path)

CheckpointInstance

public CheckpointInstance(long version)

CheckpointInstance

public CheckpointInstance(long version,
 Optional<Integer> numParts)

Method Details

getCorrespondingFiles

public List<Path> getCorrespondingFiles(Path path)

compareTo

public int compareTo(CheckpointInstance that)

Comparison rules: 1. A CheckpointInstance with higher version is greater than the one with lower version. 2. A CheckpointInstance for a V2 checkpoint is greater than a classic checkpoint (to filter avoid selecting the compatibility file) or a multipart checkpoint. 3. For CheckpointInstances with same version, a Multi-part checkpoint is greater than a Single part checkpoint. 4. For Multi-part CheckpointInstance corresponding to same version, the one with more parts is greater than the one with fewer parts. 5. For V2 checkpoints, use the file path to break ties.

Specified by:

compareTo in interface Comparable<CheckpointInstance>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object