org.apache.paimon.operation

Interface FileStoreCommit

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FileStoreCommitImpl

public interface FileStoreCommit
extends AutoCloseable

Commit operation which provides commit and overwrite.

Method Summary

Modifier and Type	Method and Description
void	abort(List<CommitMessage> commitMessages) Abort an unsuccessful commit.
void	close()
void	commit(ManifestCommittable committable, Map<String,String> properties) Commit from manifest committable.
void	commit(ManifestCommittable committable, Map<String,String> properties, boolean checkAppendFiles) Commit from manifest committable with checkAppendFiles.
void	commitStatistics(Statistics stats, long commitIdentifier) Commit new statistics.
void	compactManifest() Compact the manifest entries only.
void	dropPartitions(List<Map<String,String>> partitions, long commitIdentifier) Drop multiple partitions.
FileIO	fileIO()
List<ManifestCommittable>	filterCommitted(List<ManifestCommittable> committables) Find out which committables need to be retried when recovering from the failure.
FileStoreCommit	ignoreEmptyCommit(boolean ignoreEmptyCommit)
void	overwrite(Map<String,String> partition, ManifestCommittable committable, Map<String,String> properties) Overwrite from manifest committable and partition.
FileStorePathFactory	pathFactory()
void	truncateTable(long commitIdentifier)
FileStoreCommit	withLock(Lock lock) With global lock.
FileStoreCommit	withMetrics(CommitMetrics metrics) With metrics to measure commits.
FileStoreCommit	withPartitionExpire(PartitionExpire partitionExpire)

Method Detail

withLock

FileStoreCommit withLock(Lock lock)

With global lock.

ignoreEmptyCommit

FileStoreCommit ignoreEmptyCommit(boolean ignoreEmptyCommit)

withPartitionExpire

FileStoreCommit withPartitionExpire(PartitionExpire partitionExpire)

filterCommitted

List<ManifestCommittable> filterCommitted(List<ManifestCommittable> committables)

Find out which committables need to be retried when recovering from the failure.

commit

void commit(ManifestCommittable committable,
            Map<String,String> properties)

Commit from manifest committable.

commit

void commit(ManifestCommittable committable,
            Map<String,String> properties,
            boolean checkAppendFiles)

Commit from manifest committable with checkAppendFiles.

overwrite

void overwrite(Map<String,String> partition,
               ManifestCommittable committable,
               Map<String,String> properties)

Overwrite from manifest committable and partition.

Parameters:

partition - A single partition maps each partition key to a partition value. Depending on the user-defined statement, the partition might not include all partition keys. Also note that this partition does not necessarily equal to the partitions of the newly added key-values. This is just the partition to be cleaned up.

dropPartitions

void dropPartitions(List<Map<String,String>> partitions,
                    long commitIdentifier)

Drop multiple partitions. The Snapshot.CommitKind of generated snapshot is Snapshot.CommitKind#OVERWRITE.

Parameters:

partitions - A list of partition Maps. NOTE: cannot be empty!

truncateTable

void truncateTable(long commitIdentifier)

compactManifest

void compactManifest()

Compact the manifest entries only.

abort

void abort(List<CommitMessage> commitMessages)

Abort an unsuccessful commit. The data files will be deleted.

withMetrics

FileStoreCommit withMetrics(CommitMetrics metrics)

With metrics to measure commits.

commitStatistics

void commitStatistics(Statistics stats,
                      long commitIdentifier)

Commit new statistics. The Snapshot.CommitKind of generated snapshot is Snapshot.CommitKind#ANALYZE.

pathFactory

FileStorePathFactory pathFactory()

fileIO

FileIO fileIO()

close

void close()

Specified by:

close in interface AutoCloseable