database

Documentation

Index

• func NewBoltDB(directory string, filename string) *bbolt.DB
• func NewPebbleDB(directory string, reportCompactionRunning func(running bool), ...) *pebbleDB.DB
• func NewRocksDB(path string) *rocksdb.RocksDB
• type Database
  • func New(kvStore kvstore.KVStore, compactionSupported bool, ...) *Database
  • func (db *Database) CompactionRunning() bool
  • func (db *Database) CompactionSupported() bool
  • func (db *Database) KVStore() kvstore.KVStore

Functions

func NewBoltDB

func NewBoltDB(directory string, filename string) *bbolt.DB

NewBoltDB creates a new bbolt DB instance.

func NewPebbleDB

func NewPebbleDB(directory string, reportCompactionRunning func(running bool), enableFilter bool) *pebbleDB.DB

NewPebbleDB creates a new pebble DB instance.

func NewRocksDB

func NewRocksDB(path string) *rocksdb.RocksDB

NewRocksDB creates a new RocksDB instance.

Types

type Database

type Database struct {
	// contains filtered or unexported fields
}

Database holds the underlying KVStore and database specific functions.

func New

func New(kvStore kvstore.KVStore, compactionSupported bool, compactionRunningFunc func() bool) *Database

New creates a new Database instance.

func (*Database) CompactionRunning

func (db *Database) CompactionRunning() bool

CompactionRunning returns whether a compaction is running.

func (*Database) CompactionSupported

func (db *Database) CompactionSupported() bool

CompactionSupported returns whether the database engine supports compaction.

func (*Database) KVStore

func (db *Database) KVStore() kvstore.KVStore

KVStore returns the underlying KVStore.