org.apache.hudi.keygen.constant

Enum KeyGeneratorType

java.lang.Object

java.lang.Enum<KeyGeneratorType>

org.apache.hudi.keygen.constant.KeyGeneratorType

All Implemented Interfaces:

Serializable, Comparable<KeyGeneratorType>

@EnumDescription(value="Key generator type, indicating the key generator class to use, that implements `org.apache.hudi.keygen.KeyGenerator`.")
public enum KeyGeneratorType
extends Enum<KeyGeneratorType>

Types of KeyGenerator.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_RECORD
AUTO_RECORD_AVRO
COMPLEX
COMPLEX_AVRO
CUSTOM
CUSTOM_AVRO
GLOBAL_DELETE
GLOBAL_DELETE_AVRO
HOODIE_TABLE_METADATA
NON_PARTITION
NON_PARTITION_AVRO
SIMPLE
SIMPLE_AVRO
SPARK_SQL
SPARK_SQL_MERGE_INTO
SPARK_SQL_UUID
STREAMER_TEST
TIMESTAMP
TIMESTAMP_AVRO

Method Summary

Modifier and Type	Method and Description
static KeyGeneratorType	fromClassName(String className)
String	getClassName()
static String	getKeyGeneratorClassName(HoodieConfig config)
static List<String>	getNames()
static KeyGeneratorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyGeneratorType[]	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

SIMPLE

@EnumFieldDescription(value="Simple key generator, which takes names of fields to be used for recordKey and partitionPath as configs.")
public static final KeyGeneratorType SIMPLE

SIMPLE_AVRO

@EnumFieldDescription(value="Simple key generator, which takes names of fields to be used for recordKey and partitionPath as configs.")
public static final KeyGeneratorType SIMPLE_AVRO

COMPLEX

@EnumFieldDescription(value="Complex key generator, which takes names of fields to be used for recordKey and partitionPath as configs.")
public static final KeyGeneratorType COMPLEX

COMPLEX_AVRO

@EnumFieldDescription(value="Complex key generator, which takes names of fields to be used for recordKey and partitionPath as configs.")
public static final KeyGeneratorType COMPLEX_AVRO

TIMESTAMP

@EnumFieldDescription(value="Timestamp-based key generator, that relies on timestamps for partitioning field. Still picks record key by name.")
public static final KeyGeneratorType TIMESTAMP

TIMESTAMP_AVRO

@EnumFieldDescription(value="Timestamp-based key generator, that relies on timestamps for partitioning field. Still picks record key by name.")
public static final KeyGeneratorType TIMESTAMP_AVRO

CUSTOM

@EnumFieldDescription(value="This is a generic implementation type of KeyGenerator where users can configure record key as a single field or  a combination of fields. Similarly partition path can be configured to have multiple fields or only one field.  This KeyGenerator expects value for prop \"hoodie.datasource.write.partitionpath.field\" in a specific format.  For example:  properties.put(\"hoodie.datasource.write.partitionpath.field\", \"field1:PartitionKeyType1,field2:PartitionKeyType2\").")
public static final KeyGeneratorType CUSTOM

CUSTOM_AVRO

@EnumFieldDescription(value="This is a generic implementation type of KeyGenerator where users can configure record key as a single field or  a combination of fields. Similarly partition path can be configured to have multiple fields or only one field.  This KeyGenerator expects value for prop \"hoodie.datasource.write.partitionpath.field\" in a specific format.  For example:  properties.put(\"hoodie.datasource.write.partitionpath.field\", \"field1:PartitionKeyType1,field2:PartitionKeyType2\").")
public static final KeyGeneratorType CUSTOM_AVRO

NON_PARTITION

@EnumFieldDescription(value="Simple Key generator for non-partitioned tables.")
public static final KeyGeneratorType NON_PARTITION

NON_PARTITION_AVRO

@EnumFieldDescription(value="Simple Key generator for non-partitioned tables.")
public static final KeyGeneratorType NON_PARTITION_AVRO

GLOBAL_DELETE

@EnumFieldDescription(value="Key generator for deletes using global indices.")
public static final KeyGeneratorType GLOBAL_DELETE

GLOBAL_DELETE_AVRO

@EnumFieldDescription(value="Key generator for deletes using global indices.")
public static final KeyGeneratorType GLOBAL_DELETE_AVRO

AUTO_RECORD

@EnumFieldDescription(value="Automatic record key generation.")
public static final KeyGeneratorType AUTO_RECORD

AUTO_RECORD_AVRO

@EnumFieldDescription(value="Automatic record key generation.")
public static final KeyGeneratorType AUTO_RECORD_AVRO

HOODIE_TABLE_METADATA

@EnumFieldDescription(value="Custom key generator for the Hudi table metadata.")
public static final KeyGeneratorType HOODIE_TABLE_METADATA

SPARK_SQL

@EnumFieldDescription(value="Custom spark-sql specific KeyGenerator overriding behavior handling TimestampType partition values.")
public static final KeyGeneratorType SPARK_SQL

SPARK_SQL_UUID

@EnumFieldDescription(value="A KeyGenerator which use the uuid as the record key.")
public static final KeyGeneratorType SPARK_SQL_UUID

SPARK_SQL_MERGE_INTO

@EnumFieldDescription(value="Meant to be used internally for the spark sql MERGE INTO command.")
public static final KeyGeneratorType SPARK_SQL_MERGE_INTO

STREAMER_TEST

@EnumFieldDescription(value="A test KeyGenerator for deltastreamer tests.")
public static final KeyGeneratorType STREAMER_TEST

Method Detail

values

public static KeyGeneratorType[] 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 (KeyGeneratorType c : KeyGeneratorType.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeyGeneratorType 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

getClassName

public String getClassName()

fromClassName

public static KeyGeneratorType fromClassName(String className)

getNames

public static List<String> getNames()

getKeyGeneratorClassName

@Nullable
public static String getKeyGeneratorClassName(HoodieConfig config)