rocksdb

Documentation

Overview

Package rocksdb provides factory functions for creating RocksDB based Log DB.

Index

• func NewBatchedLogDB(cfg config.NodeHostConfig, cb config.LogDBCallback, dirs []string, ...) (raftio.ILogDB, error)
• func NewLogDB(cfg config.NodeHostConfig, cb config.LogDBCallback, dirs []string, ...) (raftio.ILogDB, error)
• type Factory
  • func (rf *Factory) Create(cfg config.NodeHostConfig, cb config.LogDBCallback, dirs []string, ...) (raftio.ILogDB, error)
  • func (rf *Factory) Name() string

Functions

func NewBatchedLogDB

func NewBatchedLogDB(cfg config.NodeHostConfig, cb config.LogDBCallback,
	dirs []string, lldirs []string) (raftio.ILogDB, error)

NewBatchedLogDB is the factory function for creating RocksDB based Log DB instances. Raft entries are batched before they get stored into RocksDB, it uses more memory than the default RocksDB based Log DB and provides better throughput performance.

Deprecated: NewBatchedLogDB has been deprecated, use NewLogDB instead.

func NewLogDB

func NewLogDB(cfg config.NodeHostConfig, cb config.LogDBCallback,
	dirs []string, lldirs []string) (raftio.ILogDB, error)

NewLogDB is the factory function for creating RocksDB based Log DB instances. Raft entries are stored in its plain format, it uses less memory than the batched alternative implementation but comes at the cost of lower throughput.

Types

type Factory

type Factory struct{}

Factory is the factory type for creating RocksDB based LogDB.

func (*Factory) Create

func (rf *Factory) Create(cfg config.NodeHostConfig,
	cb config.LogDBCallback,
	dirs []string, lldirs []string) (raftio.ILogDB, error)

Create creates RocksDB based LogDB.

func (*Factory) Name

func (rf *Factory) Name() string

Name returns the name of the LogDB instance.