org.apache.hudi.index

Class HoodieInternalProxyIndex

java.lang.Object

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

org.apache.hudi.index.HoodieInternalProxyIndex

All Implemented Interfaces:

Serializable

public class HoodieInternalProxyIndex
extends HoodieIndex<Object,Object>

Index that does not do tagging. Its purpose is to be used for Spark sql Merge into command Merge into does not need to use index lookup because we get the location from the meta columns from the join. The reason why we can't use the prepped path is because we sometimes need to do a mix of updates and inserts and prepped only handles existing records

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.HoodieIndex

config

Constructor Summary

Constructors

Constructor and Description
HoodieInternalProxyIndex(HoodieWriteConfig config)

Method Summary

Modifier and Type	Method and Description
boolean	canIndexLogFiles() This is used by storage to determine, if it is safe to send inserts, straight to the log, i.e.
boolean	isGlobal() An index is `global` if HoodieKey to fileID mapping, does not depend on the `partitionPath`.
boolean	isImplicitWithStorage() An index is "implicit" with respect to storage, if just writing new data to a file slice, updates the index as well.
boolean	rollbackCommit(String instantTime) Rollback the effects of the commit made at instantTime.
<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).
HoodieData<WriteStatus>	updateLocation(HoodieData<WriteStatus> writeStatuses, HoodieEngineContext context, HoodieTable hoodieTable) Extracts the location of written records, and updates the index.

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

HoodieInternalProxyIndex

public HoodieInternalProxyIndex(HoodieWriteConfig config)

Method Detail

tagLocation

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

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).

Specified by:

tagLocation in class HoodieIndex<Object,Object>

Throws:

HoodieIndexException

updateLocation

public HoodieData<WriteStatus> updateLocation(HoodieData<WriteStatus> writeStatuses,
                                              HoodieEngineContext context,
                                              HoodieTable hoodieTable)
                                       throws HoodieIndexException

Description copied from class: HoodieIndex

Extracts the location of written records, and updates the index.

Specified by:

updateLocation in class HoodieIndex<Object,Object>

Throws:

HoodieIndexException

rollbackCommit

public boolean rollbackCommit(String instantTime)

Description copied from class: HoodieIndex

Rollback the effects of the commit made at instantTime.

Specified by:

rollbackCommit in class HoodieIndex<Object,Object>

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`

Specified by:

isGlobal in class HoodieIndex<Object,Object>

Returns:

whether the index implementation is global in nature

canIndexLogFiles

public boolean canIndexLogFiles()

Description copied from class: HoodieIndex

This is used by storage to determine, if it is safe to send inserts, straight to the log, i.e. having a FileSlice, with no data file.

Specified by:

canIndexLogFiles in class HoodieIndex<Object,Object>

Returns:

Returns true/false depending on whether the impl has this capability

isImplicitWithStorage

public boolean isImplicitWithStorage()

Description copied from class: HoodieIndex

An index is "implicit" with respect to storage, if just writing new data to a file slice, updates the index as well. This is used by storage, to save memory footprint in certain cases.

Specified by:

isImplicitWithStorage in class HoodieIndex<Object,Object>