org.apache.paimon.table.sink

Interface WriteBuilder

All Superinterfaces:

Serializable

All Known Subinterfaces:

BatchWriteBuilder, StreamWriteBuilder

All Known Implementing Classes:

BatchWriteBuilderImpl, StreamWriteBuilderImpl

@Public
public interface WriteBuilder
extends Serializable

An interface for building the TableWrite and TableCommit.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
TableCommit	newCommit() Create a TableCommit to commit CommitMessages.
TableWrite	newWrite() Create a TableWrite to write InternalRows.
Optional<WriteSelector>	newWriteSelector() Create a WriteSelector to partition records before writers.
RowType	rowType() Returns the row type of this table.
String	tableName() A name to identify this table.

Method Detail

tableName

String tableName()

A name to identify this table.

rowType

RowType rowType()

Returns the row type of this table.

newWriteSelector

@Experimental
Optional<WriteSelector> newWriteSelector()

Create a WriteSelector to partition records before writers.

Returns:

empty if no data distribution is required.

Throws:

UnsupportedOperationException - if this table mode does not support building writes through upper level APIs.

newWrite

TableWrite newWrite()

Create a TableWrite to write InternalRows.

newCommit

TableCommit newCommit()

Create a TableCommit to commit CommitMessages.