org.apache.paimon.format

接口 FormatWriter

public interface FormatWriter

The writer that writes records.

方法概要

限定符和类型	方法和说明
void	addElement(InternalRow element) Adds an element to the encoder.
void	finish() Finishes the writing.
void	flush() Flushes all intermediate buffered data to the output stream.
boolean	reachTargetSize(boolean suggestedCheck, long targetSize) Check if the writer has reached the targetSize.

方法详细资料

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.

参数:

element - The element to add.

抛出:

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

flush

void flush()
    throws IOException

Flushes all intermediate buffered data to the output stream. It is expected that flushing often may reduce the efficiency of the encoding.

抛出:

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

finish

void finish()
     throws IOException

Finishes the writing. This must flush all internal buffer, finish encoding, and write footers.

The writer is not expected to handle any more records via addElement(InternalRow) after this method is called.

Important: This method MUST NOT close the stream that the writer writes to. Closing the stream is expected to happen through the invoker of this method afterwards.

抛出:

IOException - Thrown if the finalization fails.

reachTargetSize

boolean reachTargetSize(boolean suggestedCheck,
                        long targetSize)
                 throws IOException

Check if the writer has reached the targetSize.

参数:

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

targetSize - The size of the target.

返回:

true if the target size was reached, otherwise false.

抛出:

IOException - Thrown if calculating the length fails.