org.apache.paimon.data

Interface InternalRow

All Superinterfaces:

DataGetters

All Known Implementing Classes:

BinaryRow, CastedRow, ColumnarRow, DefaultValueRow, FlinkRowWrapper, GenericRow, JoinedRow, KeyProjectedRow, LazyGenericRow, NestedRow, OffsetRow, PartialRow, PartitionSettedRow, ProjectedRow, SafeBinaryRow, SparkRow

@Public
public interface InternalRow
extends DataGetters

Base interface for an internal data structure representing data of RowType.

The mappings from SQL data types to the internal data structures are listed in the following table:

 +--------------------------------+-----------------------------------------+
 | SQL Data Types                 | Internal Data Structures                |
 +--------------------------------+-----------------------------------------+
 | BOOLEAN                        | boolean                                 |
 +--------------------------------+-----------------------------------------+
 | CHAR / VARCHAR / STRING        | BinaryString                    |
 +--------------------------------+-----------------------------------------+
 | BINARY / VARBINARY / BYTES     | byte[]                                  |
 +--------------------------------+-----------------------------------------+
 | DECIMAL                        | Decimal                         |
 +--------------------------------+-----------------------------------------+
 | TINYINT                        | byte                                    |
 +--------------------------------+-----------------------------------------+
 | SMALLINT                       | short                                   |
 +--------------------------------+-----------------------------------------+
 | INT                            | int                                     |
 +--------------------------------+-----------------------------------------+
 | BIGINT                         | long                                    |
 +--------------------------------+-----------------------------------------+
 | FLOAT                          | float                                   |
 +--------------------------------+-----------------------------------------+
 | DOUBLE                         | double                                  |
 +--------------------------------+-----------------------------------------+
 | DATE                           | int (number of days since epoch)        |
 +--------------------------------+-----------------------------------------+
 | TIME                           | int (number of milliseconds of the day) |
 +--------------------------------+-----------------------------------------+
 | TIMESTAMP                      | Timestamp                       |
 +--------------------------------+-----------------------------------------+
 | TIMESTAMP WITH LOCAL TIME ZONE | Timestamp                       |
 +--------------------------------+-----------------------------------------+
 | ROW                            | InternalRow                     |
 +--------------------------------+-----------------------------------------+
 | ARRAY                          | InternalArray                   |
 +--------------------------------+-----------------------------------------+
 | MAP / MULTISET                 | InternalMap                     |
 +--------------------------------+-----------------------------------------+
 

Nullability is always handled by the container data structure.

Since:

0.4.0

See Also:

GenericRow, JoinedRow

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InternalRow.FieldGetter Accessor for getting the field of a row during runtime.
static interface	InternalRow.FieldSetter Accessor for setting the field of a row during runtime.

Method Summary

Modifier and Type	Method and Description
static InternalRow.FieldGetter	createFieldGetter(DataType fieldType, int fieldPos) Creates an accessor for getting elements in an internal row data structure at the given position.
static InternalRow.FieldSetter	createFieldSetter(DataType fieldType, int fieldPos) Creates a InternalRow.FieldSetter for setting elements to a row from a row at the given position.
static Class<?>	getDataClass(DataType type) Returns the data class for the given DataType.
int	getFieldCount() Returns the number of fields in this row.
RowKind	getRowKind() Returns the kind of change that this row describes in a changelog.
void	setRowKind(RowKind kind) Sets the kind of change that this row describes in a changelog.

Methods inherited from interface org.apache.paimon.data.DataGetters

getArray, getBinary, getBoolean, getByte, getDecimal, getDouble, getFloat, getInt, getLong, getMap, getRow, getShort, getString, getTimestamp, isNullAt

Method Detail

getFieldCount

int getFieldCount()

Returns the number of fields in this row.

The number does not include RowKind. It is kept separately.

getRowKind

RowKind getRowKind()

Returns the kind of change that this row describes in a changelog.

See Also:

RowKind

setRowKind

void setRowKind(RowKind kind)

Sets the kind of change that this row describes in a changelog.

See Also:

RowKind

getDataClass

static Class<?> getDataClass(DataType type)

Returns the data class for the given DataType.

createFieldGetter

static InternalRow.FieldGetter createFieldGetter(DataType fieldType,
                                                 int fieldPos)

Creates an accessor for getting elements in an internal row data structure at the given position.

Parameters:

fieldType - the element type of the row

fieldPos - the element position of the row

createFieldSetter

static InternalRow.FieldSetter createFieldSetter(DataType fieldType,
                                                 int fieldPos)

Creates a InternalRow.FieldSetter for setting elements to a row from a row at the given position.

Parameters:

fieldType - the element type of the row

fieldPos - the element position of the row