org.apache.paimon.io

Interface FileWriter<T,R>

Type Parameters:

T - record type.

R - file result to collect.

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

KeyValueDataFileWriter, RollingFileWriter, RowDataFileWriter, RowDataRollingFileWriter, SingleFileWriter, StatsCollectingSingleFileWriter

public interface FileWriter<T,R>
extends Closeable

File writer to accept one record or a branch of records and generate metadata after closing it.

Method Summary

Modifier and Type	Method and Description
void	abort() Abort to clear orphan file(s) if encounter any error.
long	recordCount() The total written record count.
R	result()
default void	write(CloseableIterator<T> records) Add records from CloseableIterator to this file writer.
default void	write(Iterable<T> records) Add records from Iterable to file writer.
default void	write(Iterator<T> records) Add records from Iterator to this file writer.
void	write(T record) Add only one record to this file writer.

Methods inherited from interface java.io.Closeable

close

Method Detail

write

void write(T record)
    throws IOException

Add only one record to this file writer.

NOTE: If any exception occurs during writing, the writer should clean up useless files for the user.

Parameters:

record - to write.

Throws:

IOException - if encounter any IO error.

write

default void write(Iterator<T> records)
            throws Exception

Add records from Iterator to this file writer.

NOTE: If any exception occurs during writing, the writer should clean up useless files for the user.

Parameters:

records - to write

Throws:

IOException - if encounter any IO error.

Exception

write

default void write(CloseableIterator<T> records)
            throws Exception

Add records from CloseableIterator to this file writer.

NOTE: If any exception occurs during writing, the writer should clean up useless files for the user.

Parameters:

records - to write

Throws:

IOException - if encounter any IO error.

Exception

write

default void write(Iterable<T> records)
            throws IOException

Add records from Iterable to file writer.

NOTE: If any exception occurs during writing, the writer should clean up useless files for the user.

Parameters:

records - to write.

Throws:

IOException - if encounter any IO error.

recordCount

long recordCount()

The total written record count.

Returns:

record count.

abort

void abort()

Abort to clear orphan file(s) if encounter any error.

NOTE: This implementation must be reentrant.

result

R result()
  throws IOException

Returns:

the result for this closed file writer.

Throws:

IOException