com.alipay.sofa.jraft.storage.log

类 RocksDBSegmentLogStorage

java.lang.Object

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

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

所有已实现的接口:

Lifecycle<LogStorageOptions>, LogStorage, Storage, Describer

public class RocksDBSegmentLogStorage
extends RocksDBLogStorage

Log Storage implementation based on rocksdb and segment files.

作者:

boyan(boyan@antfin.com)

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	RocksDBSegmentLogStorage.BarrierWriteContext
static class	RocksDBSegmentLogStorage.Builder RocksDBSegmentLogStorage builder

从类继承的嵌套类/接口 com.alipay.sofa.jraft.storage.impl.RocksDBLogStorage

RocksDBLogStorage.EmptyWriteContext, RocksDBLogStorage.WriteContext

从接口继承的嵌套类/接口 com.alipay.sofa.jraft.util.Describer

Describer.DefaultPrinter, Describer.Printer

字段概要

从类继承的字段 com.alipay.sofa.jraft.storage.impl.RocksDBLogStorage

FIRST_LOG_IDX_KEY

构造器概要

构造器

构造器和说明
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)

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 com.alipay.sofa.jraft.storage.impl.RocksDBLogStorage

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

从类继承的方法 java.lang.Object

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

构造器详细资料

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)

方法详细资料

builder

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

Creates a RocksDBSegmentLogStorage builder.

返回:

a builder instance.

onSync

protected void onSync()
               throws IOException,
                      InterruptedException

从类复制的说明: RocksDBLogStorage

Called when sync data into file system.

覆盖:

onSync 在类中 RocksDBLogStorage

抛出:

IOException

InterruptedException

onInitLoaded

protected boolean onInitLoaded()

从类复制的说明: RocksDBLogStorage

Called after opening RocksDB and loading configuration into conf manager.

覆盖:

onInitLoaded 在类中 RocksDBLogStorage

onShutdown

protected void onShutdown()

从类复制的说明: RocksDBLogStorage

Called after closing db.

覆盖:

onShutdown 在类中 RocksDBLogStorage

getLastSegmentFileForRead

public SegmentFile getLastSegmentFileForRead()
                                      throws IOException,
                                             InterruptedException

抛出:

IOException

InterruptedException

onReset

protected void onReset(long nextLogIndex)

从类复制的说明: RocksDBLogStorage

Called after resetting db.

覆盖:

onReset 在类中 RocksDBLogStorage

参数:

nextLogIndex - next log index

onTruncatePrefix

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

从类复制的说明: RocksDBLogStorage

Called after truncating prefix logs in rocksdb.

覆盖:

onTruncatePrefix 在类中 RocksDBLogStorage

参数:

startIndex - the start index

firstIndexKept - the first index to kept

抛出:

org.rocksdb.RocksDBException

IOException

onTruncateSuffix

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

从类复制的说明: RocksDBLogStorage

Called after truncating suffix logs in rocksdb.

覆盖:

onTruncateSuffix 在类中 RocksDBLogStorage

参数:

lastIndexKept - the last index to kept

抛出:

org.rocksdb.RocksDBException

IOException

newWriteContext

protected RocksDBLogStorage.WriteContext newWriteContext()

覆盖:

newWriteContext 在类中 RocksDBLogStorage

onDataAppend

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

从类复制的说明: RocksDBLogStorage

Called before appending data entry.

覆盖:

onDataAppend 在类中 RocksDBLogStorage

参数:

logIndex - the log index

value - the data value in log entry.

返回:

the new value

抛出:

IOException

InterruptedException

onDataGet

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

从类复制的说明: RocksDBLogStorage

Called after getting data from rocksdb.

覆盖:

onDataGet 在类中 RocksDBLogStorage

参数:

logIndex - the log index

value - the value in rocksdb

返回:

the new value

抛出:

IOException