BinaryRow (Paimon : 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.data.BinarySection
- - org.apache.paimon.data.BinaryRow

All Implemented Interfaces:

Serializable, DataGetters, DataSetters, InternalRow
```
@Public
public final class BinaryRow
extends BinarySection
implements InternalRow, DataSetters
```
An implementation of InternalRow 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.

Since:

0.4.0

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.paimon.data.InternalRow
  InternalRow.FieldGetter, InternalRow.FieldSetter

Field Summary

Fields
Modifier and Type Field and Description

static BinaryRow EMPTY_ROW

static int HEADER_SIZE_IN_BITS

static boolean LITTLE_ENDIAN
- Fields inherited from class org.apache.paimon.data.BinarySection
  HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE, offset, segments, sizeInBytes

Fields
Modifier and Type	Field and Description
`static BinaryRow`	`EMPTY_ROW`
`static int`	`HEADER_SIZE_IN_BITS`
`static boolean`	`LITTLE_ENDIAN`

Constructor Summary

Constructors
Constructor and Description

BinaryRow(int arity)

Constructors
Constructor and Description
`BinaryRow(int arity)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`equals(Object o)`
`InternalArray`	`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.
`Decimal`	`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`	`getFieldCount()` Returns the number of fields in this row.
`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.
`InternalMap`	`getMap(int pos)` Returns the map value at the given position.
`InternalRow`	`getRow(int pos, int numFields)` Returns the row value at the given position.
`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.
`BinaryString`	`getString(int pos)` Returns the string value at the given position.
`Timestamp`	`getTimestamp(int pos, int precision)` Returns the timestamp value at the given position.
`int`	`hashCode()`
`static boolean`	`isInFixedLengthPart(DataType type)` If it is a fixed-length field, we can call this BinaryRowData's setXX method for in-place updates.
`boolean`	`isNullAt(int pos)` Returns true if the element is null at the given position.
`void`	`setBoolean(int pos, boolean value)`
`void`	`setByte(int pos, byte value)`
`void`	`setDecimal(int pos, Decimal 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(RowKind kind)` Sets the kind of change that this row describes in a changelog.
`void`	`setShort(int pos, short value)`
`void`	`setTimestamp(int pos, Timestamp value, int precision)` Set Timestamp value.
`void`	`setTotalSize(int sizeInBytes)`
`static BinaryRow`	`singleColumn(BinaryString string)`
`static BinaryRow`	`singleColumn(Integer i)`
`static BinaryRow`	`singleColumn(String string)`

Methods inherited from class org.apache.paimon.data.BinarySection
getOffset, getSegments, getSizeInBytes, pointTo, pointTo, toBytes

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.paimon.data.InternalRow
createFieldGetter, createFieldSetter, getDataClass

- Field Detail
  - LITTLE_ENDIAN
```
public static final boolean LITTLE_ENDIAN
```
  - HEADER_SIZE_IN_BITS
```
public static final int HEADER_SIZE_IN_BITS
```
    See Also:
    
    Constant Field Values
  - EMPTY_ROW
```
public static final BinaryRow EMPTY_ROW
```
- Constructor Detail
  - BinaryRow
```
public BinaryRow(int arity)
```
- Method Detail
  - calculateBitSetWidthInBytes
```
public static int calculateBitSetWidthInBytes(int arity)
```
  - calculateFixPartSizeInBytes
```
public static int calculateFixPartSizeInBytes(int arity)
```
  - getFixedLengthPartSize
```
public int getFixedLengthPartSize()
```
  - getFieldCount
```
public int getFieldCount()
```
    Description copied from interface: InternalRow
    
    Returns the number of fields in this row.
    The number does not include RowKind. It is kept separately.
    
    Specified by:
    
    getFieldCount in interface InternalRow
  - getRowKind
```
public RowKind getRowKind()
```
    Description copied from interface: InternalRow
    
    Returns the kind of change that this row describes in a changelog.
    
    Specified by:
    
    getRowKind in interface InternalRow
    
    See Also:
    
    RowKind
  - setRowKind
```
public void setRowKind(RowKind kind)
```
    Description copied from interface: InternalRow
    
    Sets the kind of change that this row describes in a changelog.
    
    Specified by:
    
    setRowKind in interface InternalRow
    
    See Also:
    
    RowKind
  - setTotalSize
```
public void setTotalSize(int sizeInBytes)
```
  - isNullAt
```
public boolean isNullAt(int pos)
```
    Description copied from interface: DataGetters
    
    Returns true if the element is null at the given position.
    
    Specified by:
    
    isNullAt in interface DataGetters
  - setNullAt
```
public void setNullAt(int i)
```
    Specified by:
    
    setNullAt in interface DataSetters
  - setInt
```
public void setInt(int pos,
                   int value)
```
    Specified by:
    
    setInt in interface DataSetters
  - setLong
```
public void setLong(int pos,
                    long value)
```
    Specified by:
    
    setLong in interface DataSetters
  - setDouble
```
public void setDouble(int pos,
                      double value)
```
    Specified by:
    
    setDouble in interface DataSetters
  - setDecimal
```
public void setDecimal(int pos,
                       Decimal value,
                       int precision)
```
    Description copied from interface: DataSetters
    
    Set the decimal column value.
    Note: Precision is compact: can call DataSetters.setNullAt(int) when decimal is null. Precision is not compact: can not call DataSetters.setNullAt(int) when decimal is null, must call setDecimal(pos, null, precision) because we need update var-length-part.
    
    Specified by:
    
    setDecimal in interface DataSetters
  - setTimestamp
```
public void setTimestamp(int pos,
                         Timestamp value,
                         int precision)
```
    Description copied from interface: DataSetters
    
    Set Timestamp value.
    Note: If precision is compact: can call DataSetters.setNullAt(int) when TimestampData value is null. Otherwise: can not call DataSetters.setNullAt(int) when TimestampData value is null, must call setTimestamp(pos, null, precision) because we need to update var-length-part.
    
    Specified by:
    
    setTimestamp in interface DataSetters
  - setBoolean
```
public void setBoolean(int pos,
                       boolean value)
```
    Specified by:
    
    setBoolean in interface DataSetters
  - setShort
```
public void setShort(int pos,
                     short value)
```
    Specified by:
    
    setShort in interface DataSetters
  - setByte
```
public void setByte(int pos,
                    byte value)
```
    Specified by:
    
    setByte in interface DataSetters
  - setFloat
```
public void setFloat(int pos,
                     float value)
```
    Specified by:
    
    setFloat in interface DataSetters
  - getBoolean
```
public boolean getBoolean(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the boolean value at the given position.
    
    Specified by:
    
    getBoolean in interface DataGetters
  - getByte
```
public byte getByte(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the byte value at the given position.
    
    Specified by:
    
    getByte in interface DataGetters
  - getShort
```
public short getShort(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the short value at the given position.
    
    Specified by:
    
    getShort in interface DataGetters
  - getInt
```
public int getInt(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the integer value at the given position.
    
    Specified by:
    
    getInt in interface DataGetters
  - getLong
```
public long getLong(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the long value at the given position.
    
    Specified by:
    
    getLong in interface DataGetters
  - getFloat
```
public float getFloat(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the float value at the given position.
    
    Specified by:
    
    getFloat in interface DataGetters
  - getDouble
```
public double getDouble(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the double value at the given position.
    
    Specified by:
    
    getDouble in interface DataGetters
  - getString
```
public BinaryString getString(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the string value at the given position.
    
    Specified by:
    
    getString in interface DataGetters
  - getDecimal
```
public Decimal getDecimal(int pos,
                          int precision,
                          int scale)
```
    Description copied from interface: DataGetters
    
    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 Decimal).
    
    Specified by:
    
    getDecimal in interface DataGetters
  - getTimestamp
```
public Timestamp getTimestamp(int pos,
                              int precision)
```
    Description copied from interface: DataGetters
    
    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 Timestamp).
    
    Specified by:
    
    getTimestamp in interface DataGetters
  - getBinary
```
public byte[] getBinary(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the binary value at the given position.
    
    Specified by:
    
    getBinary in interface DataGetters
  - getArray
```
public InternalArray getArray(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the array value at the given position.
    
    Specified by:
    
    getArray in interface DataGetters
  - getMap
```
public InternalMap getMap(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the map value at the given position.
    
    Specified by:
    
    getMap in interface DataGetters
  - getRow
```
public InternalRow getRow(int pos,
                          int numFields)
```
    Description copied from interface: DataGetters
    
    Returns the row value at the given position.
    The number of fields is required to correctly extract the row.
    
    Specified by:
    
    getRow in interface DataGetters
  - 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()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class BinarySection
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class BinarySection
  - singleColumn
```
public static BinaryRow singleColumn(@Nullable
                                     Integer i)
```
  - singleColumn
```
public static BinaryRow singleColumn(@Nullable
                                     String string)
```
  - singleColumn
```
public static BinaryRow singleColumn(@Nullable
                                     BinaryString string)
```
  - isInFixedLengthPart
```
public static boolean isInFixedLengthPart(DataType 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.

Back to Paimon Website

Class BinaryRow

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.paimon.data.InternalRow

Field Summary

Fields inherited from class org.apache.paimon.data.BinarySection

Constructor Summary

Method Summary

Methods inherited from class org.apache.paimon.data.BinarySection

Methods inherited from class java.lang.Object

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

Field Detail

LITTLE_ENDIAN

HEADER_SIZE_IN_BITS

EMPTY_ROW

Constructor Detail

BinaryRow

Method Detail

calculateBitSetWidthInBytes

calculateFixPartSizeInBytes

getFixedLengthPartSize

getFieldCount

getRowKind

setRowKind

setTotalSize

isNullAt

setNullAt

setInt

setLong

setDouble

setDecimal

setTimestamp

setBoolean

setShort

setByte

setFloat

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getString

getDecimal

getTimestamp

getBinary

getArray

getMap

getRow

anyNull

anyNull

copy

copy

clear

equals

hashCode

singleColumn

singleColumn

singleColumn

isInFixedLengthPart

Back to Paimon Website