Package org.apache.pulsar.compaction

Class PulsarTopicCompactionService

java.lang.Object

org.apache.pulsar.compaction.PulsarTopicCompactionService

All Implemented Interfaces:

AutoCloseable, TopicCompactionService

public class PulsarTopicCompactionService
extends Object
implements TopicCompactionService

Constructor Summary

Constructors

Constructor	Description
PulsarTopicCompactionService(String topic, BookKeeper bookKeeper, Supplier<Compactor> compactorSupplier)

Method Summary

Modifier and Type	Method	Description
void	close()
CompletableFuture<Void>	compact()	Compact the topic.
CompletableFuture<Entry>	findEntryByEntryIndex(long entryIndex)	Find the first entry that greater or equal to target entryIndex, if an entry that broker entry metadata is missed, then it will be skipped and find the next match entry.
CompletableFuture<Entry>	findEntryByPublishTime(long publishTime)	Find the first entry that greater or equal to target publishTime.
CompactedTopicImpl	getCompactedTopic()
CompletableFuture<Position>	getLastCompactedPosition()	Get the last compacted position from the TopicCompactionService.
CompletableFuture<List<Entry>>	readCompactedEntries(Position startPosition, int numberOfEntriesToRead)	Read the compacted entries from the TopicCompactionService.
CompletableFuture<Entry>	readLastCompactedEntry()	Read the last compacted entry from the TopicCompactionService.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PulsarTopicCompactionService

public PulsarTopicCompactionService(String topic,
 BookKeeper bookKeeper,
 Supplier<Compactor> compactorSupplier)

Method Details

compact

public CompletableFuture<Void> compact()

Description copied from interface: TopicCompactionService

Compact the topic. Topic Compaction is a key-based retention mechanism. It keeps the most recent value for a given key and user reads compacted data from TopicCompactionService.

Specified by:

compact in interface TopicCompactionService

Returns:

a future that will be completed when the compaction is done.

readCompactedEntries

public CompletableFuture<List<Entry>> readCompactedEntries(@Nonnull
 Position startPosition,
 int numberOfEntriesToRead)

Description copied from interface: TopicCompactionService

Read the compacted entries from the TopicCompactionService.

Specified by:

readCompactedEntries in interface TopicCompactionService

Parameters:

startPosition - the position to start reading from.

numberOfEntriesToRead - the maximum number of entries to read.

Returns:

a future that will be completed with the list of entries, this list can be null.

readLastCompactedEntry

public CompletableFuture<Entry> readLastCompactedEntry()

Description copied from interface: TopicCompactionService

Read the last compacted entry from the TopicCompactionService.

Specified by:

readLastCompactedEntry in interface TopicCompactionService

Returns:

a future that will be completed with the compacted last entry, this entry can be null.

getLastCompactedPosition

public CompletableFuture<Position> getLastCompactedPosition()

Description copied from interface: TopicCompactionService

Get the last compacted position from the TopicCompactionService.

Specified by:

getLastCompactedPosition in interface TopicCompactionService

Returns:

a future that will be completed with the last compacted position, this position can be null.

findEntryByPublishTime

public CompletableFuture<Entry> findEntryByPublishTime(long publishTime)

Description copied from interface: TopicCompactionService

Find the first entry that greater or equal to target publishTime.

Specified by:

findEntryByPublishTime in interface TopicCompactionService

Parameters:

publishTime - the publish time of entry.

Returns:

the first entry metadata that greater or equal to target publishTime, this entry can be null.

findEntryByEntryIndex

public CompletableFuture<Entry> findEntryByEntryIndex(long entryIndex)

Description copied from interface: TopicCompactionService

Find the first entry that greater or equal to target entryIndex, if an entry that broker entry metadata is missed, then it will be skipped and find the next match entry.

Specified by:

findEntryByEntryIndex in interface TopicCompactionService

Parameters:

entryIndex - the index of entry.

Returns:

the first entry that greater or equal to target entryIndex, this entry can be null.

getCompactedTopic

public CompactedTopicImpl getCompactedTopic()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException