org.apache.paimon.data.serializer

Class BinaryRowSerializer

java.lang.Object

org.apache.paimon.data.serializer.AbstractRowDataSerializer<BinaryRow>

org.apache.paimon.data.serializer.BinaryRowSerializer

All Implemented Interfaces:

Serializable, PagedTypeSerializer<BinaryRow>, Serializer<BinaryRow>

public class BinaryRowSerializer
extends AbstractRowDataSerializer<BinaryRow>

Serializer for BinaryRow.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH_SIZE_IN_BYTES

Constructor Summary

Constructors

Constructor and Description
BinaryRowSerializer(int numFields)

Method Summary

Modifier and Type	Method and Description
void	checkSkipReadForFixLengthPart(AbstractPagedInputView source) We need skip bytes to read when the remain bytes of current segment is not enough to write binary row fixed part.
BinaryRow	copy(BinaryRow from) Creates a deep copy of the given element in a new element.
void	copyFromPagesToView(AbstractPagedInputView source, DataOutputView target) Copy a binaryRow which stored in paged input view to output view.
BinaryRow	createInstance()
BinaryRow	deserialize(BinaryRow reuse, DataInputView source)
BinaryRow	deserialize(DataInputView source) De-serializes a record from the given source input view.
BinaryRow	deserializeFromPages(AbstractPagedInputView headerLessView) De-serializes a record from the given source paged input view.
BinaryRow	deserializeFromPages(BinaryRow reuse, AbstractPagedInputView headerLessView) Reuse version of PagedTypeSerializer.deserializeFromPages(AbstractPagedInputView).
BinaryRowSerializer	duplicate() Creates a deep copy of this serializer if it is necessary, i.e.
boolean	equals(Object obj)
int	getArity() Get the number of fields.
int	getFixedLengthPartSize()
int	getSerializedRowFixedPartLength() Return fixed part length to serialize one row.
int	hashCode()
BinaryRow	mapFromPages(BinaryRow reuse, AbstractPagedInputView headerLessView) Map a reused record from the given source paged input view.
void	pointTo(int length, BinaryRow reuse, AbstractPagedInputView headerLessView) Point row to memory segments with offset(in the AbstractPagedInputView) and length.
void	serialize(BinaryRow record, DataOutputView target) Serializes the given record to the given target output view.
int	serializeToPages(BinaryRow record, AbstractPagedOutputView headerLessView) Serializes the given record to the given target paged output view.
static void	serializeWithoutLengthSlow(BinaryRow record, MemorySegmentWritable out)
void	skipRecordFromPages(AbstractPagedInputView headerLessView) Skip over bytes of one record from the paged input view, discarding the skipped bytes.
BinaryRow	toBinaryRow(BinaryRow rowData) Convert a InternalRow to a BinaryRow.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.data.serializer.Serializer

deserializeFromString, serializeToString

Field Detail

LENGTH_SIZE_IN_BYTES

public static final int LENGTH_SIZE_IN_BYTES

See Also:

Constant Field Values

Constructor Detail

BinaryRowSerializer

public BinaryRowSerializer(int numFields)

Method Detail

duplicate

public BinaryRowSerializer duplicate()

Description copied from interface: Serializer

Creates a deep copy of this serializer if it is necessary, i.e. if it is stateful. This can return itself if the serializer is not stateful.

We need this because Serializers might be used in several threads. Stateless serializers are inherently thread-safe while stateful serializers might not be thread-safe.

createInstance

public BinaryRow createInstance()

copy

public BinaryRow copy(BinaryRow from)

Description copied from interface: Serializer

Creates a deep copy of the given element in a new element.

Parameters:

from - The element reuse be copied.

Returns:

A deep copy of the element.

serialize

public void serialize(BinaryRow record,
                      DataOutputView target)
               throws IOException

Description copied from interface: Serializer

Serializes the given record to the given target output view.

Parameters:

record - The record to serialize.

target - The output view to write the serialized data to.

Throws:

IOException - Thrown, if the serialization encountered an I/O related error. Typically raised by the output view, which may have an underlying I/O channel to which it delegates.

deserialize

public BinaryRow deserialize(DataInputView source)
                      throws IOException

Description copied from interface: Serializer

De-serializes a record from the given source input view.

Parameters:

source - The input view from which to read the data.

Returns:

The deserialized element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

deserialize

public BinaryRow deserialize(BinaryRow reuse,
                             DataInputView source)
                      throws IOException

Throws:

IOException

getArity

public int getArity()

Description copied from class: AbstractRowDataSerializer

Get the number of fields.

Specified by:

getArity in class AbstractRowDataSerializer<BinaryRow>

toBinaryRow

public BinaryRow toBinaryRow(BinaryRow rowData)
                      throws IOException

Description copied from class: AbstractRowDataSerializer

Convert a InternalRow to a BinaryRow.

Specified by:

toBinaryRow in class AbstractRowDataSerializer<BinaryRow>

Throws:

IOException

serializeToPages

public int serializeToPages(BinaryRow record,
                            AbstractPagedOutputView headerLessView)
                     throws IOException

Description copied from interface: PagedTypeSerializer

Serializes the given record to the given target paged output view. Some implementations may skip some bytes if current page does not have enough space left, .e.g BinaryRow.

Parameters:

record - The record to serialize.

headerLessView - The output view to write the serialized data to.

Returns:

Returns the skipped number of bytes.

Throws:

IOException - Thrown, if the serialization encountered an I/O related error. Typically raised by the output view, which may have an underlying I/O channel to which it delegates.

serializeWithoutLengthSlow

public static void serializeWithoutLengthSlow(BinaryRow record,
                                              MemorySegmentWritable out)
                                       throws IOException

Throws:

IOException

deserializeFromPages

public BinaryRow deserializeFromPages(AbstractPagedInputView headerLessView)
                               throws IOException

Description copied from interface: PagedTypeSerializer

De-serializes a record from the given source paged input view. For consistency with serialize format, some implementations may need to skip some bytes of source before de-serializing, .e.g BinaryRow. Typically, the content read from source should be copied out when de-serializing, and we are not expecting the underlying data from source is reused. If you have such requirement, see #mapFromPages(T, AbstractPagedInputView).

Parameters:

headerLessView - The input view from which to read the data.

Returns:

The de-serialized element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

deserializeFromPages

public BinaryRow deserializeFromPages(BinaryRow reuse,
                                      AbstractPagedInputView headerLessView)
                               throws IOException

Description copied from interface: PagedTypeSerializer

Reuse version of PagedTypeSerializer.deserializeFromPages(AbstractPagedInputView).

Throws:

IOException

mapFromPages

public BinaryRow mapFromPages(BinaryRow reuse,
                              AbstractPagedInputView headerLessView)
                       throws IOException

Description copied from interface: PagedTypeSerializer

Map a reused record from the given source paged input view. This method provides a possibility to achieve zero copy when de-serializing. You can either choose copy or not copy the content read from source, but we encourage to make it zero copy.

If you choose the zero copy way, you have to deal with the lifecycle of the pages properly.

Parameters:

reuse - the reused record to be mapped

headerLessView - The input view from which to read the data.

Returns:

The mapped record.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

skipRecordFromPages

public void skipRecordFromPages(AbstractPagedInputView headerLessView)
                         throws IOException

Description copied from interface: PagedTypeSerializer

Skip over bytes of one record from the paged input view, discarding the skipped bytes.

Throws:

IOException

copyFromPagesToView

public void copyFromPagesToView(AbstractPagedInputView source,
                                DataOutputView target)
                         throws IOException

Copy a binaryRow which stored in paged input view to output view.

Parameters:

source - source paged input view where the binary row stored

target - the target output view.

Throws:

IOException

pointTo

public void pointTo(int length,
                    BinaryRow reuse,
                    AbstractPagedInputView headerLessView)
             throws IOException

Point row to memory segments with offset(in the AbstractPagedInputView) and length.

Parameters:

length - row length.

reuse - reuse BinaryRow object.

headerLessView - source memory segments container.

Throws:

IOException

checkSkipReadForFixLengthPart

public void checkSkipReadForFixLengthPart(AbstractPagedInputView source)
                                   throws IOException

We need skip bytes to read when the remain bytes of current segment is not enough to write binary row fixed part. See BinaryRow.

Throws:

IOException

getSerializedRowFixedPartLength

public int getSerializedRowFixedPartLength()

Return fixed part length to serialize one row.

getFixedLengthPartSize

public int getFixedLengthPartSize()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object