org.apache.hudi.keygen

Class BaseKeyGenerator

java.lang.Object

org.apache.hudi.keygen.KeyGenerator

org.apache.hudi.keygen.BaseKeyGenerator

All Implemented Interfaces:

Serializable, KeyGeneratorInterface

public abstract class BaseKeyGenerator
extends KeyGenerator

Base abstract class to extend for KeyGenerator with default logic of taking partitioning and timestamp configs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	consistentLogicalTimestampEnabled
static String	EMPTY_PARTITION
protected boolean	encodePartitionPath
protected boolean	hiveStylePartitioning
protected List<String>	partitionPathFields
protected List<String>	recordKeyFields

Fields inherited from class org.apache.hudi.keygen.KeyGenerator

config

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseKeyGenerator(TypedProperties config)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_PARTITION

public static final String EMPTY_PARTITION

See Also:

Constant Field Values

recordKeyFields

protected List<String> recordKeyFields

partitionPathFields

protected List<String> partitionPathFields

encodePartitionPath

protected final boolean encodePartitionPath

hiveStylePartitioning

protected final boolean hiveStylePartitioning

consistentLogicalTimestampEnabled

protected final boolean consistentLogicalTimestampEnabled

Constructor Detail

BaseKeyGenerator

protected BaseKeyGenerator(TypedProperties config)

Method Detail

getRecordKey

public abstract String getRecordKey(org.apache.avro.generic.GenericRecord record)

Generate a record Key out of provided generic record.

getPartitionPath

public abstract String getPartitionPath(org.apache.avro.generic.GenericRecord record)

Generate a partition path out of provided generic record.

getKey

public final HoodieKey getKey(org.apache.avro.generic.GenericRecord record)

Generate a Hoodie Key out of provided generic record.

Specified by:

getKey in interface KeyGeneratorInterface

Specified by:

getKey in class KeyGenerator

getRecordKeyFieldNames

public List<String> getRecordKeyFieldNames()

Description copied from class: KeyGenerator

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

Specified by:

getRecordKeyFieldNames in interface KeyGeneratorInterface

Overrides:

getRecordKeyFieldNames in class KeyGenerator

Returns:

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

getPartitionPathFields

public List<String> getPartitionPathFields()

isConsistentLogicalTimestampEnabled

public boolean isConsistentLogicalTimestampEnabled()