org.apache.hudi.common.model

Class HoodiePartitionMetadata

java.lang.Object

org.apache.hudi.common.model.HoodiePartitionMetadata

public class HoodiePartitionMetadata
extends Object

The metadata that goes into the meta file in each partition.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMIT_TIME_KEY
static String	HOODIE_PARTITION_METAFILE_PREFIX

Constructor Summary

Constructors

Constructor and Description
HoodiePartitionMetadata(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path partitionPath) Construct metadata from existing partition.
HoodiePartitionMetadata(org.apache.hadoop.fs.FileSystem fs, String instantTime, org.apache.hadoop.fs.Path basePath, org.apache.hadoop.fs.Path partitionPath, Option<HoodieFileFormat> format) Construct metadata object to be written out.

Method Summary

Modifier and Type	Method and Description
static Option<org.apache.hadoop.fs.Path>	baseFormatMetaPathIfExists(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path partitionPath)
int	getPartitionDepth()
static Option<org.apache.hadoop.fs.Path>	getPartitionMetafilePath(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path partitionPath) Returns the name of the partition metadata.
static boolean	hasPartitionMetadata(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path partitionPath)
void	readFromFS() Read out the metadata for this partition.
Option<String>	readPartitionCreatedCommitTime() Read out the COMMIT_TIME_KEY metadata for this partition.
static Option<org.apache.hadoop.fs.Path>	textFormatMetaPathIfExists(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path partitionPath)
void	trySave(int taskPartitionId) Write the metadata safely into partition atomically.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HOODIE_PARTITION_METAFILE_PREFIX

public static final String HOODIE_PARTITION_METAFILE_PREFIX

See Also:

Constant Field Values

COMMIT_TIME_KEY

public static final String COMMIT_TIME_KEY

See Also:

Constant Field Values

Constructor Detail

HoodiePartitionMetadata

public HoodiePartitionMetadata(org.apache.hadoop.fs.FileSystem fs,
                               org.apache.hadoop.fs.Path partitionPath)

Construct metadata from existing partition.

HoodiePartitionMetadata

public HoodiePartitionMetadata(org.apache.hadoop.fs.FileSystem fs,
                               String instantTime,
                               org.apache.hadoop.fs.Path basePath,
                               org.apache.hadoop.fs.Path partitionPath,
                               Option<HoodieFileFormat> format)

Construct metadata object to be written out.

Method Detail

getPartitionDepth

public int getPartitionDepth()

trySave

public void trySave(int taskPartitionId)

Write the metadata safely into partition atomically.

readFromFS

public void readFromFS()
                throws IOException

Read out the metadata for this partition.

Throws:

IOException

readPartitionCreatedCommitTime

public Option<String> readPartitionCreatedCommitTime()

Read out the COMMIT_TIME_KEY metadata for this partition.

hasPartitionMetadata

public static boolean hasPartitionMetadata(org.apache.hadoop.fs.FileSystem fs,
                                           org.apache.hadoop.fs.Path partitionPath)

getPartitionMetafilePath

public static Option<org.apache.hadoop.fs.Path> getPartitionMetafilePath(org.apache.hadoop.fs.FileSystem fs,
                                                                         org.apache.hadoop.fs.Path partitionPath)

Returns the name of the partition metadata.

Returns:

Name of the partition metafile or empty option

baseFormatMetaPathIfExists

public static Option<org.apache.hadoop.fs.Path> baseFormatMetaPathIfExists(org.apache.hadoop.fs.FileSystem fs,
                                                                           org.apache.hadoop.fs.Path partitionPath)
                                                                    throws IOException

Throws:

IOException

textFormatMetaPathIfExists

public static Option<org.apache.hadoop.fs.Path> textFormatMetaPathIfExists(org.apache.hadoop.fs.FileSystem fs,
                                                                           org.apache.hadoop.fs.Path partitionPath)
                                                                    throws IOException

Throws:

IOException