org.apache.iceberg.io

Interface PartitioningWriter<T,R>

Type Parameters:

T - the row type

R - the result type

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

ClusteredDataWriter, ClusteredEqualityDeleteWriter, ClusteredPositionDeleteWriter, FanoutDataWriter

public interface PartitioningWriter<T,R>
extends java.io.Closeable

A writer capable of writing files of a single type (i.e. data/delete) to multiple specs and partitions.

As opposed to FileWriter, this interface should be implemented by writers that are not limited to writing to a single spec/partition. Implementations may internally use FileWriters for writing to a single spec/partition.

Note that this writer can be used both for partitioned and unpartitioned tables.

Method Summary

Modifier and Type	Method and Description
R	result() Returns a result that contains information about written DataFiles or DeleteFiles.
void	write(T row, PartitionSpec spec, StructLike partition) Writes a row to the provided spec/partition.

Methods inherited from interface java.io.Closeable

close

Method Detail

write

void write(T row,
           PartitionSpec spec,
           StructLike partition)

Writes a row to the provided spec/partition.

Parameters:

row - a data or delete record

spec - a partition spec

partition - a partition or null if the spec is unpartitioned

result

R result()

Returns a result that contains information about written DataFiles or DeleteFiles. The result is valid only after the writer is closed.

Returns:

the writer result