com.alipay.sofa.jraft.storage.log

Class RocksDBSegmentLogStorage

java.lang.Object

com.alipay.sofa.jraft.storage.impl.RocksDBLogStorage

com.alipay.sofa.jraft.storage.log.RocksDBSegmentLogStorage

All Implemented Interfaces:

Lifecycle<LogStorageOptions>, LogStorage, Storage, Describer

public class RocksDBSegmentLogStorage
extends RocksDBLogStorage

Log Storage implementation based on rocksdb and segment files.

Author:

boyan(boyan@antfin.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RocksDBSegmentLogStorage.BarrierWriteContext
static class	RocksDBSegmentLogStorage.Builder RocksDBSegmentLogStorage builder

Nested classes/interfaces inherited from class com.alipay.sofa.jraft.storage.impl.RocksDBLogStorage

RocksDBLogStorage.EmptyWriteContext, RocksDBLogStorage.WriteContext

Nested classes/interfaces inherited from interface com.alipay.sofa.jraft.util.Describer

Describer.DefaultPrinter, Describer.Printer

Field Summary

Fields inherited from class com.alipay.sofa.jraft.storage.impl.RocksDBLogStorage

FIRST_LOG_IDX_KEY, PART_ROCKSDB_OPTIONS_KEY

Constructor Summary

Constructors

Constructor and Description
RocksDBSegmentLogStorage(String path, RaftOptions raftOptions)
RocksDBSegmentLogStorage(String path, RaftOptions raftOptions, int valueSizeThreshold, int maxSegmentFileSize)
RocksDBSegmentLogStorage(String path, RaftOptions raftOptions, int valueSizeThreshold, int maxSegmentFileSize, int preAllocateSegmentCount, int keepInMemorySegmentCount, int checkpointIntervalMs, ThreadPoolExecutor writeExecutor)

Method Summary

Modifier and Type	Method and Description
static RocksDBSegmentLogStorage.Builder	builder(String uri, RaftOptions raftOptions) Creates a RocksDBSegmentLogStorage builder.
SegmentFile	getLastSegmentFileForRead()
protected RocksDBLogStorage.WriteContext	newWriteContext()
protected byte[]	onDataAppend(long logIndex, byte[] value, RocksDBLogStorage.WriteContext ctx) Called before appending data entry.
protected byte[]	onDataGet(long logIndex, byte[] value) Called after getting data from rocksdb.
protected boolean	onInitLoaded() Called after opening RocksDB and loading configuration into conf manager.
protected void	onReset(long nextLogIndex) Called after resetting db.
protected void	onShutdown() Called after closing db.
protected void	onSync() Called when sync data into file system.
protected void	onTruncatePrefix(long startIndex, long firstIndexKept) Called after truncating prefix logs in rocksdb.
protected void	onTruncateSuffix(long lastIndexKept) Called after truncating suffix logs in rocksdb.

Methods inherited from class com.alipay.sofa.jraft.storage.impl.RocksDBLogStorage

appendEntries, appendEntry, describe, getEntry, getFirstLogIndex, getKeyBytes, getLastLogIndex, getTerm, getValueFromRocksDB, init, isSync, reset, shutdown, truncatePrefix, truncateSuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

RocksDBSegmentLogStorage

public RocksDBSegmentLogStorage(String path,
                                RaftOptions raftOptions)

RocksDBSegmentLogStorage

public RocksDBSegmentLogStorage(String path,
                                RaftOptions raftOptions,
                                int valueSizeThreshold,
                                int maxSegmentFileSize)

RocksDBSegmentLogStorage

public RocksDBSegmentLogStorage(String path,
                                RaftOptions raftOptions,
                                int valueSizeThreshold,
                                int maxSegmentFileSize,
                                int preAllocateSegmentCount,
                                int keepInMemorySegmentCount,
                                int checkpointIntervalMs,
                                ThreadPoolExecutor writeExecutor)

Method Detail

builder

public static final RocksDBSegmentLogStorage.Builder builder(String uri,
                                                             RaftOptions raftOptions)

Creates a RocksDBSegmentLogStorage builder.

Returns:

a builder instance.

onSync

protected void onSync()
               throws IOException,
                      InterruptedException

Description copied from class: RocksDBLogStorage

Called when sync data into file system.

Overrides:

onSync in class RocksDBLogStorage

Throws:

IOException

InterruptedException

onInitLoaded

protected boolean onInitLoaded()

Description copied from class: RocksDBLogStorage

Called after opening RocksDB and loading configuration into conf manager.

Overrides:

onInitLoaded in class RocksDBLogStorage

onShutdown

protected void onShutdown()

Description copied from class: RocksDBLogStorage

Called after closing db.

Overrides:

onShutdown in class RocksDBLogStorage

getLastSegmentFileForRead

public SegmentFile getLastSegmentFileForRead()
                                      throws IOException,
                                             InterruptedException

Throws:

IOException

InterruptedException

onReset

protected void onReset(long nextLogIndex)

Description copied from class: RocksDBLogStorage

Called after resetting db.

Overrides:

onReset in class RocksDBLogStorage

Parameters:

nextLogIndex - next log index

onTruncatePrefix

protected void onTruncatePrefix(long startIndex,
                                long firstIndexKept)
                         throws org.rocksdb.RocksDBException,
                                IOException

Description copied from class: RocksDBLogStorage

Called after truncating prefix logs in rocksdb.

Overrides:

onTruncatePrefix in class RocksDBLogStorage

Parameters:

startIndex - the start index

firstIndexKept - the first index to kept

Throws:

org.rocksdb.RocksDBException

IOException

onTruncateSuffix

protected void onTruncateSuffix(long lastIndexKept)
                         throws org.rocksdb.RocksDBException,
                                IOException

Description copied from class: RocksDBLogStorage

Called after truncating suffix logs in rocksdb.

Overrides:

onTruncateSuffix in class RocksDBLogStorage

Parameters:

lastIndexKept - the last index to kept

Throws:

org.rocksdb.RocksDBException

IOException

newWriteContext

protected RocksDBLogStorage.WriteContext newWriteContext()

Overrides:

newWriteContext in class RocksDBLogStorage

onDataAppend

protected byte[] onDataAppend(long logIndex,
                              byte[] value,
                              RocksDBLogStorage.WriteContext ctx)
                       throws IOException,
                              InterruptedException

Description copied from class: RocksDBLogStorage

Called before appending data entry.

Overrides:

onDataAppend in class RocksDBLogStorage

Parameters:

logIndex - the log index

value - the data value in log entry.

Returns:

the new value

Throws:

IOException

InterruptedException

onDataGet

protected byte[] onDataGet(long logIndex,
                           byte[] value)
                    throws IOException

Description copied from class: RocksDBLogStorage

Called after getting data from rocksdb.

Overrides:

onDataGet in class RocksDBLogStorage

Parameters:

logIndex - the log index

value - the value in rocksdb

Returns:

the new value

Throws:

IOException