org.apache.druid.segment.realtime.appenderator

Interface TransactionalSegmentPublisher

public interface TransactionalSegmentPublisher

Method Summary

Modifier and Type	Method and Description
SegmentPublishResult	publishAnnotatedSegments(Set<DataSegment> segmentsToBeOverwritten, Set<DataSegment> segmentsToPublish, Object commitMetadata) Publish segments, along with some commit metadata, in a single transaction.
default SegmentPublishResult	publishSegments(Set<DataSegment> segmentsToBeOverwritten, Set<DataSegment> segmentsToPublish, Object commitMetadata)
default boolean	supportsEmptyPublish()

Method Detail

publishAnnotatedSegments

SegmentPublishResult publishAnnotatedSegments(@Nullable
                                              Set<DataSegment> segmentsToBeOverwritten,
                                              Set<DataSegment> segmentsToPublish,
                                              @Nullable
                                              Object commitMetadata)
                                       throws IOException

Publish segments, along with some commit metadata, in a single transaction.

Returns:

publish result that indicates if segments were published or not. If it is unclear if the segments were published or not, this method must throw an exception. The behavior is similar to IndexerSQLMetadataStorageCoordinator's announceHistoricalSegments.

Throws:

IOException - if there was an I/O error when publishing

RuntimeException - if we cannot tell if the segments were published or not, for some other reason

publishSegments

default SegmentPublishResult publishSegments(@Nullable
                                             Set<DataSegment> segmentsToBeOverwritten,
                                             Set<DataSegment> segmentsToPublish,
                                             @Nullable
                                             Object commitMetadata)
                                      throws IOException

Throws:

IOException

supportsEmptyPublish

default boolean supportsEmptyPublish()

Returns:

true if this publisher has action to take when publishing with an empty segment set. The publisher used by the seekable stream tasks is an example where this is true.