Uses of Package
org.apache.hudi.common.model

Packages that use org.apache.hudi.common.model

Package	Description
org.apache.hudi
org.apache.hudi.avro
org.apache.hudi.common
org.apache.hudi.common.bootstrap.index
org.apache.hudi.common.bootstrap.index.hfile
org.apache.hudi.common.config
org.apache.hudi.common.engine
org.apache.hudi.common.fs
org.apache.hudi.common.model
org.apache.hudi.common.model.debezium
org.apache.hudi.common.table
org.apache.hudi.common.table.cdc
org.apache.hudi.common.table.log
org.apache.hudi.common.table.log.block
org.apache.hudi.common.table.read
org.apache.hudi.common.table.timeline
org.apache.hudi.common.table.timeline.dto
org.apache.hudi.common.table.view
org.apache.hudi.common.util
org.apache.hudi.exception
org.apache.hudi.io.storage
org.apache.hudi.keygen
org.apache.hudi.metadata

Classes in org.apache.hudi.common.model used by org.apache.hudi

Class and Description
FileSlice Within a file group, a slice is a combination of data file written at a commit time and list of log files, containing changes to the data file from that commit time.
HoodieTableQueryType Hudi table could be queried in one of the 3 following ways: Snapshot: snapshot of the table at the given (latest if not provided) instant is queried Read Optimized (MOR only): snapshot of the table at the given (latest if not provided) instant is queried, but w/o reading any of the delta-log files (only reading base-files) Incremental: only records added w/in the given time-window (defined by beginning and ending instant) are queried

Classes in org.apache.hudi.common.model used by org.apache.hudi.avro

Class and Description
HoodieOperation Represents the changes that a row can describe in a changelog.
HoodieRecord A Single Record managed by Hoodie.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common

Class and Description
HoodieCleaningPolicy Hoodie cleaning policies.
HoodieRecordPayload Every Hoodie table has an implementation of the HoodieRecordPayload This abstracts out callbacks which depend on record specific logic.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.bootstrap.index

Class and Description
BootstrapFileMapping Value stored in the bootstrap index.
HoodieFileGroupId Unique ID to identify a file-group in a data-set.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.bootstrap.index.hfile

Class and Description
BootstrapFileMapping Value stored in the bootstrap index.
HoodieFileGroupId Unique ID to identify a file-group in a data-set.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.config

Class and Description
ActionType The supported action types.
HoodieIndexDefinition Class representing the metadata for a functional or secondary index in Hudi.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.engine

Class and Description
HoodieRecord A Single Record managed by Hoodie.
HoodieRecordMerger HoodieMerge defines how to merge two records.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.fs

Class and Description
HoodieLogFile Abstracts a single log file.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.model

Class and Description
ActionType The supported action types.
BaseAvroPayload Base class for all AVRO record based payloads, that can be ordered based on a field.
BaseFile Represents common metadata about base-file.
BootstrapFileMapping Value stored in the bootstrap index.
BootstrapIndexType
ClusteringGroupInfo Encapsulates all the needed information about a clustering group.
ClusteringOperation Encapsulates all the needed information about a clustering file slice.
CompactionOperation Encapsulates all the needed information about a compaction and make a decision whether this compaction is effective or not.
ConsistentHashingNode Used in consistent hashing index, representing nodes in the consistent hash ring.
ConsistentHashingNode.NodeTag Node tag.
DefaultHoodieRecordPayload Default payload.
DeleteRecord Delete record is a combination of HoodieKey and ordering value.
EmptyHoodieRecordPayload Empty payload used for deletions.
FileSlice Within a file group, a slice is a combination of data file written at a commit time and list of log files, containing changes to the data file from that commit time.
HoodieAvroIndexedRecord This only use by reader returning.
HoodieAvroPayload This is a payload to wrap a existing Hoodie Avro Record.
HoodieAvroRecordMerger Record merger for Hoodie avro record.
HoodieBaseFile Hoodie base file - Represents metadata about Hudi file in DFS.
HoodieCleaningPolicy Hoodie cleaning policies.
HoodieColumnRangeMetadata Hoodie metadata for the column range of data stored in columnar format (like Parquet) NOTE: Comparable is used as raw-type so that we can handle polymorphism, where caller apriori is not aware of the type HoodieColumnRangeMetadata is associated with
HoodieCommitMetadata All the metadata that gets stored along with a commit.
HoodieConsistentHashingMetadata All the metadata that is used for consistent hashing bucket index
HoodieDeltaWriteStat Statistics about a single Hoodie delta log operation.
HoodieFailedWritesCleaningPolicy Policy controlling how to perform cleaning for failed writes.
HoodieFileFormat Hoodie file format.
HoodieFileGroup A set of data/base files + set of log files, that make up a unit for all operations.
HoodieFileGroupId Unique ID to identify a file-group in a data-set.
HoodieIndexDefinition Class representing the metadata for a functional or secondary index in Hudi.
HoodieIndexMetadata Represents the metadata for all functional and secondary indexes in Hudi.
HoodieKey HoodieKey consists of
HoodieLogFile Abstracts a single log file.
HoodieLSMTimelineManifest Manifest entry for a version snapshot of the archived timeline.
HoodieLSMTimelineManifest.LSMFileEntry A file entry.
HoodieMetadataRecordMerger Record merger that accumulates metadata records.
HoodieOperation Represents the changes that a row can describe in a changelog.
HoodiePreCombineAvroRecordMerger Record merger for Hoodie avro record.
HoodieRecord A Single Record managed by Hoodie.
HoodieRecord.HoodieMetadataField
HoodieRecord.HoodieRecordType
HoodieRecordCompatibilityInterface
HoodieRecordDelegate Delegate for HoodieRecord.
HoodieRecordGlobalLocation Similar with HoodieRecordLocation but with partition path.
HoodieRecordLocation Location of a HoodieRecord within the partition it belongs to.
HoodieRecordMerger HoodieMerge defines how to merge two records.
HoodieRecordPayload Every Hoodie table has an implementation of the HoodieRecordPayload This abstracts out callbacks which depend on record specific logic.
HoodieRollingStat A model class defines hoodie rolling stat.
HoodieRollingStatMetadata This class holds statistics about files belonging to a table.
HoodieSyncTableStrategy Hoodie table synchronization strategy.
HoodieTableQueryType Hudi table could be queried in one of the 3 following ways: Snapshot: snapshot of the table at the given (latest if not provided) instant is queried Read Optimized (MOR only): snapshot of the table at the given (latest if not provided) instant is queried, but w/o reading any of the delta-log files (only reading base-files) Incremental: only records added w/in the given time-window (defined by beginning and ending instant) are queried
HoodieTableType Type of the Hoodie Table.
HoodieTimelineTimeZone Hoodie TimelineZone.
HoodieWriteStat Statistics about a single Hoodie write operation.
HoodieWriteStat.RuntimeStats The runtime stats for writing operation.
IOType Types of lower level I/O operations done on each file slice.
MetadataValues
OperationModeAwareness In some cases, the Hudi engine needs to know what operation mode the current merging belongs to.
OverwriteNonDefaultsWithLatestAvroPayload subclass of OverwriteWithLatestAvroPayload.
OverwriteWithLatestAvroPayload preCombine - Picks the latest delta record for a key, based on an ordering field; combineAndGetUpdateValue/getInsertValue - Simply overwrites storage with latest delta record
PartialUpdateAvroPayload Payload clazz that is used for partial update Hudi Table.
RecordPayloadType Payload to use for record.
RewriteAvroPayload Default payload used for rewrite use cases where we don't change schema.
TableServiceType Supported runtime table services.
WriteConcurrencyMode Different concurrency modes for write operations.
WriteOperationType The supported write operation types, used by commitMetadata.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.model.debezium

Class and Description
BaseAvroPayload Base class for all AVRO record based payloads, that can be ordered based on a field.
HoodieRecordPayload Every Hoodie table has an implementation of the HoodieRecordPayload This abstracts out callbacks which depend on record specific logic.
OverwriteWithLatestAvroPayload preCombine - Picks the latest delta record for a key, based on an ordering field; combineAndGetUpdateValue/getInsertValue - Simply overwrites storage with latest delta record

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.table

Class and Description
HoodieFileFormat Hoodie file format.
HoodieIndexMetadata Represents the metadata for all functional and secondary indexes in Hudi.
HoodieRecordPayload Every Hoodie table has an implementation of the HoodieRecordPayload This abstracts out callbacks which depend on record specific logic.
HoodieTableType Type of the Hoodie Table.
HoodieTimelineTimeZone Hoodie TimelineZone.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.table.cdc

Class and Description
FileSlice Within a file group, a slice is a combination of data file written at a commit time and list of log files, containing changes to the data file from that commit time.
HoodieFileGroupId Unique ID to identify a file-group in a data-set.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.table.log

Class and Description
DeleteRecord Delete record is a combination of HoodieKey and ordering value.
HoodieLogFile Abstracts a single log file.
HoodieRecord A Single Record managed by Hoodie.
HoodieRecord.HoodieRecordType
HoodieRecordMerger HoodieMerge defines how to merge two records.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.table.log.block

Class and Description
DeleteRecord Delete record is a combination of HoodieKey and ordering value.
HoodieLogFile Abstracts a single log file.
HoodieRecord A Single Record managed by Hoodie.
HoodieRecord.HoodieRecordType

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.table.read

Class and Description
DeleteRecord Delete record is a combination of HoodieKey and ordering value.
FileSlice Within a file group, a slice is a combination of data file written at a commit time and list of log files, containing changes to the data file from that commit time.
HoodieRecordMerger HoodieMerge defines how to merge two records.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.table.timeline

Class and Description
HoodieCommitMetadata All the metadata that gets stored along with a commit.
HoodieLSMTimelineManifest Manifest entry for a version snapshot of the archived timeline.
HoodieTimelineTimeZone Hoodie TimelineZone.
WriteOperationType The supported write operation types, used by commitMetadata.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.table.timeline.dto

Class and Description
BaseFile Represents common metadata about base-file.
CompactionOperation Encapsulates all the needed information about a compaction and make a decision whether this compaction is effective or not.
FileSlice Within a file group, a slice is a combination of data file written at a commit time and list of log files, containing changes to the data file from that commit time.
HoodieBaseFile Hoodie base file - Represents metadata about Hudi file in DFS.
HoodieFileGroup A set of data/base files + set of log files, that make up a unit for all operations.
HoodieFileGroupId Unique ID to identify a file-group in a data-set.
HoodieLogFile Abstracts a single log file.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.table.view

Class and Description
BootstrapBaseFileMapping POJO storing (partitionPath, hoodieFileId) -> external base file path.
CompactionOperation Encapsulates all the needed information about a compaction and make a decision whether this compaction is effective or not.
FileSlice Within a file group, a slice is a combination of data file written at a commit time and list of log files, containing changes to the data file from that commit time.
HoodieBaseFile Hoodie base file - Represents metadata about Hudi file in DFS.
HoodieFileGroup A set of data/base files + set of log files, that make up a unit for all operations.
HoodieFileGroupId Unique ID to identify a file-group in a data-set.
HoodieLogFile Abstracts a single log file.
HoodieWriteStat Statistics about a single Hoodie write operation.

Classes in org.apache.hudi.common.model used by org.apache.hudi.common.util

Class and Description
CleanFileInfo File info for clean action.
CompactionOperation Encapsulates all the needed information about a compaction and make a decision whether this compaction is effective or not.
FileSlice Within a file group, a slice is a combination of data file written at a commit time and list of log files, containing changes to the data file from that commit time.
HoodieCleaningPolicy Hoodie cleaning policies.
HoodieColumnRangeMetadata Hoodie metadata for the column range of data stored in columnar format (like Parquet) NOTE: Comparable is used as raw-type so that we can handle polymorphism, where caller apriori is not aware of the type HoodieColumnRangeMetadata is associated with
HoodieCommitMetadata All the metadata that gets stored along with a commit.
HoodieFailedWritesCleaningPolicy Policy controlling how to perform cleaning for failed writes.
HoodieFileFormat Hoodie file format.
HoodieFileGroup A set of data/base files + set of log files, that make up a unit for all operations.
HoodieFileGroupId Unique ID to identify a file-group in a data-set.
HoodieKey HoodieKey consists of
HoodieRecord A Single Record managed by Hoodie.
HoodieRecord.HoodieRecordType
HoodieRecordMerger HoodieMerge defines how to merge two records.
HoodieRecordPayload Every Hoodie table has an implementation of the HoodieRecordPayload This abstracts out callbacks which depend on record specific logic.
HoodieTableType Type of the Hoodie Table.
HoodieTimelineTimeZone Hoodie TimelineZone.
HoodieWriteStat Statistics about a single Hoodie write operation.
WriteOperationType The supported write operation types, used by commitMetadata.

Classes in org.apache.hudi.common.model used by org.apache.hudi.exception

Class and Description
HoodieRecord A Single Record managed by Hoodie.

Classes in org.apache.hudi.common.model used by org.apache.hudi.io.storage

Class and Description
HoodieFileFormat Hoodie file format.
HoodieKey HoodieKey consists of
HoodieRecord A Single Record managed by Hoodie.
HoodieRecord.HoodieRecordType

Classes in org.apache.hudi.common.model used by org.apache.hudi.keygen

Class and Description
HoodieKey HoodieKey consists of

Classes in org.apache.hudi.common.model used by org.apache.hudi.metadata

Class and Description
FileSlice Within a file group, a slice is a combination of data file written at a commit time and list of log files, containing changes to the data file from that commit time.
HoodieBaseFile Hoodie base file - Represents metadata about Hudi file in DFS.
HoodieColumnRangeMetadata Hoodie metadata for the column range of data stored in columnar format (like Parquet) NOTE: Comparable is used as raw-type so that we can handle polymorphism, where caller apriori is not aware of the type HoodieColumnRangeMetadata is associated with
HoodieCommitMetadata All the metadata that gets stored along with a commit.
HoodieIndexDefinition Class representing the metadata for a functional or secondary index in Hudi.
HoodieLogFile Abstracts a single log file.
HoodieRecord A Single Record managed by Hoodie.
HoodieRecordGlobalLocation Similar with HoodieRecordLocation but with partition path.
HoodieRecordPayload Every Hoodie table has an implementation of the HoodieRecordPayload This abstracts out callbacks which depend on record specific logic.