RocksDBLogStorage (jraft-core 1.3.14 1.3.14 API)

java.lang.Object
- com.alipay.sofa.jraft.storage.impl.RocksDBLogStorage

All Implemented Interfaces:

Lifecycle<LogStorageOptions>, LogStorage, Storage, Describer

Direct Known Subclasses:

RocksDBSegmentLogStorage
```
public class RocksDBLogStorage
extends Object
implements LogStorage, Describer
```
Log storage based on rocksdb.

Author:

boyan (boyan@alibaba-inc.com) 2018-Apr-06 7:27:47 AM

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`RocksDBLogStorage.EmptyWriteContext` An empty write context
`static interface`	`RocksDBLogStorage.WriteContext` A write context

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

Field Summary

Fields
Modifier and Type	Field and Description
`static byte[]`	`FIRST_LOG_IDX_KEY` First log index and last log index key in configuration column family.
`static String`	`PART_ROCKSDB_OPTIONS_KEY`

Constructor Summary

Constructors
Constructor and Description

RocksDBLogStorage(String path, RaftOptions raftOptions)

Constructors
Constructor and Description
`RocksDBLogStorage(String path, RaftOptions raftOptions)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`appendEntries(List<LogEntry> entries)` Append entries to log, return append success number.
`boolean`	`appendEntry(LogEntry entry)` Append entries to log.
`void`	`describe(Describer.Printer out)`
`LogEntry`	`getEntry(long index)` Get logEntry by index.
`long`	`getFirstLogIndex()` Returns first log index in log.
`protected byte[]`	`getKeyBytes(long index)`
`long`	`getLastLogIndex()` Returns last log index in log.
`long`	`getTerm(long index)` Get logEntry's term by index.
`protected byte[]`	`getValueFromRocksDB(byte[] keyBytes)`
`boolean`	`init(LogStorageOptions opts)` Initialize the service.
`protected boolean`	`isSync()`
`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.
`boolean`	`reset(long nextLogIndex)` Drop all the existing logs and reset next log index to \|next_log_index\|.
`void`	`shutdown()` Dispose the resources for service.
`boolean`	`truncatePrefix(long firstIndexKept)` Delete logs from storage's head, [first_log_index, first_index_kept) will be discarded.
`boolean`	`truncateSuffix(long lastIndexKept)` Delete uncommitted logs from storage's tail, (last_index_kept, last_log_index] will be discarded.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PART_ROCKSDB_OPTIONS_KEY
```
public static final String PART_ROCKSDB_OPTIONS_KEY
```
    See Also:
    
    Constant Field Values
  - FIRST_LOG_IDX_KEY
```
public static final byte[] FIRST_LOG_IDX_KEY
```
    First log index and last log index key in configuration column family.
- Constructor Detail
  - RocksDBLogStorage
```
public RocksDBLogStorage(String path,
                         RaftOptions raftOptions)
```
- Method Detail
  - init
```
public boolean init(LogStorageOptions opts)
```
    Description copied from interface: Lifecycle
    
    Initialize the service.
    
    Specified by:
    
    init in interface Lifecycle<LogStorageOptions>
    
    Returns:
    
    true when successes.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: Lifecycle
    
    Dispose the resources for service.
    
    Specified by:
    
    shutdown in interface Lifecycle<LogStorageOptions>
  - getFirstLogIndex
```
public long getFirstLogIndex()
```
    Description copied from interface: LogStorage
    
    Returns first log index in log.
    
    Specified by:
    
    getFirstLogIndex in interface LogStorage
  - getLastLogIndex
```
public long getLastLogIndex()
```
    Description copied from interface: LogStorage
    
    Returns last log index in log.
    
    Specified by:
    
    getLastLogIndex in interface LogStorage
  - getEntry
```
public LogEntry getEntry(long index)
```
    Description copied from interface: LogStorage
    
    Get logEntry by index.
    
    Specified by:
    
    getEntry in interface LogStorage
  - getValueFromRocksDB
```
protected byte[] getValueFromRocksDB(byte[] keyBytes)
                              throws org.rocksdb.RocksDBException
```
    Throws:
    
    org.rocksdb.RocksDBException
  - getKeyBytes
```
protected byte[] getKeyBytes(long index)
```
  - getTerm
```
public long getTerm(long index)
```
    Description copied from interface: LogStorage
    
    Get logEntry's term by index. This method is deprecated, you should use LogStorage.getEntry(long) to get the log id's term.
    
    Specified by:
    
    getTerm in interface LogStorage
  - appendEntry
```
public boolean appendEntry(LogEntry entry)
```
    Description copied from interface: LogStorage
    
    Append entries to log.
    
    Specified by:
    
    appendEntry in interface LogStorage
  - appendEntries
```
public int appendEntries(List<LogEntry> entries)
```
    Description copied from interface: LogStorage
    
    Append entries to log, return append success number.
    
    Specified by:
    
    appendEntries in interface LogStorage
  - truncatePrefix
```
public boolean truncatePrefix(long firstIndexKept)
```
    Description copied from interface: LogStorage
    
    Delete logs from storage's head, [first_log_index, first_index_kept) will be discarded.
    
    Specified by:
    
    truncatePrefix in interface LogStorage
  - truncateSuffix
```
public boolean truncateSuffix(long lastIndexKept)
```
    Description copied from interface: LogStorage
    
    Delete uncommitted logs from storage's tail, (last_index_kept, last_log_index] will be discarded.
    
    Specified by:
    
    truncateSuffix in interface LogStorage
  - reset
```
public boolean reset(long nextLogIndex)
```
    Description copied from interface: LogStorage
    
    Drop all the existing logs and reset next log index to |next_log_index|. This function is called after installing snapshot from leader.
    
    Specified by:
    
    reset in interface LogStorage
  - onInitLoaded
```
protected boolean onInitLoaded()
```
    Called after opening RocksDB and loading configuration into conf manager.
  - onShutdown
```
protected void onShutdown()
```
    Called after closing db.
  - onReset
```
protected void onReset(long nextLogIndex)
```
    Called after resetting db.
    
    Parameters:
    
    nextLogIndex - next log index
  - onTruncatePrefix
```
protected void onTruncatePrefix(long startIndex,
                                long firstIndexKept)
                         throws org.rocksdb.RocksDBException,
                                IOException
```
    Called after truncating prefix logs in rocksdb.
    
    Parameters:
    
    startIndex - the start index
    
    firstIndexKept - the first index to kept
    
    Throws:
    
    org.rocksdb.RocksDBException
    
    IOException
  - onSync
```
protected void onSync()
               throws IOException,
                      InterruptedException
```
    Called when sync data into file system.
    
    Throws:
    
    IOException
    
    InterruptedException
  - isSync
```
protected boolean isSync()
```
  - onTruncateSuffix
```
protected void onTruncateSuffix(long lastIndexKept)
                         throws org.rocksdb.RocksDBException,
                                IOException
```
    Called after truncating suffix logs in rocksdb.
    
    Parameters:
    
    lastIndexKept - the last index to kept
    
    Throws:
    
    org.rocksdb.RocksDBException
    
    IOException
  - newWriteContext
```
protected RocksDBLogStorage.WriteContext newWriteContext()
```
  - onDataAppend
```
protected byte[] onDataAppend(long logIndex,
                              byte[] value,
                              RocksDBLogStorage.WriteContext ctx)
                       throws IOException,
                              InterruptedException
```
    Called before appending data entry.
    
    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
```
    Called after getting data from rocksdb.
    
    Parameters:
    
    logIndex - the log index
    
    value - the value in rocksdb
    
    Returns:
    
    the new value
    
    Throws:
    
    IOException
  - describe
```
public void describe(Describer.Printer out)
```
    Specified by:
    
    describe in interface Describer

Class RocksDBLogStorage

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PART_ROCKSDB_OPTIONS_KEY

FIRST_LOG_IDX_KEY

Constructor Detail

RocksDBLogStorage

Method Detail

init

shutdown

getFirstLogIndex

getLastLogIndex

getEntry

getValueFromRocksDB

getKeyBytes

getTerm

appendEntry

appendEntries

truncatePrefix

truncateSuffix

reset

onInitLoaded

onShutdown

onReset

onTruncatePrefix

onSync

isSync

onTruncateSuffix

newWriteContext

onDataAppend

onDataGet

describe