org.apache.paimon.io

Class SingleFileWriter<T,R>

java.lang.Object

org.apache.paimon.io.SingleFileWriter<T,R>

Type Parameters:

T - type of records to write.

R - type of result to produce after writing a file.

All Implemented Interfaces:

Closeable, AutoCloseable, FileWriter<T,R>

Direct Known Subclasses:

StatsCollectingSingleFileWriter

public abstract class SingleFileWriter<T,R>
extends Object
implements FileWriter<T,R>

A FileWriter to produce a single file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleFileWriter.AbortExecutor Abort executor to just have reference of path instead of whole writer.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed
protected FileIO	fileIO
protected Path	path

Constructor Summary

Constructors

Constructor and Description
SingleFileWriter(FileIO fileIO, FormatWriterFactory factory, Path path, java.util.function.Function<T,InternalRow> converter, String compression, boolean asyncWrite)

Method Summary

Modifier and Type	Method and Description
void	abort() Abort to clear orphan file(s) if encounter any error.
SingleFileWriter.AbortExecutor	abortExecutor()
void	close()
Path	path()
boolean	reachTargetSize(boolean suggestedCheck, long targetSize)
long	recordCount() The total written record count.
void	write(T record) Add only one record to this file writer.
void	writeBundle(BundleRecords bundle)
protected InternalRow	writeImpl(T record)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.io.FileWriter

result, write, write, write

Field Detail

fileIO

protected final FileIO fileIO

path

protected final Path path

closed

protected boolean closed

Constructor Detail

SingleFileWriter

public SingleFileWriter(FileIO fileIO,
                        FormatWriterFactory factory,
                        Path path,
                        java.util.function.Function<T,InternalRow> converter,
                        String compression,
                        boolean asyncWrite)

Method Detail

path

public Path path()

write

public void write(T record)
           throws IOException

Description copied from interface: FileWriter

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.

Specified by:

write in interface FileWriter<T,R>

Parameters:

record - to write.

Throws:

IOException - if encounter any IO error.

writeBundle

public void writeBundle(BundleRecords bundle)
                 throws IOException

Throws:

IOException

writeImpl

protected InternalRow writeImpl(T record)
                         throws IOException

Throws:

IOException

recordCount

public long recordCount()

Description copied from interface: FileWriter

The total written record count.

Specified by:

recordCount in interface FileWriter<T,R>

Returns:

record count.

reachTargetSize

public boolean reachTargetSize(boolean suggestedCheck,
                               long targetSize)
                        throws IOException

Throws:

IOException

abort

public void abort()

Description copied from interface: FileWriter

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

NOTE: This implementation must be reentrant.

Specified by:

abort in interface FileWriter<T,R>

abortExecutor

public SingleFileWriter.AbortExecutor abortExecutor()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException