org.apache.hudi.common.model

Class HoodieRecord<T>

java.lang.Object

org.apache.hudi.common.model.HoodieRecord<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HoodieAvroRecord

public abstract class HoodieRecord<T>
extends Object
implements Serializable

A Single Record managed by Hoodie.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMIT_SEQNO_METADATA_FIELD
static int	COMMIT_SEQNO_METADATA_FIELD_ORD
static String	COMMIT_TIME_METADATA_FIELD
static int	COMMIT_TIME_METADATA_FIELD_ORD
protected T	data Actual payload of the record.
static int	FILENAME_META_FIELD_ORD
static String	FILENAME_METADATA_FIELD
static String	HOODIE_IS_DELETED
static List<String>	HOODIE_META_COLUMNS
static Map<String,Integer>	HOODIE_META_COLUMNS_NAME_TO_POS
static Set<String>	HOODIE_META_COLUMNS_WITH_OPERATION
static String	OPERATION_METADATA_FIELD
static int	PARTITION_PATH_META_FIELD_ORD
static String	PARTITION_PATH_METADATA_FIELD
static int	RECORD_KEY_META_FIELD_ORD
static String	RECORD_KEY_METADATA_FIELD

Constructor Summary

Constructors

Constructor and Description
HoodieRecord()
HoodieRecord(HoodieKey key, T data)
HoodieRecord(HoodieKey key, T data, HoodieOperation operation)
HoodieRecord(HoodieRecord<T> record)

Method Summary

Modifier and Type	Method and Description
void	checkState()
void	deflate() Release the actual payload, to ease memory pressure.
boolean	equals(Object o)
static String	generateSequenceId(String instantTime, int partitionId, long recordIndex)
HoodieRecordLocation	getCurrentLocation()
T	getData()
HoodieKey	getKey()
Option<HoodieRecordLocation>	getNewLocation()
HoodieOperation	getOperation()
String	getPartitionPath()
String	getRecordKey()
int	hashCode()
boolean	isCurrentLocationKnown()
abstract HoodieRecord<T>	newInstance()
void	seal()
HoodieRecord	setCurrentLocation(HoodieRecordLocation location) Sets the current currentLocation of the record.
HoodieRecord	setNewLocation(HoodieRecordLocation location) Sets the new currentLocation of the record, after being written.
String	toString()
void	unseal()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

COMMIT_TIME_METADATA_FIELD

public static final String COMMIT_TIME_METADATA_FIELD

See Also:

Constant Field Values

COMMIT_SEQNO_METADATA_FIELD

public static final String COMMIT_SEQNO_METADATA_FIELD

See Also:

Constant Field Values

RECORD_KEY_METADATA_FIELD

public static final String RECORD_KEY_METADATA_FIELD

See Also:

Constant Field Values

PARTITION_PATH_METADATA_FIELD

public static final String PARTITION_PATH_METADATA_FIELD

See Also:

Constant Field Values

FILENAME_METADATA_FIELD

public static final String FILENAME_METADATA_FIELD

See Also:

Constant Field Values

OPERATION_METADATA_FIELD

public static final String OPERATION_METADATA_FIELD

See Also:

Constant Field Values

HOODIE_IS_DELETED

public static final String HOODIE_IS_DELETED

See Also:

Constant Field Values

HOODIE_META_COLUMNS

public static final List<String> HOODIE_META_COLUMNS

HOODIE_META_COLUMNS_WITH_OPERATION

public static final Set<String> HOODIE_META_COLUMNS_WITH_OPERATION

HOODIE_META_COLUMNS_NAME_TO_POS

public static final Map<String,Integer> HOODIE_META_COLUMNS_NAME_TO_POS

RECORD_KEY_META_FIELD_ORD

public static int RECORD_KEY_META_FIELD_ORD

PARTITION_PATH_META_FIELD_ORD

public static int PARTITION_PATH_META_FIELD_ORD

FILENAME_META_FIELD_ORD

public static int FILENAME_META_FIELD_ORD

COMMIT_TIME_METADATA_FIELD_ORD

public static int COMMIT_TIME_METADATA_FIELD_ORD

COMMIT_SEQNO_METADATA_FIELD_ORD

public static int COMMIT_SEQNO_METADATA_FIELD_ORD

data

protected T data

Actual payload of the record.

Constructor Detail

HoodieRecord

public HoodieRecord(HoodieKey key,
                    T data)

HoodieRecord

public HoodieRecord(HoodieKey key,
                    T data,
                    HoodieOperation operation)

HoodieRecord

public HoodieRecord(HoodieRecord<T> record)

HoodieRecord

public HoodieRecord()

Method Detail

newInstance

public abstract HoodieRecord<T> newInstance()

getKey

public HoodieKey getKey()

getOperation

public HoodieOperation getOperation()

getData

public T getData()

deflate

public void deflate()

Release the actual payload, to ease memory pressure. To be called after the record has been written to storage. Once deflated, cannot be inflated.

setCurrentLocation

public HoodieRecord setCurrentLocation(HoodieRecordLocation location)

Sets the current currentLocation of the record. This should happen exactly-once

getCurrentLocation

public HoodieRecordLocation getCurrentLocation()

setNewLocation

public HoodieRecord setNewLocation(HoodieRecordLocation location)

Sets the new currentLocation of the record, after being written. This again should happen exactly-once.

getNewLocation

public Option<HoodieRecordLocation> getNewLocation()

isCurrentLocationKnown

public boolean isCurrentLocationKnown()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

generateSequenceId

public static String generateSequenceId(String instantTime,
                                        int partitionId,
                                        long recordIndex)

getPartitionPath

public String getPartitionPath()

getRecordKey

public String getRecordKey()

seal

public void seal()

unseal

public void unseal()

checkState

public void checkState()