database

Documentation

Index

• Constants
• Variables
• func DatabaseCleanupCaller(handler interface{}, params ...interface{})
• func NewPebbleDB(directory string, reportCompactionRunning func(running bool), ...) (*pebbleDB.DB, error)
• func NewRocksDB(path string) (*rocksdb.RocksDB, error)
• func StoreWithDefaultSettings(path string, createDatabaseIfNotExists bool, dbEngine ...Engine) (kvstore.KVStore, error)
• type Database
  • func New(log *logger.Logger, kvStore kvstore.KVStore, events *Events, ...) *Database
  • func (db *Database) CleanupDatabases() error
  • func (db *Database) CompactionRunning() bool
  • func (db *Database) CompactionSupported() bool
  • func (db *Database) DatabaseSupportsCleanup() bool
  • func (db *Database) Events() *Events
  • func (db *Database) KVStore() kvstore.KVStore
  • func (db *Database) RunGarbageCollection()
• type DatabaseCleanup
  • func (c *DatabaseCleanup) MarshalJSON() ([]byte, error)
• type Engine
  • func CheckDatabaseEngine(dbPath string, createDatabaseIfNotExists bool, dbEngine ...Engine) (Engine, error)
  • func DatabaseEngine(engine string) (Engine, error)
  • func LoadDatabaseEngineFromFile(path string) (Engine, error)
• type Events

Constants

const (
	EngineUnknown = "unknown"
	EngineRocksDB = "rocksdb"
	EnginePebble  = "pebble"
)

Variables

var (
	// ErrNothingToCleanUp is returned when nothing is there to clean up in the database.
	ErrNothingToCleanUp = errors.New("Nothing to clean up in the databases")
)

Functions

func DatabaseCleanupCaller

func DatabaseCleanupCaller(handler interface{}, params ...interface{})

func NewPebbleDB

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

NewPebbleDB creates a new pebble DB instance.

func NewRocksDB

func NewRocksDB(path string) (*rocksdb.RocksDB, error)

NewRocksDB creates a new RocksDB instance.

func StoreWithDefaultSettings

func StoreWithDefaultSettings(path string, createDatabaseIfNotExists bool, dbEngine ...Engine) (kvstore.KVStore, error)

StoreWithDefaultSettings returns a kvstore with default settings. It also checks if the database engine is correct.

Types

type Database

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

Database holds the underlying KVStore and database specific functions.

func New

func New(log *logger.Logger, kvStore kvstore.KVStore, events *Events, compactionSupported bool, compactionRunningFunc func() bool) *Database

New creates a new Database instance.

func (*Database) CleanupDatabases

func (db *Database) CleanupDatabases() error

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) DatabaseSupportsCleanup

func (db *Database) DatabaseSupportsCleanup() bool

func (*Database) Events

func (db *Database) Events() *Events

Events returns the events of the database.

func (*Database) KVStore

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

KVStore returns the underlying KVStore.

func (*Database) RunGarbageCollection

func (db *Database) RunGarbageCollection()

type DatabaseCleanup

type DatabaseCleanup struct {
	Start time.Time
	End   time.Time
}

func (*DatabaseCleanup) MarshalJSON

func (c *DatabaseCleanup) MarshalJSON() ([]byte, error)

type Engine

type Engine string

func CheckDatabaseEngine

func CheckDatabaseEngine(dbPath string, createDatabaseIfNotExists bool, dbEngine ...Engine) (Engine, error)

CheckDatabaseEngine checks if the correct database engine is used. This function stores a so called "database info file" in the database folder or checks if an existing "database info file" contains the correct engine. Otherwise the files in the database folder are not compatible.

func DatabaseEngine

func DatabaseEngine(engine string) (Engine, error)

DatabaseEngine parses a string and returns an engine. Returns an error if the engine is unknown.

func LoadDatabaseEngineFromFile

func LoadDatabaseEngineFromFile(path string) (Engine, error)

LoadDatabaseEngineFromFile returns the engine from the "database info file".

type Events

type Events struct {
	DatabaseCleanup    *events.Event
	DatabaseCompaction *events.Event
}