org.apache.paimon.flink.sink

Interface StoreSinkWrite

All Known Implementing Classes:

AsyncLookupSinkWrite, GlobalFullCompactionSinkWrite, StoreSinkWriteImpl

public interface StoreSinkWrite

Helper class of PrepareCommitOperator for different types of paimon sinks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StoreSinkWrite.Provider Provider of StoreSinkWrite.
static interface	StoreSinkWrite.WithWriteBufferProvider Provider of StoreSinkWrite that uses given write buffer.

Method Summary

Modifier and Type	Method and Description
void	close()
void	compact(BinaryRow partition, int bucket, boolean fullCompaction)
void	notifyNewFiles(long snapshotId, BinaryRow partition, int bucket, List<DataFileMeta> files)
List<Committable>	prepareCommit(boolean waitCompaction, long checkpointId)
void	replace(FileStoreTable newTable) Replace the internal TableWriteImpl with the one provided by newWriteProvider.
void	snapshotState()
boolean	streamingMode()
SinkRecord	toLogRecord(SinkRecord record)
void	withInsertOnly(boolean insertOnly) This method is called when the insert only status of the records changes.
SinkRecord	write(InternalRow rowData)
SinkRecord	write(InternalRow rowData, int bucket)

Method Detail

withInsertOnly

void withInsertOnly(boolean insertOnly)

This method is called when the insert only status of the records changes.

Parameters:

insertOnly - If true, all the following records would be of RowKind.INSERT, and no two records would have the same primary key.

write

@Nullable
SinkRecord write(InternalRow rowData)
                    throws Exception

Throws:

Exception

write

@Nullable
SinkRecord write(InternalRow rowData,
                           int bucket)
                    throws Exception

Throws:

Exception

toLogRecord

SinkRecord toLogRecord(SinkRecord record)

compact

void compact(BinaryRow partition,
             int bucket,
             boolean fullCompaction)
      throws Exception

Throws:

Exception

notifyNewFiles

void notifyNewFiles(long snapshotId,
                    BinaryRow partition,
                    int bucket,
                    List<DataFileMeta> files)

prepareCommit

List<Committable> prepareCommit(boolean waitCompaction,
                                long checkpointId)
                         throws IOException

Throws:

IOException

snapshotState

void snapshotState()
            throws Exception

Throws:

Exception

streamingMode

boolean streamingMode()

close

void close()
    throws Exception

Throws:

Exception

replace

void replace(FileStoreTable newTable)
      throws Exception

Replace the internal TableWriteImpl with the one provided by newWriteProvider. The state of the old TableWriteImpl will also be transferred to the new TableWriteImpl by TableWriteImpl.checkpoint() and TableWriteImpl.restore(List).

Currently, this method is only used by CDC sinks because they need to deal with schema changes. TableWriteImpl with the new schema will be provided by newWriteProvider.

Throws:

Exception