org.apache.paimon.table.sink

Interface TableWrite

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

BatchTableWrite, InnerTableWrite, StreamTableWrite

All Known Implementing Classes:

TableWriteImpl

@Public
public interface TableWrite
extends AutoCloseable

Write of Table to provide InternalRow writing.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
void	compact(BinaryRow partition, int bucket, boolean fullCompaction) Compact a bucket of a partition.
int	getBucket(InternalRow row) Calculate which bucket row belongs to.
BinaryRow	getPartition(InternalRow row) Calculate which partition row belongs to.
void	withInsertOnly(boolean insertOnly) This method is called when the insert only status of the records changes.
TableWrite	withIOManager(IOManager ioManager) With IOManager, this is needed if 'write-buffer-spillable' is set to true.
TableWrite	withMemoryPool(MemorySegmentPool memoryPool) With MemorySegmentPool for the current table write.
TableWrite	withMetricRegistry(MetricRegistry registry) With metrics to measure compaction.
void	write(InternalRow row) Write a row to the writer.
void	write(InternalRow row, int bucket) Write a row with bucket.
void	writeBundle(BinaryRow partition, int bucket, BundleRecords bundle) Write a bundle records directly, not per row.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

withIOManager

TableWrite withIOManager(IOManager ioManager)

With IOManager, this is needed if 'write-buffer-spillable' is set to true.

withMemoryPool

TableWrite withMemoryPool(MemorySegmentPool memoryPool)

With MemorySegmentPool for the current table write.

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.

getPartition

BinaryRow getPartition(InternalRow row)

Calculate which partition row belongs to.

getBucket

int getBucket(InternalRow row)

Calculate which bucket row belongs to.

write

void write(InternalRow row)
    throws Exception

Write a row to the writer.

Throws:

Exception

write

void write(InternalRow row,
           int bucket)
    throws Exception

Write a row with bucket.

Throws:

Exception

writeBundle

void writeBundle(BinaryRow partition,
                 int bucket,
                 BundleRecords bundle)
          throws Exception

Write a bundle records directly, not per row.

Throws:

Exception

compact

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

Compact a bucket of a partition. By default, it will determine whether to perform the compaction according to the 'num-sorted-run.compaction-trigger' option. If fullCompaction is true, it will force a full compaction, which is expensive.

NOTE: In Java API, full compaction is not automatically executed. If you set 'changelog-producer' to 'full-compaction', please execute this method regularly to produce changelog.

Throws:

Exception

withMetricRegistry

TableWrite withMetricRegistry(MetricRegistry registry)

With metrics to measure compaction.