org.apache.hudi.index.bucket

Class HoodieBucketIndex

java.lang.Object

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

org.apache.hudi.index.bucket.HoodieBucketIndex

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HoodieConsistentBucketIndex, HoodieSimpleBucketIndex

public abstract class HoodieBucketIndex
extends HoodieIndex<Object,Object>

Hash indexing mechanism.

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

Modifier and Type	Field and Description
protected List<String>	indexKeyFields
protected int	numBuckets

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

config

Constructor Summary

Constructors

Constructor and Description
HoodieBucketIndex(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.
int	getNumBuckets()
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	requiresTagging(WriteOperationType operationType) To indicate if an operation type requires location tagging before writing
boolean	rollbackCommit(String instantTime) Rollback the effects of the commit made at instantTime.
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, tagLocation, tagLocation, updateLocation, updateLocation

Methods inherited from class java.lang.Object

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

Field Detail

numBuckets

protected final int numBuckets

indexKeyFields

protected final List<String> indexKeyFields

Constructor Detail

HoodieBucketIndex

public HoodieBucketIndex(HoodieWriteConfig config)

Method Detail

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

requiresTagging

public boolean requiresTagging(WriteOperationType operationType)

Description copied from class: HoodieIndex

To indicate if an operation type requires location tagging before writing

Overrides:

requiresTagging in class HoodieIndex<Object,Object>

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>

getNumBuckets

public int getNumBuckets()