org.apache.flink.table.runtime.typeutils

Class BaseRowSerializer

java.lang.Object

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

org.apache.flink.table.runtime.typeutils.AbstractRowSerializer<BaseRow>

org.apache.flink.table.runtime.typeutils.BaseRowSerializer

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BaseRowSerializer

public class BaseRowSerializer
extends AbstractRowSerializer<BaseRow>

Serializer for BaseRow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseRowSerializer.BaseRowSerializerSnapshot TypeSerializerSnapshot for BinaryRowSerializer.

Constructor Summary

Constructors

Constructor and Description
BaseRowSerializer(ExecutionConfig config, LogicalType... types)
BaseRowSerializer(ExecutionConfig config, RowType rowType)
BaseRowSerializer(LogicalType[] types, TypeSerializer[] fieldSerializers)

Method Summary

Modifier and Type	Method and Description
BaseRow	copy(BaseRow from) Creates a deep copy of the given element in a new element.
BaseRow	copy(BaseRow from, BaseRow reuse) Creates a copy from the given element.
void	copy(DataInputView source, DataOutputView target) Copies exactly one record from the source input view to the target output view.
BaseRow	createInstance() Creates a new instance of the data type.
BaseRow	deserialize(BaseRow reuse, DataInputView source) De-serializes a record from the given source input view into the given reuse record instance if mutable.
BaseRow	deserialize(DataInputView source) De-serializes a record from the given source input view.
BaseRow	deserializeFromPages(AbstractPagedInputView source) De-serializes a record from the given source paged input view.
BaseRow	deserializeFromPages(BaseRow reuse, AbstractPagedInputView source) Reuse version of AbstractRowSerializer.deserializeFromPages(AbstractPagedInputView).
TypeSerializer<BaseRow>	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.
BaseRow	mapFromPages(AbstractPagedInputView source) Map a record from the given source paged input view.
BaseRow	mapFromPages(BaseRow reuse, AbstractPagedInputView source) Reuse version of AbstractRowSerializer.mapFromPages(AbstractPagedInputView).
void	serialize(BaseRow row, DataOutputView target) Serializes the given record to the given target output view.
int	serializeToPages(BaseRow row, AbstractPagedOutputView target) Serializes the given record to the given target paged output view.
TypeSerializerSnapshot<BaseRow>	snapshotConfiguration() Snapshots the configuration of this TypeSerializer.
BinaryRow	toBinaryRow(BaseRow row) Convert base row to binary row.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRowSerializer

public BaseRowSerializer(ExecutionConfig config,
                         RowType rowType)

BaseRowSerializer

public BaseRowSerializer(ExecutionConfig config,
                         LogicalType... types)

BaseRowSerializer

public BaseRowSerializer(LogicalType[] types,
                         TypeSerializer[] fieldSerializers)

Method Detail

duplicate

public TypeSerializer<BaseRow> 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<BaseRow>

createInstance

public BaseRow createInstance()

Description copied from class: TypeSerializer

Creates a new instance of the data type.

Specified by:

createInstance in class TypeSerializer<BaseRow>

Returns:

A new instance of the data type.

serialize

public void serialize(BaseRow 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<BaseRow>

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 BaseRow 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<BaseRow>

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 BaseRow deserialize(BaseRow 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<BaseRow>

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 BaseRow copy(BaseRow from)

Description copied from class: TypeSerializer

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

Specified by:

copy in class TypeSerializer<BaseRow>

Parameters:

from - The element reuse be copied.

Returns:

A deep copy of the element.

copy

public BaseRow copy(BaseRow from,
                    BaseRow 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<BaseRow>

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<BaseRow>

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: AbstractRowSerializer

Get the number of fields.

Specified by:

getArity in class AbstractRowSerializer<BaseRow>

toBinaryRow

public BinaryRow toBinaryRow(BaseRow row)

Convert base row to binary row. TODO modify it to code gen.

Specified by:

toBinaryRow in class AbstractRowSerializer<BaseRow>

serializeToPages

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

Description copied from class: AbstractRowSerializer

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.

Specified by:

serializeToPages in class AbstractRowSerializer<BaseRow>

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 BaseRow deserializeFromPages(AbstractPagedInputView source)
                             throws IOException

Description copied from class: AbstractRowSerializer

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

Specified by:

deserializeFromPages in class AbstractRowSerializer<BaseRow>

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

Description copied from class: AbstractRowSerializer

Reuse version of AbstractRowSerializer.deserializeFromPages(AbstractPagedInputView).

Specified by:

deserializeFromPages in class AbstractRowSerializer<BaseRow>

Throws:

IOException

mapFromPages

public BaseRow mapFromPages(AbstractPagedInputView source)
                     throws IOException

Description copied from class: AbstractRowSerializer

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 AbstractRowSerializer<BaseRow>

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

Description copied from class: AbstractRowSerializer

Reuse version of AbstractRowSerializer.mapFromPages(AbstractPagedInputView).

Specified by:

mapFromPages in class AbstractRowSerializer<BaseRow>

Throws:

IOException

equals

public boolean equals(Object obj)

Specified by:

equals in class TypeSerializer<BaseRow>

hashCode

public int hashCode()

Specified by:

hashCode in class TypeSerializer<BaseRow>

isImmutableType

public boolean isImmutableType()

Description copied from class: TypeSerializer

Gets whether the type is an immutable type.

Specified by:

isImmutableType in class TypeSerializer<BaseRow>

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<BaseRow>

Returns:

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

snapshotConfiguration

public TypeSerializerSnapshot<BaseRow> 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<BaseRow>

Returns:

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

See Also:

TypeSerializerSnapshot.resolveSchemaCompatibility(TypeSerializer)