Package org.apache.bookkeeper.bookie

Class TransactionalEntryLogCompactor

java.lang.Object

org.apache.bookkeeper.bookie.AbstractLogCompactor

org.apache.bookkeeper.bookie.TransactionalEntryLogCompactor

public class TransactionalEntryLogCompactor
extends AbstractLogCompactor

This class is used for compaction. Compaction is done in several transactional phases. Phase 1: Scan old entry log and compact entries to a new .compacting log file. Phase 2: Flush .compacting log to disk and it becomes .compacted log file when this completes. Phase 3: Flush ledger cache and .compacted file becomes .log file when this completes. Remove old entry log file afterwards.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TransactionalEntryLogCompactor.CompactionPhase	An abstract class that would be extended to be the actual transactional phases for compaction.
(package private) class	TransactionalEntryLogCompactor.FlushCompactionLogPhase	Assume we're compacting log 1 to log 3.
(package private) class	TransactionalEntryLogCompactor.ScanEntryLogPhase	Assume we're compacting entry log 1 to entry log 3.
(package private) class	TransactionalEntryLogCompactor.UpdateIndexPhase	Assume we're compacting log 1 to log 3.

Nested classes/interfaces inherited from class org.apache.bookkeeper.bookie.AbstractLogCompactor

AbstractLogCompactor.LogRemovalListener, AbstractLogCompactor.Throttler

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPACTED_SUFFIX
static final String	COMPACTING_SUFFIX
(package private) final EntryLogger	entryLogger
(package private) final CompactableLedgerStorage	ledgerStorage
(package private) final List<EntryLocation>	offsets

Fields inherited from class org.apache.bookkeeper.bookie.AbstractLogCompactor

conf, logRemovalListener, throttler

Constructor Summary

Constructors

Constructor	Description
TransactionalEntryLogCompactor(ServerConfiguration conf, EntryLogger entryLogger, CompactableLedgerStorage ledgerStorage, AbstractLogCompactor.LogRemovalListener logRemover)

Method Summary

Modifier and Type	Method	Description
void	cleanUpAndRecover()	Delete all previously incomplete compacting logs and recover the index for compacted logs.
boolean	compact(EntryLogMetadata metadata)	Compact entry log file.

Methods inherited from class java.lang.Object

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

Field Details

entryLogger

final EntryLogger entryLogger

ledgerStorage

final CompactableLedgerStorage ledgerStorage

offsets

final List<EntryLocation> offsets

COMPACTING_SUFFIX

public static final String COMPACTING_SUFFIX

See Also:

• Constant Field Values

COMPACTED_SUFFIX

public static final String COMPACTED_SUFFIX

See Also:

• Constant Field Values

Constructor Details

TransactionalEntryLogCompactor

public TransactionalEntryLogCompactor(ServerConfiguration conf,
 EntryLogger entryLogger,
 CompactableLedgerStorage ledgerStorage,
 AbstractLogCompactor.LogRemovalListener logRemover)

Method Details

cleanUpAndRecover

public void cleanUpAndRecover()

Delete all previously incomplete compacting logs and recover the index for compacted logs.

Overrides:

cleanUpAndRecover in class AbstractLogCompactor

compact

public boolean compact(EntryLogMetadata metadata)

Description copied from class: AbstractLogCompactor

Compact entry log file.

Specified by:

compact in class AbstractLogCompactor

Parameters:

metadata - log metadata for the entry log to be compacted

Returns:

true for succeed