org.apache.flink.table.dataformat

类 BinaryRow

java.lang.Object

org.apache.flink.table.dataformat.BinarySection

org.apache.flink.table.dataformat.BinaryRow

所有已实现的接口:

BaseRow, BinaryFormat, TypeGetterSetters

public final class BinaryRow
extends BinarySection
implements BaseRow

A special row 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.

BinaryRow are influenced by Apache Spark UnsafeRow in project tungsten. The difference is that BinaryRow is placed on a discontinuous memory, and the variable length type can also be placed on a fixed length area (If it's short enough).

字段概要

字段

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

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

offset, segments, sizeInBytes

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

HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE

构造器概要

构造器

构造器和说明
BinaryRow(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()
BinaryRow	copy()
BinaryRow	copy(BinaryRow reuse)
boolean	equalsWithoutHeader(BaseRow o)
int	getArity() Get the number of fields in the BaseRow.
BaseArray	getArray(int pos) Get array value, internal format is BaseArray.
byte[]	getBinary(int pos) Get binary value, internal format is byte[].
boolean	getBoolean(int pos) Get boolean value.
byte	getByte(int pos) Get byte value.
Decimal	getDecimal(int pos, int precision, int scale) Get decimal value, internal format is Decimal.
double	getDouble(int pos) Get double value.
int	getFixedLengthPartSize()
float	getFloat(int pos) Get float value.
<T> BinaryGeneric<T>	getGeneric(int pos) Get generic value, internal format is BinaryGeneric.
byte	getHeader() The header represents the type of this Row.
int	getInt(int pos) Get int value.
long	getLong(int pos) Get long value.
BaseMap	getMap(int pos) Get map value, internal format is BaseMap.
BaseRow	getRow(int pos, int numFields) Get row value, internal format is BaseRow.
short	getShort(int pos) Get short value.
BinaryString	getString(int pos) Get string value, internal format is BinaryString.
SqlTimestamp	getTimestamp(int pos, int precision) Get Timestamp value, internal format is SqlTimestamp.
int	hashCode()
static boolean	isInFixedLengthPart(org.apache.flink.table.types.logical.LogicalType type) If it is a fixed-length field, we can call this BinaryRow's setXX method for in-place updates.
static boolean	isMutable(org.apache.flink.table.types.logical.LogicalType type)
boolean	isNullAt(int pos) Because the specific row implementation such as BinaryRow uses the binary format.
void	setBoolean(int pos, boolean value) Set boolean value.
void	setByte(int pos, byte value) Set byte value.
void	setDecimal(int pos, Decimal value, int precision) Set the decimal column value.
void	setDouble(int pos, double value) Set double value.
void	setFloat(int pos, float value) Set float value.
void	setHeader(byte header) Set the byte header.
void	setInt(int pos, int value) Set int value.
void	setLong(int pos, long value) Set long value.
void	setNullAt(int i) Set null to this field.
void	setShort(int pos, short value) Set short value.
void	setTimestamp(int pos, SqlTimestamp value, int precision) Set Timestamp value.
void	setTotalSize(int sizeInBytes)
static String	toOriginString(BaseRow row, org.apache.flink.table.types.logical.LogicalType[] types)
String	toOriginString(org.apache.flink.table.types.logical.LogicalType... types)

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

equals, getOffset, getSegments, getSizeInBytes, pointTo, pointTo

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

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

从接口继承的方法 org.apache.flink.table.dataformat.TypeGetterSetters

get

从接口继承的方法 org.apache.flink.table.dataformat.BinaryFormat

readBinaryFieldFromSegments, readBinaryStringFieldFromSegments

字段详细资料

LITTLE_ENDIAN

public static final boolean LITTLE_ENDIAN

HEADER_SIZE_IN_BITS

public static final int HEADER_SIZE_IN_BITS

另请参阅:

常量字段值

构造器详细资料

BinaryRow

public BinaryRow(int arity)

方法详细资料

calculateBitSetWidthInBytes

public static int calculateBitSetWidthInBytes(int arity)

calculateFixPartSizeInBytes

public static int calculateFixPartSizeInBytes(int arity)

isInFixedLengthPart

public static boolean isInFixedLengthPart(org.apache.flink.table.types.logical.LogicalType type)

If it is a fixed-length field, we can call this BinaryRow'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(org.apache.flink.table.types.logical.LogicalType type)

getFixedLengthPartSize

public int getFixedLengthPartSize()

getArity

public int getArity()

从接口复制的说明: BaseRow

Get the number of fields in the BaseRow.

指定者:

getArity 在接口中 BaseRow

返回:

The number of fields in the BaseRow.

getHeader

public byte getHeader()

从接口复制的说明: BaseRow

The header represents the type of this Row. Now just used in streaming. Now there are two message: ACCUMULATE_MSG and RETRACT_MSG.

指定者:

getHeader 在接口中 BaseRow

setHeader

public void setHeader(byte header)

从接口复制的说明: BaseRow

Set the byte header.

指定者:

setHeader 在接口中 BaseRow

setTotalSize

public void setTotalSize(int sizeInBytes)

isNullAt

public boolean isNullAt(int pos)

从接口复制的说明: TypeGetterSetters

Because the specific row implementation such as BinaryRow uses the binary format. We must first determine if it is null, and then make a specific get.

指定者:

isNullAt 在接口中 TypeGetterSetters

返回:

true if this field is null.

setNullAt

public void setNullAt(int i)

从接口复制的说明: TypeGetterSetters

Set null to this field.

指定者:

setNullAt 在接口中 TypeGetterSetters

setInt

public void setInt(int pos,
                   int value)

从接口复制的说明: TypeGetterSetters

Set int value.

指定者:

setInt 在接口中 TypeGetterSetters

setLong

public void setLong(int pos,
                    long value)

从接口复制的说明: TypeGetterSetters

Set long value.

指定者:

setLong 在接口中 TypeGetterSetters

setDouble

public void setDouble(int pos,
                      double value)

从接口复制的说明: TypeGetterSetters

Set double value.

指定者:

setDouble 在接口中 TypeGetterSetters

setDecimal

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

从接口复制的说明: TypeGetterSetters

Set the decimal column value.

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

指定者:

setDecimal 在接口中 TypeGetterSetters

setTimestamp

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

从接口复制的说明: TypeGetterSetters

Set Timestamp value.

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

指定者:

setTimestamp 在接口中 TypeGetterSetters

setBoolean

public void setBoolean(int pos,
                       boolean value)

从接口复制的说明: TypeGetterSetters

Set boolean value.

指定者:

setBoolean 在接口中 TypeGetterSetters

setShort

public void setShort(int pos,
                     short value)

从接口复制的说明: TypeGetterSetters

Set short value.

指定者:

setShort 在接口中 TypeGetterSetters

setByte

public void setByte(int pos,
                    byte value)

从接口复制的说明: TypeGetterSetters

Set byte value.

指定者:

setByte 在接口中 TypeGetterSetters

setFloat

public void setFloat(int pos,
                     float value)

从接口复制的说明: TypeGetterSetters

Set float value.

指定者:

setFloat 在接口中 TypeGetterSetters

getBoolean

public boolean getBoolean(int pos)

从接口复制的说明: TypeGetterSetters

Get boolean value.

指定者:

getBoolean 在接口中 TypeGetterSetters

getByte

public byte getByte(int pos)

从接口复制的说明: TypeGetterSetters

Get byte value.

指定者:

getByte 在接口中 TypeGetterSetters

getShort

public short getShort(int pos)

从接口复制的说明: TypeGetterSetters

Get short value.

指定者:

getShort 在接口中 TypeGetterSetters

getInt

public int getInt(int pos)

从接口复制的说明: TypeGetterSetters

Get int value.

指定者:

getInt 在接口中 TypeGetterSetters

getLong

public long getLong(int pos)

从接口复制的说明: TypeGetterSetters

Get long value.

指定者:

getLong 在接口中 TypeGetterSetters

getFloat

public float getFloat(int pos)

从接口复制的说明: TypeGetterSetters

Get float value.

指定者:

getFloat 在接口中 TypeGetterSetters

getDouble

public double getDouble(int pos)

从接口复制的说明: TypeGetterSetters

Get double value.

指定者:

getDouble 在接口中 TypeGetterSetters

getString

public BinaryString getString(int pos)

从接口复制的说明: TypeGetterSetters

Get string value, internal format is BinaryString.

指定者:

getString 在接口中 TypeGetterSetters

getDecimal

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

从接口复制的说明: TypeGetterSetters

Get decimal value, internal format is Decimal.

指定者:

getDecimal 在接口中 TypeGetterSetters

getTimestamp

public SqlTimestamp getTimestamp(int pos,
                                 int precision)

从接口复制的说明: TypeGetterSetters

Get Timestamp value, internal format is SqlTimestamp.

指定者:

getTimestamp 在接口中 TypeGetterSetters

getGeneric

public <T> BinaryGeneric<T> getGeneric(int pos)

从接口复制的说明: TypeGetterSetters

Get generic value, internal format is BinaryGeneric.

指定者:

getGeneric 在接口中 TypeGetterSetters

getBinary

public byte[] getBinary(int pos)

从接口复制的说明: TypeGetterSetters

Get binary value, internal format is byte[].

指定者:

getBinary 在接口中 TypeGetterSetters

getArray

public BaseArray getArray(int pos)

从接口复制的说明: TypeGetterSetters

Get array value, internal format is BaseArray.

指定者:

getArray 在接口中 TypeGetterSetters

getMap

public BaseMap getMap(int pos)

从接口复制的说明: TypeGetterSetters

Get map value, internal format is BaseMap.

指定者:

getMap 在接口中 TypeGetterSetters

getRow

public BaseRow getRow(int pos,
                      int numFields)

从接口复制的说明: TypeGetterSetters

Get row value, internal format is BaseRow.

指定者:

getRow 在接口中 TypeGetterSetters

anyNull

public boolean anyNull()

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

anyNull

public boolean anyNull(int[] fields)

copy

public BinaryRow copy()

copy

public BinaryRow copy(BinaryRow reuse)

clear

public void clear()

hashCode

public int hashCode()

覆盖:

hashCode 在类中 BinarySection

toOriginString

public String toOriginString(org.apache.flink.table.types.logical.LogicalType... types)

toOriginString

public static String toOriginString(BaseRow row,
                                    org.apache.flink.table.types.logical.LogicalType[] types)

equalsWithoutHeader

public boolean equalsWithoutHeader(BaseRow o)