public final class BinaryRow extends BinarySection implements BaseRow
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).
Modifier and Type | Field and Description |
---|---|
static int |
HEADER_SIZE_IN_BITS |
static boolean |
LITTLE_ENDIAN |
offset, segments, sizeInBytes
HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE
Constructor and Description |
---|
BinaryRow(int arity) |
Modifier and Type | Method and Description |
---|---|
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(LogicalType type)
If it is a fixed-length field, we can call this BinaryRow's setXX method for in-place updates.
|
static boolean |
isMutable(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,
LogicalType[] types) |
String |
toOriginString(LogicalType... types) |
equals, getOffset, getSegments, getSizeInBytes, pointTo, pointTo
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
get
readBinaryFieldFromSegments, readBinaryStringFieldFromSegments
public static final boolean LITTLE_ENDIAN
public static final int HEADER_SIZE_IN_BITS
public static int calculateBitSetWidthInBytes(int arity)
public static int calculateFixPartSizeInBytes(int arity)
public static boolean isInFixedLengthPart(LogicalType type)
public static boolean isMutable(LogicalType type)
public int getFixedLengthPartSize()
public int getArity()
BaseRow
public byte getHeader()
BaseRow
public void setHeader(byte header)
BaseRow
public void setTotalSize(int sizeInBytes)
public boolean isNullAt(int pos)
TypeGetterSetters
isNullAt
in interface TypeGetterSetters
public void setNullAt(int i)
TypeGetterSetters
setNullAt
in interface TypeGetterSetters
public void setInt(int pos, int value)
TypeGetterSetters
setInt
in interface TypeGetterSetters
public void setLong(int pos, long value)
TypeGetterSetters
setLong
in interface TypeGetterSetters
public void setDouble(int pos, double value)
TypeGetterSetters
setDouble
in interface TypeGetterSetters
public void setDecimal(int pos, Decimal value, int precision)
TypeGetterSetters
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
in interface TypeGetterSetters
public void setTimestamp(int pos, SqlTimestamp value, int precision)
TypeGetterSetters
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
in interface TypeGetterSetters
public void setBoolean(int pos, boolean value)
TypeGetterSetters
setBoolean
in interface TypeGetterSetters
public void setShort(int pos, short value)
TypeGetterSetters
setShort
in interface TypeGetterSetters
public void setByte(int pos, byte value)
TypeGetterSetters
setByte
in interface TypeGetterSetters
public void setFloat(int pos, float value)
TypeGetterSetters
setFloat
in interface TypeGetterSetters
public boolean getBoolean(int pos)
TypeGetterSetters
getBoolean
in interface TypeGetterSetters
public byte getByte(int pos)
TypeGetterSetters
getByte
in interface TypeGetterSetters
public short getShort(int pos)
TypeGetterSetters
getShort
in interface TypeGetterSetters
public int getInt(int pos)
TypeGetterSetters
getInt
in interface TypeGetterSetters
public long getLong(int pos)
TypeGetterSetters
getLong
in interface TypeGetterSetters
public float getFloat(int pos)
TypeGetterSetters
getFloat
in interface TypeGetterSetters
public double getDouble(int pos)
TypeGetterSetters
getDouble
in interface TypeGetterSetters
public BinaryString getString(int pos)
TypeGetterSetters
getString
in interface TypeGetterSetters
public Decimal getDecimal(int pos, int precision, int scale)
TypeGetterSetters
getDecimal
in interface TypeGetterSetters
public SqlTimestamp getTimestamp(int pos, int precision)
TypeGetterSetters
getTimestamp
in interface TypeGetterSetters
public <T> BinaryGeneric<T> getGeneric(int pos)
TypeGetterSetters
getGeneric
in interface TypeGetterSetters
public byte[] getBinary(int pos)
TypeGetterSetters
getBinary
in interface TypeGetterSetters
public BaseArray getArray(int pos)
TypeGetterSetters
getArray
in interface TypeGetterSetters
public BaseMap getMap(int pos)
TypeGetterSetters
getMap
in interface TypeGetterSetters
public BaseRow getRow(int pos, int numFields)
TypeGetterSetters
getRow
in interface TypeGetterSetters
public boolean anyNull()
public boolean anyNull(int[] fields)
public BinaryRow copy()
public void clear()
public int hashCode()
hashCode
in class BinarySection
public String toOriginString(LogicalType... types)
public static String toOriginString(BaseRow row, LogicalType[] types)
public boolean equalsWithoutHeader(BaseRow o)
Copyright © 2014–2020 The Apache Software Foundation. All rights reserved.