InternalRowSerializer (Paimon : 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.data.serializer.AbstractRowDataSerializer<InternalRow>
- - org.apache.paimon.data.serializer.InternalRowSerializer

All Implemented Interfaces:

Serializable, PagedTypeSerializer<InternalRow>, Serializer<InternalRow>
```
public class InternalRowSerializer
extends AbstractRowDataSerializer<InternalRow>
```
Serializer for InternalRow.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`InternalRowSerializer(DataType... types)`
`InternalRowSerializer(DataType[] types, Serializer<?>[] fieldSerializers)`
`InternalRowSerializer(RowType rowType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InternalRow`	`copy(InternalRow from)` Creates a deep copy of the given element in a new element.
`InternalRow`	`copyRowData(InternalRow from, InternalRow reuse)`
`InternalRow`	`deserialize(DataInputView source)` De-serializes a record from the given source input view.
`InternalRow`	`deserializeFromPages(AbstractPagedInputView source)` De-serializes a record from the given source paged input view.
`InternalRow`	`deserializeFromPages(InternalRow reuse, AbstractPagedInputView source)` Reuse version of `PagedTypeSerializer.deserializeFromPages(AbstractPagedInputView)`.
`InternalRowSerializer`	`duplicate()` Creates a deep copy of this serializer if it is necessary, i.e.
`boolean`	`equals(Object obj)`
`DataType[]`	`fieldTypes()`
`int`	`getArity()` Get the number of fields.
`int`	`hashCode()`
`InternalRow`	`mapFromPages(InternalRow reuse, AbstractPagedInputView source)` Map a reused record from the given source paged input view.
`void`	`serialize(InternalRow row, DataOutputView target)` Serializes the given record to the given target output view.
`int`	`serializeToPages(InternalRow row, AbstractPagedOutputView target)` Serializes the given record to the given target paged output view.
`void`	`skipRecordFromPages(AbstractPagedInputView source)` Skip over bytes of one record from the paged input view, discarding the skipped bytes.
`BinaryRow`	`toBinaryRow(InternalRow row)` Convert `InternalRow` into `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

- Constructor Detail
  - InternalRowSerializer
```
public InternalRowSerializer(RowType rowType)
```
  - InternalRowSerializer
```
public InternalRowSerializer(DataType... types)
```
  - InternalRowSerializer
```
public InternalRowSerializer(DataType[] types,
                             Serializer<?>[] fieldSerializers)
```
- Method Detail
  - duplicate
```
public InternalRowSerializer 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.
  - serialize
```
public void serialize(InternalRow row,
                      DataOutputView target)
               throws IOException
```
    Description copied from interface: Serializer
    
    Serializes the given record to the given target output view.
    
    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 InternalRow 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.
  - copy
```
public InternalRow copy(InternalRow 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.
  - copyRowData
```
public InternalRow copyRowData(InternalRow from,
                               InternalRow reuse)
```
  - getArity
```
public int getArity()
```
    Description copied from class: AbstractRowDataSerializer
    
    Get the number of fields.
    
    Specified by:
    
    getArity in class AbstractRowDataSerializer<InternalRow>
  - fieldTypes
```
public DataType[] fieldTypes()
```
  - toBinaryRow
```
public BinaryRow toBinaryRow(InternalRow row)
```
    Convert InternalRow into BinaryRow. TODO modify it to code gen.
    
    Specified by:
    
    toBinaryRow in class AbstractRowDataSerializer<InternalRow>
  - serializeToPages
```
public int serializeToPages(InternalRow row,
                            AbstractPagedOutputView target)
                     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:
    
    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 InternalRow deserializeFromPages(AbstractPagedInputView source)
                                 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:
    
    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 InternalRow deserializeFromPages(InternalRow reuse,
                                        AbstractPagedInputView source)
                                 throws IOException
```
    Description copied from interface: PagedTypeSerializer
    
    Reuse version of PagedTypeSerializer.deserializeFromPages(AbstractPagedInputView).
    
    Throws:
    
    IOException
  - mapFromPages
```
public InternalRow mapFromPages(InternalRow reuse,
                                AbstractPagedInputView source)
                         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
    
    source - 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 source)
                         throws IOException
```
    Description copied from interface: PagedTypeSerializer
    
    Skip over bytes of one record from the paged input view, discarding the skipped bytes.
    
    Throws:
    
    IOException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Back to Paimon Website

Class InternalRowSerializer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalRowSerializer

InternalRowSerializer

InternalRowSerializer

Method Detail

duplicate

serialize

deserialize

copy

copyRowData

getArity

fieldTypes

toBinaryRow

serializeToPages

deserializeFromPages

deserializeFromPages

mapFromPages

skipRecordFromPages

equals

hashCode

Back to Paimon Website