org.apache.hudi.index

Enum HoodieIndex.IndexType

java.lang.Object

java.lang.Enum<HoodieIndex.IndexType>

org.apache.hudi.index.HoodieIndex.IndexType

All Implemented Interfaces:

Serializable, Comparable<HoodieIndex.IndexType>

Enclosing class:

HoodieIndex<I,O>

@EnumDescription(value="Determines how input records are indexed, i.e., looked up based on the key for the location in the existing table. Default is SIMPLE on Spark engine, and INMEMORY on Flink and Java engines.")
public static enum HoodieIndex.IndexType
extends Enum<HoodieIndex.IndexType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOOM
BUCKET
FLINK_STATE
GLOBAL_BLOOM
GLOBAL_SIMPLE
HBASE
INMEMORY
RECORD_INDEX
SIMPLE

Method Summary

Modifier and Type	Method and Description
static HoodieIndex.IndexType	valueOf(String name) Returns the enum constant of this type with the specified name.
static HoodieIndex.IndexType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HBASE

@EnumFieldDescription(value="uses an external managed Apache HBase table to store record key to location mapping. HBase index is a global index, enforcing key uniqueness across all partitions in the table.")
public static final HoodieIndex.IndexType HBASE

INMEMORY

@EnumFieldDescription(value="Uses in-memory hashmap in Spark and Java engine and Flink in-memory state in Flink for indexing.")
public static final HoodieIndex.IndexType INMEMORY

BLOOM

@EnumFieldDescription(value="Employs bloom filters built out of the record keys, optionally also pruning candidate files using record key ranges. Key uniqueness is enforced inside partitions.")
public static final HoodieIndex.IndexType BLOOM

GLOBAL_BLOOM

@EnumFieldDescription(value="Employs bloom filters built out of the record keys, optionally also pruning candidate files using record key ranges. Key uniqueness is enforced across all partitions in the table. ")
public static final HoodieIndex.IndexType GLOBAL_BLOOM

SIMPLE

@EnumFieldDescription(value="Performs a lean join of the incoming update/delete records against keys extracted from the table on storage.Key uniqueness is enforced inside partitions.")
public static final HoodieIndex.IndexType SIMPLE

GLOBAL_SIMPLE

@EnumFieldDescription(value="Performs a lean join of the incoming update/delete records against keys extracted from the table on storage.Key uniqueness is enforced across all partitions in the table.")
public static final HoodieIndex.IndexType GLOBAL_SIMPLE

BUCKET

@EnumFieldDescription(value="locates the file group containing the record fast by using bucket hashing, particularly beneficial in large scale. Use `hoodie.index.bucket.engine` to choose bucket engine type, i.e., how buckets are generated.")
public static final HoodieIndex.IndexType BUCKET

FLINK_STATE

@EnumFieldDescription(value="Internal Config for indexing based on Flink state.")
public static final HoodieIndex.IndexType FLINK_STATE

RECORD_INDEX

@EnumFieldDescription(value="Index which saves the record key to location mappings in the HUDI Metadata Table. Record index is a global index, enforcing key uniqueness across all partitions in the table. Supports sharding to achieve very high scale.")
public static final HoodieIndex.IndexType RECORD_INDEX

Method Detail

values

public static HoodieIndex.IndexType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HoodieIndex.IndexType c : HoodieIndex.IndexType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HoodieIndex.IndexType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null