org.apache.paimon.table

Class SpecialFields

java.lang.Object

org.apache.paimon.table.SpecialFields

public class SpecialFields
extends Object

Special fields in a RowType with specific field ids.

System fields:

• _KEY_<key-field>: Keys of a key-value. ID = 1073741823 + (field-id) .
• _SEQUENCE_NUMBER: Sequence number of a key-value. ID = 2147483646.
• _VALUE_KIND: Type of a key-value. See RowKind. ID = 2147483645.
• _LEVEL: Which LSM tree level does this key-value stay in. ID = 2147483644.
• rowkind: THw rowkind field in audit-log system tables. ID = 2147483643.

Structured type fields:

These ids are mainly used as field ids in parquet files, so compute engines can read a field directly by id. These ids are not stored in DataField.

• Array element field: ID = 536870911 + 1024 * (array-field-id) + depth.
• Map key field: ID = 536870911 - 1024 * (array-field-id) - depth.
• Map value field: ID = 536870911 + 1024 * (array-field-id) + depth.

Examples:

• ARRAY(MAP(INT, ARRAY(INT))) type, outer array has field id 10, then map (element of outer array) has field id 536870911 + 1024 * 10 + 1, map key (int) has field id 536870911 - 1024 * 10 - 2, map value (inner array) has field id 536870911 + 1024 * 10 + 2, inner array element (int) has field id 536870911 + 1024 * 10 + 3

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_FIELD_ID_START
static String	KEY_FIELD_PREFIX
static DataField	LEVEL
static DataField	ROW_KIND
static DataField	SEQUENCE_NUMBER
static int	STRUCTURED_TYPE_FIELD_DEPTH_LIMIT
static int	STRUCTURED_TYPE_FIELD_ID_BASE
static int	SYSTEM_FIELD_ID_START
static Set<String>	SYSTEM_FIELD_NAMES
static DataField	VALUE_KIND

Constructor Summary

Constructors

Constructor and Description
SpecialFields()

Method Summary

Modifier and Type	Method and Description
static int	getArrayElementFieldId(int arrayFieldId, int depth)
static int	getMapKeyFieldId(int mapFieldId, int depth)
static int	getMapValueFieldId(int mapFieldId, int depth)
static boolean	isSystemField(int fieldId)
static boolean	isSystemField(String field)

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_FIELD_ID_START

public static final int SYSTEM_FIELD_ID_START

See Also:

Constant Field Values

KEY_FIELD_PREFIX

public static final String KEY_FIELD_PREFIX

See Also:

Constant Field Values

KEY_FIELD_ID_START

public static final int KEY_FIELD_ID_START

See Also:

Constant Field Values

SEQUENCE_NUMBER

public static final DataField SEQUENCE_NUMBER

VALUE_KIND

public static final DataField VALUE_KIND

LEVEL

public static final DataField LEVEL

ROW_KIND

public static final DataField ROW_KIND

SYSTEM_FIELD_NAMES

public static final Set<String> SYSTEM_FIELD_NAMES

STRUCTURED_TYPE_FIELD_ID_BASE

public static final int STRUCTURED_TYPE_FIELD_ID_BASE

See Also:

Constant Field Values

STRUCTURED_TYPE_FIELD_DEPTH_LIMIT

public static final int STRUCTURED_TYPE_FIELD_DEPTH_LIMIT

See Also:

Constant Field Values

Constructor Detail

SpecialFields

public SpecialFields()

Method Detail

isSystemField

public static boolean isSystemField(int fieldId)

isSystemField

public static boolean isSystemField(String field)

getArrayElementFieldId

public static int getArrayElementFieldId(int arrayFieldId,
                                         int depth)

getMapKeyFieldId

public static int getMapKeyFieldId(int mapFieldId,
                                   int depth)

getMapValueFieldId

public static int getMapValueFieldId(int mapFieldId,
                                     int depth)