org.apache.hudi.keygen

Class KeyGenerator

java.lang.Object

org.apache.hudi.keygen.KeyGenerator

All Implemented Interfaces:

Serializable, KeyGeneratorInterface

Direct Known Subclasses:

BaseKeyGenerator

@PublicAPIClass(maturity=STABLE)
public abstract class KeyGenerator
extends Object
implements KeyGeneratorInterface

Abstract class to extend for plugging in extraction of HoodieKey from an Avro record.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected TypedProperties	config

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyGenerator(TypedProperties config)

Method Summary

Modifier and Type	Method and Description
abstract HoodieKey	getKey(org.apache.avro.generic.GenericRecord record) Generate a Hoodie Key out of provided generic record.
List<String>	getRecordKeyFieldNames() Used during bootstrap, to project out only the record key fields from bootstrap source dataset.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final TypedProperties config

Constructor Detail

KeyGenerator

protected KeyGenerator(TypedProperties config)

Method Detail

getKey

@PublicAPIMethod(maturity=STABLE)
public abstract HoodieKey getKey(org.apache.avro.generic.GenericRecord record)

Generate a Hoodie Key out of provided generic record.

Specified by:

getKey in interface KeyGeneratorInterface

getRecordKeyFieldNames

@PublicAPIMethod(maturity=EVOLVING)
public List<String> getRecordKeyFieldNames()

Used during bootstrap, to project out only the record key fields from bootstrap source dataset.

Specified by:

getRecordKeyFieldNames in interface KeyGeneratorInterface

Returns:

list of field names, when concatenated make up the record key.