org.apache.flink.table.runtime.typeutils

Class RowDataSerializer

java.lang.Object

org.apache.flink.api.common.typeutils.TypeSerializer<T>

org.apache.flink.table.runtime.typeutils.AbstractRowDataSerializer<RowData>

org.apache.flink.table.runtime.typeutils.RowDataSerializer

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RowDataSerializer

@Internal
public class RowDataSerializer
extends AbstractRowDataSerializer<RowData>

Serializer for RowData.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RowDataSerializer.RowDataSerializerSnapshot TypeSerializerSnapshot for BinaryRowDataSerializer.

Constructor Summary

Constructors

Constructor and Description
RowDataSerializer(LogicalType... types)
RowDataSerializer(LogicalType[] types, TypeSerializer<?>[] fieldSerializers)
RowDataSerializer(RowType rowType)

Method Summary

Modifier and Type	Method and Description
void	copy(DataInputView source, DataOutputView target) Copies exactly one record from the source input view to the target output view.
RowData	copy(RowData from) Creates a deep copy of the given element in a new element.
RowData	copy(RowData from, RowData reuse) Creates a copy from the given element.
RowData	createInstance() Creates a new instance of the data type.
RowData	deserialize(DataInputView source) De-serializes a record from the given source input view.
RowData	deserialize(RowData reuse, DataInputView source) De-serializes a record from the given source input view into the given reuse record instance if mutable.
RowData	deserializeFromPages(AbstractPagedInputView source) De-serializes a record from the given source paged input view.
RowData	deserializeFromPages(RowData reuse, AbstractPagedInputView source) Reuse version of AbstractRowDataSerializer.deserializeFromPages(AbstractPagedInputView).
TypeSerializer<RowData>	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	getLength() Gets the length of the data type, if it is a fix length data type.
int	hashCode()
boolean	isImmutableType() Gets whether the type is an immutable type.
RowData	mapFromPages(AbstractPagedInputView source) Map a record from the given source paged input view.
RowData	mapFromPages(RowData reuse, AbstractPagedInputView source) Reuse version of AbstractRowDataSerializer.mapFromPages(AbstractPagedInputView).
void	serialize(RowData row, DataOutputView target) Serializes the given record to the given target output view.
int	serializeToPages(RowData row, AbstractPagedOutputView target) Serializes the given record to the given target paged output view.
TypeSerializerSnapshot<RowData>	snapshotConfiguration() Snapshots the configuration of this TypeSerializer.
BinaryRowData	toBinaryRow(RowData row) Convert RowData into BinaryRowData.

Methods inherited from class java.lang.Object

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

Constructor Detail

RowDataSerializer

public RowDataSerializer(RowType rowType)

RowDataSerializer

public RowDataSerializer(LogicalType... types)

RowDataSerializer

public RowDataSerializer(LogicalType[] types,
                         TypeSerializer<?>[] fieldSerializers)

Method Detail

duplicate

public TypeSerializer<RowData> duplicate()

Description copied from class: TypeSerializer

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.

Specified by:

duplicate in class TypeSerializer<RowData>

createInstance

public RowData createInstance()

Description copied from class: TypeSerializer

Creates a new instance of the data type.

Specified by:

createInstance in class TypeSerializer<RowData>

Returns:

A new instance of the data type.

serialize

public void serialize(RowData row,
                      DataOutputView target)
               throws IOException

Description copied from class: TypeSerializer

Serializes the given record to the given target output view.

Specified by:

serialize in class TypeSerializer<RowData>

Parameters:

row - 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 RowData deserialize(DataInputView source)
                    throws IOException

Description copied from class: TypeSerializer

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

Specified by:

deserialize in class TypeSerializer<RowData>

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 RowData deserialize(RowData reuse,
                           DataInputView source)
                    throws IOException

Description copied from class: TypeSerializer

De-serializes a record from the given source input view into the given reuse record instance if mutable.

Specified by:

deserialize in class TypeSerializer<RowData>

Parameters:

reuse - The record instance into which to de-serialize the data.

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.

copy

public RowData copy(RowData from)

Description copied from class: TypeSerializer

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

Specified by:

copy in class TypeSerializer<RowData>

Parameters:

from - The element reuse be copied.

Returns:

A deep copy of the element.

copy

public RowData copy(RowData from,
                    RowData reuse)

Description copied from class: TypeSerializer

Creates a copy from the given element. The method makes an attempt to store the copy in the given reuse element, if the type is mutable. This is, however, not guaranteed.

Specified by:

copy in class TypeSerializer<RowData>

Parameters:

from - The element to be copied.

reuse - The element to be reused. May or may not be used.

Returns:

A deep copy of the element.

copy

public void copy(DataInputView source,
                 DataOutputView target)
          throws IOException

Description copied from class: TypeSerializer

Copies exactly one record from the source input view to the target output view. Whether this operation works on binary data or partially de-serializes the record to determine its length (such as for records of variable length) is up to the implementer. Binary copies are typically faster. A copy of a record containing two integer numbers (8 bytes total) is most efficiently implemented as target.write(source, 8);.

Specified by:

copy in class TypeSerializer<RowData>

Parameters:

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

target - The target output view to which to write the record.

Throws:

IOException - Thrown if any of the two views raises an exception.

getArity

public int getArity()

Description copied from class: AbstractRowDataSerializer

Get the number of fields.

Specified by:

getArity in class AbstractRowDataSerializer<RowData>

toBinaryRow

public BinaryRowData toBinaryRow(RowData row)

Convert RowData into BinaryRowData. TODO modify it to code gen.

Specified by:

toBinaryRow in class AbstractRowDataSerializer<RowData>

serializeToPages

public int serializeToPages(RowData row,
                            AbstractPagedOutputView target)
                     throws IOException

Description copied from class: AbstractRowDataSerializer

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 BinaryRowData.

Specified by:

serializeToPages in class AbstractRowDataSerializer<RowData>

Parameters:

row - The record to serialize.

target - 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.

deserializeFromPages

public RowData deserializeFromPages(AbstractPagedInputView source)
                             throws IOException

Description copied from class: AbstractRowDataSerializer

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 BinaryRowData. 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 AbstractRowDataSerializer.mapFromPages(AbstractPagedInputView).

Specified by:

deserializeFromPages in class AbstractRowDataSerializer<RowData>

Parameters:

source - 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 RowData deserializeFromPages(RowData reuse,
                                    AbstractPagedInputView source)
                             throws IOException

Description copied from class: AbstractRowDataSerializer

Reuse version of AbstractRowDataSerializer.deserializeFromPages(AbstractPagedInputView).

Specified by:

deserializeFromPages in class AbstractRowDataSerializer<RowData>

Throws:

IOException

mapFromPages

public RowData mapFromPages(AbstractPagedInputView source)
                     throws IOException

Description copied from class: AbstractRowDataSerializer

Map a 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.

Specified by:

mapFromPages in class AbstractRowDataSerializer<RowData>

Parameters:

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

Returns:

The mapped 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.

mapFromPages

public RowData mapFromPages(RowData reuse,
                            AbstractPagedInputView source)
                     throws IOException

Description copied from class: AbstractRowDataSerializer

Reuse version of AbstractRowDataSerializer.mapFromPages(AbstractPagedInputView).

Specified by:

mapFromPages in class AbstractRowDataSerializer<RowData>

Throws:

IOException

equals

public boolean equals(Object obj)

Specified by:

equals in class TypeSerializer<RowData>

hashCode

public int hashCode()

Specified by:

hashCode in class TypeSerializer<RowData>

isImmutableType

public boolean isImmutableType()

Description copied from class: TypeSerializer

Gets whether the type is an immutable type.

Specified by:

isImmutableType in class TypeSerializer<RowData>

Returns:

True, if the type is immutable.

getLength

public int getLength()

Description copied from class: TypeSerializer

Gets the length of the data type, if it is a fix length data type.

Specified by:

getLength in class TypeSerializer<RowData>

Returns:

The length of the data type, or -1 for variable length data types.

snapshotConfiguration

public TypeSerializerSnapshot<RowData> snapshotConfiguration()

Description copied from class: TypeSerializer

Snapshots the configuration of this TypeSerializer. This method is only relevant if the serializer is used to state stored in checkpoints/savepoints.

The snapshot of the TypeSerializer is supposed to contain all information that affects the serialization format of the serializer. The snapshot serves two purposes: First, to reproduce the serializer when the checkpoint/savepoint is restored, and second, to check whether the serialization format is compatible with the serializer used in the restored program.

IMPORTANT: TypeSerializerSnapshots changed after Flink 1.6. Serializers implemented against Flink versions up to 1.6 should still work, but adjust to new model to enable state evolution and be future-proof. See the class-level comments, section "Upgrading TypeSerializers to the new TypeSerializerSnapshot model" for details.

Specified by:

snapshotConfiguration in class TypeSerializer<RowData>

Returns:

snapshot of the serializer's current configuration (cannot be null).

See Also:

TypeSerializerSnapshot.resolveSchemaCompatibility(TypeSerializer)