org.apache.flink.table.data.binary

类 BinaryRowData

java.lang.Object

org.apache.flink.table.data.binary.BinarySection

org.apache.flink.table.data.binary.BinaryRowData

所有已实现的接口:

BinaryFormat, TypedSetters, RowData

@Internal
public final class BinaryRowData
extends BinarySection
implements RowData, TypedSetters

An implementation of RowData which is backed by MemorySegment instead of Object. It can significantly reduce the serialization/deserialization of Java objects.

A Row has two part: Fixed-length part and variable-length part.

Fixed-length part contains 1 byte header and null bit set and field values. Null bit set is used for null tracking and is aligned to 8-byte word boundaries. `Field values` holds fixed-length primitive types and variable-length values which can be stored in 8 bytes inside. If it do not fit the variable-length field, then store the length and offset of variable-length part.

Fixed-length part will certainly fall into a MemorySegment, which will speed up the read and write of field. During the write phase, if the target memory segment has less space than fixed length part size, we will skip the space. So the number of fields in a single Row cannot exceed the capacity of a single MemorySegment, if there are too many fields, we suggest that user set a bigger pageSize of MemorySegment.

Variable-length part may fall into multiple MemorySegments.

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.table.data.RowData

RowData.FieldGetter

字段概要

字段

限定符和类型	字段和说明
static int	HEADER_SIZE_IN_BITS
static boolean	LITTLE_ENDIAN

从类继承的字段 org.apache.flink.table.data.binary.BinarySection

offset, segments, sizeInBytes

从接口继承的字段 org.apache.flink.table.data.binary.BinaryFormat

HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE

构造器概要

构造器

构造器和说明
BinaryRowData(int arity)

方法概要

限定符和类型	方法和说明
boolean	anyNull() The bit is 1 when the field is null.
boolean	anyNull(int[] fields)
static int	calculateBitSetWidthInBytes(int arity)
static int	calculateFixPartSizeInBytes(int arity)
void	clear()
BinaryRowData	copy()
BinaryRowData	copy(BinaryRowData reuse)
int	getArity() Returns the number of fields in this row.
ArrayData	getArray(int pos) Returns the array value at the given position.
byte[]	getBinary(int pos) Returns the binary value at the given position.
boolean	getBoolean(int pos) Returns the boolean value at the given position.
byte	getByte(int pos) Returns the byte value at the given position.
DecimalData	getDecimal(int pos, int precision, int scale) Returns the decimal value at the given position.
double	getDouble(int pos) Returns the double value at the given position.
int	getFixedLengthPartSize()
float	getFloat(int pos) Returns the float value at the given position.
int	getInt(int pos) Returns the integer value at the given position.
long	getLong(int pos) Returns the long value at the given position.
MapData	getMap(int pos) Returns the map value at the given position.
<T> RawValueData<T>	getRawValue(int pos) Returns the raw value at the given position.
RowData	getRow(int pos, int numFields) Returns the row value at the given position.
org.apache.flink.types.RowKind	getRowKind() Returns the kind of change that this row describes in a changelog.
short	getShort(int pos) Returns the short value at the given position.
StringData	getString(int pos) Returns the string value at the given position.
TimestampData	getTimestamp(int pos, int precision) Returns the timestamp value at the given position.
int	hashCode()
static boolean	isInFixedLengthPart(LogicalType type) If it is a fixed-length field, we can call this BinaryRowData's setXX method for in-place updates.
static boolean	isMutable(LogicalType type)
boolean	isNullAt(int pos) Returns true if the field is null at the given position.
void	setBoolean(int pos, boolean value)
void	setByte(int pos, byte value)
void	setDecimal(int pos, DecimalData value, int precision) Set the decimal column value.
void	setDouble(int pos, double value)
void	setFloat(int pos, float value)
void	setInt(int pos, int value)
void	setLong(int pos, long value)
void	setNullAt(int i)
void	setRowKind(org.apache.flink.types.RowKind kind) Sets the kind of change that this row describes in a changelog.
void	setShort(int pos, short value)
void	setTimestamp(int pos, TimestampData value, int precision) Set Timestamp value.
void	setTotalSize(int sizeInBytes)

从类继承的方法 org.apache.flink.table.data.binary.BinarySection

equals, getOffset, getSegments, getSizeInBytes, pointTo, pointTo

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.table.data.RowData

createFieldGetter, get

字段详细资料

LITTLE_ENDIAN

public static final boolean LITTLE_ENDIAN

HEADER_SIZE_IN_BITS

public static final int HEADER_SIZE_IN_BITS

另请参阅:

常量字段值

构造器详细资料

BinaryRowData

public BinaryRowData(int arity)

方法详细资料

calculateBitSetWidthInBytes

public static int calculateBitSetWidthInBytes(int arity)

calculateFixPartSizeInBytes

public static int calculateFixPartSizeInBytes(int arity)

isInFixedLengthPart

public static boolean isInFixedLengthPart(LogicalType type)

If it is a fixed-length field, we can call this BinaryRowData's setXX method for in-place updates. If it is variable-length field, can't use this method, because the underlying data is stored continuously.

isMutable

public static boolean isMutable(LogicalType type)

getFixedLengthPartSize

public int getFixedLengthPartSize()

getArity

public int getArity()

从接口复制的说明: RowData

Returns the number of fields in this row.

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

指定者:

getArity 在接口中 RowData

getRowKind

public org.apache.flink.types.RowKind getRowKind()

从接口复制的说明: RowData

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

指定者:

getRowKind 在接口中 RowData

另请参阅:

RowKind

setRowKind

public void setRowKind(org.apache.flink.types.RowKind kind)

从接口复制的说明: RowData

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

指定者:

setRowKind 在接口中 RowData

另请参阅:

RowKind

setTotalSize

public void setTotalSize(int sizeInBytes)

isNullAt

public boolean isNullAt(int pos)

从接口复制的说明: RowData

Returns true if the field is null at the given position.

指定者:

isNullAt 在接口中 RowData

setNullAt

public void setNullAt(int i)

指定者:

setNullAt 在接口中 TypedSetters

setInt

public void setInt(int pos,
                   int value)

指定者:

setInt 在接口中 TypedSetters

setLong

public void setLong(int pos,
                    long value)

指定者:

setLong 在接口中 TypedSetters

setDouble

public void setDouble(int pos,
                      double value)

指定者:

setDouble 在接口中 TypedSetters

setDecimal

public void setDecimal(int pos,
                       DecimalData value,
                       int precision)

从接口复制的说明: TypedSetters

Set the decimal column value.

Note: Precision is compact: can call TypedSetters.setNullAt(int) when decimal is null. Precision is not compact: can not call TypedSetters.setNullAt(int) when decimal is null, must call setDecimal(pos, null, precision) because we need update var-length-part.

指定者:

setDecimal 在接口中 TypedSetters

setTimestamp

public void setTimestamp(int pos,
                         TimestampData value,
                         int precision)

从接口复制的说明: TypedSetters

Set Timestamp value.

Note: If precision is compact: can call TypedSetters.setNullAt(int) when TimestampData value is null. Otherwise: can not call TypedSetters.setNullAt(int) when TimestampData value is null, must call setTimestamp(pos, null, precision) because we need to update var-length-part.

指定者:

setTimestamp 在接口中 TypedSetters

setBoolean

public void setBoolean(int pos,
                       boolean value)

指定者:

setBoolean 在接口中 TypedSetters

setShort

public void setShort(int pos,
                     short value)

指定者:

setShort 在接口中 TypedSetters

setByte

public void setByte(int pos,
                    byte value)

指定者:

setByte 在接口中 TypedSetters

setFloat

public void setFloat(int pos,
                     float value)

指定者:

setFloat 在接口中 TypedSetters

getBoolean

public boolean getBoolean(int pos)

从接口复制的说明: RowData

Returns the boolean value at the given position.

指定者:

getBoolean 在接口中 RowData

getByte

public byte getByte(int pos)

从接口复制的说明: RowData

Returns the byte value at the given position.

指定者:

getByte 在接口中 RowData

getShort

public short getShort(int pos)

从接口复制的说明: RowData

Returns the short value at the given position.

指定者:

getShort 在接口中 RowData

getInt

public int getInt(int pos)

从接口复制的说明: RowData

Returns the integer value at the given position.

指定者:

getInt 在接口中 RowData

getLong

public long getLong(int pos)

从接口复制的说明: RowData

Returns the long value at the given position.

指定者:

getLong 在接口中 RowData

getFloat

public float getFloat(int pos)

从接口复制的说明: RowData

Returns the float value at the given position.

指定者:

getFloat 在接口中 RowData

getDouble

public double getDouble(int pos)

从接口复制的说明: RowData

Returns the double value at the given position.

指定者:

getDouble 在接口中 RowData

getString

public StringData getString(int pos)

从接口复制的说明: RowData

Returns the string value at the given position.

指定者:

getString 在接口中 RowData

getDecimal

public DecimalData getDecimal(int pos,
                              int precision,
                              int scale)

从接口复制的说明: RowData

Returns the decimal value at the given position.

The precision and scale are required to determine whether the decimal value was stored in a compact representation (see DecimalData).

指定者:

getDecimal 在接口中 RowData

getTimestamp

public TimestampData getTimestamp(int pos,
                                  int precision)

从接口复制的说明: RowData

Returns the timestamp value at the given position.

The precision is required to determine whether the timestamp value was stored in a compact representation (see TimestampData).

指定者:

getTimestamp 在接口中 RowData

getRawValue

public <T> RawValueData<T> getRawValue(int pos)

从接口复制的说明: RowData

Returns the raw value at the given position.

指定者:

getRawValue 在接口中 RowData

getBinary

public byte[] getBinary(int pos)

从接口复制的说明: RowData

Returns the binary value at the given position.

指定者:

getBinary 在接口中 RowData

getArray

public ArrayData getArray(int pos)

从接口复制的说明: RowData

Returns the array value at the given position.

指定者:

getArray 在接口中 RowData

getMap

public MapData getMap(int pos)

从接口复制的说明: RowData

Returns the map value at the given position.

指定者:

getMap 在接口中 RowData

getRow

public RowData getRow(int pos,
                      int numFields)

从接口复制的说明: RowData

Returns the row value at the given position.

The number of fields is required to correctly extract the row.

指定者:

getRow 在接口中 RowData

anyNull

public boolean anyNull()

The bit is 1 when the field is null. Default is 0.

anyNull

public boolean anyNull(int[] fields)

copy

public BinaryRowData copy()

copy

public BinaryRowData copy(BinaryRowData reuse)

clear

public void clear()

hashCode

public int hashCode()

覆盖:

hashCode 在类中 BinarySection