Package io.camunda.zeebe.snapshots.impl

Class FileBasedSnapshotStore

java.lang.Object

io.camunda.zeebe.scheduler.Actor

io.camunda.zeebe.snapshots.impl.FileBasedSnapshotStore

All Implemented Interfaces:

AsyncClosable, ConcurrencyControl, BootstrapSnapshotStore, ConstructableSnapshotStore, PersistedSnapshotStore, ReceivableSnapshotStore, RestorableSnapshotStore, CloseableSilently, AutoCloseable, Executor

public final class FileBasedSnapshotStore
extends Actor
implements ConstructableSnapshotStore, ReceivableSnapshotStore, RestorableSnapshotStore, BootstrapSnapshotStore

Nested Class Summary

Nested classes/interfaces inherited from class io.camunda.zeebe.scheduler.Actor

Actor.ActorBuilder

Field Summary

Fields inherited from class io.camunda.zeebe.scheduler.Actor

actor, ACTOR_PROP_NAME, ACTOR_PROP_PARTITION_ID

Constructor Summary

Constructors

Constructor	Description
FileBasedSnapshotStore(int brokerId, int partitionId, Path root, CRC32CChecksumProvider checksumProvider, io.micrometer.core.instrument.MeterRegistry meterRegistry)

Method Summary

Modifier and Type	Method	Description
ActorFuture<Void>	abortPendingSnapshots()	Purges all ongoing pending/transient/volatile snapshots.
ActorFuture<Boolean>	addSnapshotListener(PersistedSnapshotListener listener)	Adds an PersistedSnapshotListener to the store, which is notified when a new PersistedSnapshot is persisted at this store.
ActorFuture<PersistedSnapshot>	copyForBootstrap(PersistedSnapshot persistedSnapshot, BiConsumer<Path,Path> copySnapshot)	Makes a copy of the given snapshot to the given destination folder, keeping only the columns needed for the bootstrap process of a new partition.
protected Map<String,String>	createContext()
ActorFuture<Void>	delete()	Deletes a PersistedSnapshotStore from disk.
ActorFuture<Void>	deleteBootstrapSnapshots()
ActorFuture<Set<PersistedSnapshot>>	getAvailableSnapshots()	Returns a set of all available snapshots.
Optional<PersistedSnapshot>	getBootstrapSnapshot()
ActorFuture<Long>	getCompactionBound()	Returns the lowest compaction bound of all available snapshots.
long	getCurrentSnapshotIndex()
Optional<PersistedSnapshot>	getLatestSnapshot()
String	getName()
Path	getPath()
SnapshotMetrics	getSnapshotMetrics()
boolean	hasSnapshotId(String id)	Returns true if the given identifier is equal to the snapshot id of the current persisted snapshot, false otherwise.
ActorFuture<FileBasedReceivedSnapshot>	newReceivedSnapshot(String snapshotId)	Starts a new received volatile snapshot which can be persisted later.
Either<SnapshotException,TransientSnapshot>	newTransientSnapshot(long index, long term, long processedPosition, long exportedPosition, boolean forceSnapshot)	Starts a new transient snapshot which can be persisted after the snapshot was taken.
protected void	onActorClosing()
protected void	onActorStarting()
ActorFuture<Boolean>	removeSnapshotListener(PersistedSnapshotListener listener)	Removes an registered PersistedSnapshotListener from the store.
ActorFuture<Void>	restore(PersistedSnapshot snapshot)	Restore a PersistedSnapshot using the actor context in order to be thread safe
void	restore(String snapshotId, Map<String,Path> snapshotFiles)	Restores the snapshot by moving the snapshotFiles to the snapshotDirectory.
String	toString()

Methods inherited from class io.camunda.zeebe.scheduler.Actor

buildActorName, call, close, closeAsync, getContext, handleFailure, isActorClosed, newActor, onActorClosed, onActorCloseRequested, onActorFailed, onActorStarted, run, runOnCompletion, runOnCompletion, schedule, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.zeebe.util.CloseableSilently

close

Methods inherited from interface io.camunda.zeebe.scheduler.ConcurrencyControl

createCompletedFuture, createFuture, execute

Constructor Details

FileBasedSnapshotStore

public FileBasedSnapshotStore(int brokerId,
 int partitionId,
 Path root,
 CRC32CChecksumProvider checksumProvider,
 io.micrometer.core.instrument.MeterRegistry meterRegistry)

Method Details

createContext

protected Map<String,String> createContext()

Overrides:

createContext in class Actor

getName

public String getName()

Overrides:

getName in class Actor

onActorStarting

protected void onActorStarting()

Overrides:

onActorStarting in class Actor

onActorClosing

protected void onActorClosing()

Overrides:

onActorClosing in class Actor

hasSnapshotId

public boolean hasSnapshotId(String id)

Description copied from interface: PersistedSnapshotStore

Returns true if the given identifier is equal to the snapshot id of the current persisted snapshot, false otherwise.

Specified by:

hasSnapshotId in interface PersistedSnapshotStore

Parameters:

id - the snapshot Id to look for

Returns:

true if the current snapshot has the equal Id, false otherwise

See Also:

• SnapshotId.getSnapshotIdAsString()

getLatestSnapshot

public Optional<PersistedSnapshot> getLatestSnapshot()

Specified by:

getLatestSnapshot in interface PersistedSnapshotStore

Returns:

the latest PersistedSnapshot if exists

getAvailableSnapshots

public ActorFuture<Set<PersistedSnapshot>> getAvailableSnapshots()

Description copied from interface: PersistedSnapshotStore

Returns a set of all available snapshots.

Specified by:

getAvailableSnapshots in interface PersistedSnapshotStore

getCompactionBound

public ActorFuture<Long> getCompactionBound()

Description copied from interface: PersistedSnapshotStore

Returns the lowest compaction bound of all available snapshots.

Specified by:

getCompactionBound in interface PersistedSnapshotStore

abortPendingSnapshots

public ActorFuture<Void> abortPendingSnapshots()

Description copied from interface: PersistedSnapshotStore

Purges all ongoing pending/transient/volatile snapshots.

Specified by:

abortPendingSnapshots in interface PersistedSnapshotStore

Returns:

future which will be completed when all pending snapshots are deleted

addSnapshotListener

public ActorFuture<Boolean> addSnapshotListener(PersistedSnapshotListener listener)

Description copied from interface: PersistedSnapshotStore

Adds an PersistedSnapshotListener to the store, which is notified when a new PersistedSnapshot is persisted at this store.

Specified by:

addSnapshotListener in interface PersistedSnapshotStore

Parameters:

listener - the listener which should be added and notified later

removeSnapshotListener

public ActorFuture<Boolean> removeSnapshotListener(PersistedSnapshotListener listener)

Description copied from interface: PersistedSnapshotStore

Removes an registered PersistedSnapshotListener from the store. The listener will no longer called when a new PersistedSnapshot is persisted at this store.

Specified by:

removeSnapshotListener in interface PersistedSnapshotStore

Parameters:

listener - the listener which should be removed

getCurrentSnapshotIndex

public long getCurrentSnapshotIndex()

Specified by:

getCurrentSnapshotIndex in interface PersistedSnapshotStore

Returns:

the snapshot index of the latest PersistedSnapshot

See Also:

• PersistedSnapshotStore.getLatestSnapshot()

delete

public ActorFuture<Void> delete()

Description copied from interface: PersistedSnapshotStore

Deletes a PersistedSnapshotStore from disk.

The snapshot store will be deleted by simply reading snapshot file names from disk and deleting snapshot files directly. Deleting the snapshot store does not involve reading any snapshot files into memory.

Specified by:

delete in interface PersistedSnapshotStore

getPath

public Path getPath()

Specified by:

getPath in interface PersistedSnapshotStore

newReceivedSnapshot

public ActorFuture<FileBasedReceivedSnapshot> newReceivedSnapshot(String snapshotId)

Description copied from interface: ReceivableSnapshotStore

Starts a new received volatile snapshot which can be persisted later.

Specified by:

newReceivedSnapshot in interface ReceivableSnapshotStore

Parameters:

snapshotId - the snapshot id which is defined as index-term-timestamp-processedposition-exportedposition

Returns:

the new volatile received snapshot

newTransientSnapshot

public Either<SnapshotException,TransientSnapshot> newTransientSnapshot(long index,
 long term,
 long processedPosition,
 long exportedPosition,
 boolean forceSnapshot)

Description copied from interface: ConstructableSnapshotStore

Starts a new transient snapshot which can be persisted after the snapshot was taken.

Specified by:

newTransientSnapshot in interface ConstructableSnapshotStore

Parameters:

index - the index to which the snapshot corresponds to

term - the term to which the snapshots corresponds to

processedPosition - the processed position in the snapshot

exportedPosition - the exported position in the snapshot

Returns:

either an exception or transientSnapshot, if it was taken successfully.

getBootstrapSnapshot

public Optional<PersistedSnapshot> getBootstrapSnapshot()

Specified by:

getBootstrapSnapshot in interface BootstrapSnapshotStore

Returns:

the latest snapshot that was copied if present.

copyForBootstrap

public ActorFuture<PersistedSnapshot> copyForBootstrap(PersistedSnapshot persistedSnapshot,
 BiConsumer<Path,Path> copySnapshot)

Description copied from interface: BootstrapSnapshotStore

Makes a copy of the given snapshot to the given destination folder, keeping only the columns needed for the bootstrap process of a new partition. Any raft related data is removed.

Only one snapshot for bootstrap can be taken at a time. It will be located into the "bootstrap-snapshots" folder.

Specified by:

copyForBootstrap in interface BootstrapSnapshotStore

Parameters:

persistedSnapshot - the persisted snapshot to copy

copySnapshot - the consumer which copies the snapshot to the destination folder. The first argument is the path of the source snapshot and the second argument is the destination folder

deleteBootstrapSnapshots

public ActorFuture<Void> deleteBootstrapSnapshots()

Specified by:

deleteBootstrapSnapshots in interface BootstrapSnapshotStore

Returns:

an ActorFuture which completes when all bootstrap snapshots have been deleted

restore

public void restore(String snapshotId,
 Map<String,Path> snapshotFiles)
             throws IOException

Description copied from interface: RestorableSnapshotStore

Restores the snapshot by moving the snapshotFiles to the snapshotDirectory.

WARN. Implementation of this method can be not thread safe.

Specified by:

restore in interface RestorableSnapshotStore

Parameters:

snapshotId -

snapshotFiles -

Throws:

IOException

restore

public ActorFuture<Void> restore(PersistedSnapshot snapshot)

Description copied from interface: RestorableSnapshotStore

Restore a PersistedSnapshot using the actor context in order to be thread safe

Specified by:

restore in interface RestorableSnapshotStore

getSnapshotMetrics

public SnapshotMetrics getSnapshotMetrics()

toString

public String toString()

Overrides:

toString in class Object