org.apache.hudi.metadata

Interface HoodieTableMetadataWriter

All Superinterfaces:

AutoCloseable, Serializable

All Known Implementing Classes:

HoodieBackedTableMetadataWriter

public interface HoodieTableMetadataWriter
extends Serializable, AutoCloseable

Interface that supports updating metadata for a given table, as actions complete.

Method Summary

Modifier and Type	Method and Description
void	buildMetadataPartitions(HoodieEngineContext engineContext, List<HoodieIndexPartitionInfo> indexPartitionInfos) Builds the given metadata partitions to create index.
void	deletePartitions(String instantTime, List<MetadataPartitionType> partitions) Deletes the given metadata partitions.
void	dropMetadataPartitions(List<MetadataPartitionType> metadataPartitions) Drop the given metadata partitions.
boolean	isInitialized() Returns true if the metadata table is initialized.
void	performTableServices(Option<String> inFlightInstantTimestamp) Perform various table services like compaction, cleaning, archiving on the MDT if required.
void	update(HoodieCleanMetadata cleanMetadata, String instantTime) Update the metadata table due to a CLEAN operation.
void	update(HoodieCommitMetadata commitMetadata, HoodieData<WriteStatus> writeStatuses, String instantTime) Update the metadata table due to a COMMIT operation.
void	update(HoodieRestoreMetadata restoreMetadata, String instantTime) Update the metadata table due to a RESTORE operation.
void	update(HoodieRollbackMetadata rollbackMetadata, String instantTime) Update the metadata table due to a ROLLBACK operation.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

buildMetadataPartitions

void buildMetadataPartitions(HoodieEngineContext engineContext,
                             List<HoodieIndexPartitionInfo> indexPartitionInfos)
                      throws IOException

Builds the given metadata partitions to create index.

Parameters:

engineContext -

indexPartitionInfos - - information about partitions to build such as partition type and base instant time

Throws:

IOException

dropMetadataPartitions

void dropMetadataPartitions(List<MetadataPartitionType> metadataPartitions)
                     throws IOException

Drop the given metadata partitions.

Parameters:

metadataPartitions - List of MDT partitions to drop

Throws:

IOException - on failures

update

void update(HoodieCommitMetadata commitMetadata,
            HoodieData<WriteStatus> writeStatuses,
            String instantTime)

Update the metadata table due to a COMMIT operation.

Parameters:

commitMetadata - commit metadata of the operation of interest.

instantTime - instant time of the commit.

update

void update(HoodieCleanMetadata cleanMetadata,
            String instantTime)

Update the metadata table due to a CLEAN operation.

Parameters:

cleanMetadata - clean metadata of the operation of interest.

instantTime - instant time of the commit.

update

void update(HoodieRestoreMetadata restoreMetadata,
            String instantTime)

Update the metadata table due to a RESTORE operation.

Parameters:

restoreMetadata - restore metadata of the operation of interest.

instantTime - instant time of the commit.

update

void update(HoodieRollbackMetadata rollbackMetadata,
            String instantTime)

Update the metadata table due to a ROLLBACK operation.

Parameters:

rollbackMetadata - rollback metadata of the operation of interest.

instantTime - instant time of the commit.

deletePartitions

void deletePartitions(String instantTime,
                      List<MetadataPartitionType> partitions)

Deletes the given metadata partitions. This path reuses DELETE_PARTITION operation.

Parameters:

instantTime - - instant time when replacecommit corresponding to the drop will be recorded in the metadata timeline

partitions - - list of MetadataPartitionType to drop

isInitialized

boolean isInitialized()

Returns true if the metadata table is initialized.

performTableServices

void performTableServices(Option<String> inFlightInstantTimestamp)

Perform various table services like compaction, cleaning, archiving on the MDT if required.

Parameters:

inFlightInstantTimestamp - Timestamp of an instant which is in-progress. This instant is ignored while deciding if optimizations can be performed.