org.apache.paimon.io

Class RollingFileWriter<T,R>

java.lang.Object

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

Type Parameters:

T - record data type.

R - the file metadata result.

All Implemented Interfaces:

Closeable, AutoCloseable, FileWriter<T,List<R>>

Direct Known Subclasses:

RowDataRollingFileWriter

public class RollingFileWriter<T,R>
extends Object
implements FileWriter<T,List<R>>

Writer to roll over to a new file if the current size exceed the target file size.

Constructor Summary

Constructors

Constructor and Description
RollingFileWriter(java.util.function.Supplier<? extends SingleFileWriter<T,R>> writerFactory, long targetFileSize)

Method Summary

Modifier and Type	Method and Description
void	abort() Abort to clear orphan file(s) if encounter any error.
void	close()
long	recordCount() The total written record count.
List<R>	result()
long	targetFileSize()
void	write(T row) Add only one record to this file writer.
void	writeBundle(BundleRecords bundle)

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

write, write, write

Constructor Detail

RollingFileWriter

public RollingFileWriter(java.util.function.Supplier<? extends SingleFileWriter<T,R>> writerFactory,
                         long targetFileSize)

Method Detail

targetFileSize

@VisibleForTesting
public long targetFileSize()

write

public void write(T row)
           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,List<R>>

Parameters:

row - to write.

Throws:

IOException - if encounter any IO error.

writeBundle

public void writeBundle(BundleRecords bundle)
                 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,List<R>>

Returns:

record count.

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,List<R>>

result

public List<R> result()

Specified by:

result in interface FileWriter<T,List<R>>

Returns:

the result for this closed file writer.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException