org.apache.paimon

Class KeyValue

java.lang.Object

org.apache.paimon.KeyValue

public class KeyValue
extends Object

A key value, including user key, sequence number, value kind and value. This object can be reused.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_LEVEL
static long	UNKNOWN_SEQUENCE

Constructor Summary

Constructors

Constructor and Description
KeyValue()

Method Summary

Modifier and Type	Method and Description
KeyValue	copy(InternalRowSerializer keySerializer, InternalRowSerializer valueSerializer)
static List<DataField>	createKeyValueFields(List<DataField> keyFields, List<DataField> valueFields, int maxKeyId) Create key-value fields, we need to add a const value to the id of value field to ensure that they are consistent when compared by field id.
boolean	isAdd()
InternalRow	key()
int	level()
static int[][]	project(int[][] keyProjection, int[][] valueProjection, int numKeyFields)
KeyValue	replace(InternalRow key, long sequenceNumber, RowKind valueKind, InternalRow value)
KeyValue	replace(InternalRow key, RowKind valueKind, InternalRow value)
KeyValue	replaceKey(InternalRow key)
KeyValue	replaceValue(InternalRow value)
KeyValue	replaceValueKind(RowKind valueKind)
static String	rowDataToString(InternalRow row, RowType type)
static RowType	schema(RowType keyType, RowType valueType)
static RowType	schemaWithLevel(RowType keyType, RowType valueType)
long	sequenceNumber()
KeyValue	setLevel(int level)
String	toString(RowType keyType, RowType valueType)
InternalRow	value()
RowKind	valueKind()

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_SEQUENCE

public static final long UNKNOWN_SEQUENCE

See Also:

Constant Field Values

UNKNOWN_LEVEL

public static final int UNKNOWN_LEVEL

See Also:

Constant Field Values

Constructor Detail

KeyValue

public KeyValue()

Method Detail

replace

public KeyValue replace(InternalRow key,
                        RowKind valueKind,
                        InternalRow value)

replace

public KeyValue replace(InternalRow key,
                        long sequenceNumber,
                        RowKind valueKind,
                        InternalRow value)

replaceKey

public KeyValue replaceKey(InternalRow key)

replaceValue

public KeyValue replaceValue(InternalRow value)

replaceValueKind

public KeyValue replaceValueKind(RowKind valueKind)

key

public InternalRow key()

sequenceNumber

public long sequenceNumber()

valueKind

public RowKind valueKind()

isAdd

public boolean isAdd()

value

public InternalRow value()

level

public int level()

setLevel

public KeyValue setLevel(int level)

schema

public static RowType schema(RowType keyType,
                             RowType valueType)

schemaWithLevel

public static RowType schemaWithLevel(RowType keyType,
                                      RowType valueType)

createKeyValueFields

public static List<DataField> createKeyValueFields(List<DataField> keyFields,
                                                   List<DataField> valueFields,
                                                   int maxKeyId)

Create key-value fields, we need to add a const value to the id of value field to ensure that they are consistent when compared by field id. For example, there are two table with key value fields as follows

• Table1 key fields: 1->a, 2->b, 3->c; value fields: 0->value_count
• Table2 key fields: 1->c, 3->d, 4->a, 5->b; value fields: 0->value_count

We will use 5 as maxKeyId, and create fields for Table1/Table2 as follows

• Table1 fields: 1->a, 2->b, 3->c, 6->seq, 7->kind, 8->value_count
• Table2 fields: 1->c, 3->d, 4->a, 5->b, 6->seq, 7->kind, 8->value_count

Then we can compare these two table fields with the field id.

Parameters:

keyFields - the key fields

valueFields - the value fields

maxKeyId - the max key id

Returns:

the table fields

project

public static int[][] project(int[][] keyProjection,
                              int[][] valueProjection,
                              int numKeyFields)

copy

@VisibleForTesting
public KeyValue copy(InternalRowSerializer keySerializer,
                                        InternalRowSerializer valueSerializer)

toString

@VisibleForTesting
public String toString(RowType keyType,
                                          RowType valueType)

rowDataToString

public static String rowDataToString(InternalRow row,
                                     RowType type)