org.apache.paimon.format

Interface FormatWriter

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

BundleFormatWriter

All Known Implementing Classes:

OrcBulkWriter, ParquetBulkWriter

public interface FormatWriter
extends Closeable

The writer that writes records.

Method Summary

Modifier and Type	Method and Description
void	addElement(InternalRow element) Adds an element to the encoder.
boolean	reachTargetSize(boolean suggestedCheck, long targetSize) Check if the writer has reached the targetSize.

Methods inherited from interface java.io.Closeable

close

Method Detail

addElement

void addElement(InternalRow element)
         throws IOException

Adds an element to the encoder. The encoder may temporarily buffer the element, or immediately write it to the stream.

It may be that adding this element fills up an internal buffer and causes the encoding and flushing of a batch of internally buffered elements.

Parameters:

element - The element to add.

Throws:

IOException - Thrown, if the element cannot be added to the encoder, or if the output stream throws an exception.

reachTargetSize

boolean reachTargetSize(boolean suggestedCheck,
                        long targetSize)
                 throws IOException

Check if the writer has reached the targetSize.

Parameters:

suggestedCheck - Whether it needs to be checked, but subclasses can also decide whether to check it themselves.

targetSize - The size of the target.

Returns:

true if the target size was reached, otherwise false.

Throws:

IOException - Thrown if calculating the length fails.