org.apache.paimon.table.sink

Interface StreamTableWrite

All Superinterfaces:

AutoCloseable, TableWrite

All Known Subinterfaces:

InnerTableWrite

All Known Implementing Classes:

TableWriteImpl

@Public
public interface StreamTableWrite
extends TableWrite

A TableWrite for stream processing. You can use this class to commit multiple times.

Since:

0.4.0

See Also:

StreamWriteBuilder

Method Summary

Modifier and Type	Method and Description
List<CommitMessage>	prepareCommit(boolean waitCompaction, long commitIdentifier) Prepare commit for TableCommit.

Methods inherited from interface org.apache.paimon.table.sink.TableWrite

compact, getBucket, getPartition, withInsertOnly, withIOManager, withMemoryPool, withMetricRegistry, write, write, writeBundle

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

prepareCommit

List<CommitMessage> prepareCommit(boolean waitCompaction,
                                  long commitIdentifier)
                           throws Exception

Prepare commit for TableCommit. Collect incremental files for this write.

Parameters:

waitCompaction - whether to wait for the end of the background compaction.

commitIdentifier - Committed transaction ID, can start from 0. If there are multiple commits, please increment this ID.

Throws:

Exception

See Also:

StreamTableCommit.commit(long, java.util.List<org.apache.paimon.table.sink.CommitMessage>)