org.apache.hudi.index.simple

Class HoodieGlobalSimpleIndex

java.lang.Object

org.apache.hudi.index.HoodieIndex<Object,Object>

org.apache.hudi.index.simple.HoodieSimpleIndex

org.apache.hudi.index.simple.HoodieGlobalSimpleIndex

All Implemented Interfaces:

Serializable

public class HoodieGlobalSimpleIndex
extends HoodieSimpleIndex

A global simple index which reads interested fields(record key and partition path) from base files and joins with incoming records to find the tagged location.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hudi.index.HoodieIndex

HoodieIndex.BucketIndexEngineType, HoodieIndex.IndexType

Field Summary

Fields inherited from class org.apache.hudi.index.simple.HoodieSimpleIndex

keyGeneratorOpt

Fields inherited from class org.apache.hudi.index.HoodieIndex

config

Constructor Summary

Constructors

Constructor and Description
HoodieGlobalSimpleIndex(HoodieWriteConfig config, Option<BaseKeyGenerator> keyGeneratorOpt)

Method Summary

Modifier and Type	Method and Description
boolean	isGlobal() An index is `global` if HoodieKey to fileID mapping, does not depend on the `partitionPath`.
<R> HoodieData<HoodieRecord<R>>	tagLocation(HoodieData<HoodieRecord<R>> records, HoodieEngineContext context, HoodieTable hoodieTable) Looks up the index and tags each incoming record with a location of a file that contains the row (if it is actually present).
protected <R> HoodieData<HoodieRecord<R>>	tagLocationInternal(HoodieData<HoodieRecord<R>> inputRecords, HoodieEngineContext context, HoodieTable hoodieTable) Tags records location for incoming records.

Methods inherited from class org.apache.hudi.index.simple.HoodieSimpleIndex

canIndexLogFiles, fetchRecordLocations, fetchRecordLocationsForAffectedPartitions, isImplicitWithStorage, rollbackCommit, updateLocation

Methods inherited from class org.apache.hudi.index.HoodieIndex

close, requiresTagging, tagLocation, updateLocation, updateLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

HoodieGlobalSimpleIndex

public HoodieGlobalSimpleIndex(HoodieWriteConfig config,
                               Option<BaseKeyGenerator> keyGeneratorOpt)

Method Detail

tagLocation

public <R> HoodieData<HoodieRecord<R>> tagLocation(HoodieData<HoodieRecord<R>> records,
                                                   HoodieEngineContext context,
                                                   HoodieTable hoodieTable)

Description copied from class: HoodieIndex

Looks up the index and tags each incoming record with a location of a file that contains the row (if it is actually present).

Overrides:

tagLocation in class HoodieSimpleIndex

tagLocationInternal

protected <R> HoodieData<HoodieRecord<R>> tagLocationInternal(HoodieData<HoodieRecord<R>> inputRecords,
                                                              HoodieEngineContext context,
                                                              HoodieTable hoodieTable)

Tags records location for incoming records.

Overrides:

tagLocationInternal in class HoodieSimpleIndex

Parameters:

inputRecords - HoodieData of incoming records

context - instance of HoodieEngineContext to use

hoodieTable - instance of HoodieTable to use

Returns:

HoodieData of records with record locations set

isGlobal

public boolean isGlobal()

Description copied from class: HoodieIndex

An index is `global` if HoodieKey to fileID mapping, does not depend on the `partitionPath`. Such an implementation is able to obtain the same mapping, for two hoodie keys with same `recordKey` but different `partitionPath`

Overrides:

isGlobal in class HoodieSimpleIndex

Returns:

whether the index implementation is global in nature