database

Documentation

Index

• Variables
• func CheckEngine(dbPath string, createDatabaseIfNotExists bool, dbEngine hivedb.Engine, ...) (hivedb.Engine, error)
• func NewRocksDB(path string) (*rocksdb.RocksDB, error)
• func StoreWithDefaultSettings(path string, createDatabaseIfNotExists bool, dbEngine hivedb.Engine, ...) (kvstore.KVStore, error)
• type Config
  • func (c Config) WithDirectory(directory string) Config
• type DBInstance
  • func NewDBInstance(dbConfig Config, openedCallback func(d *DBInstance)) *DBInstance
  • func (d *DBInstance) Close()
  • func (d *DBInstance) CloseWithoutLocking()
  • func (d *DBInstance) Flush()
  • func (d *DBInstance) KVStore() kvstore.KVStore
  • func (d *DBInstance) LockAccess()
  • func (d *DBInstance) Open() error
  • func (d *DBInstance) Shutdown()
  • func (d *DBInstance) UnlockAccess()

Variables

var (
	AllowedEnginesDefault = []hivedb.Engine{
		hivedb.EngineAuto,
		hivedb.EngineMapDB,
		hivedb.EngineRocksDB,
	}

	AllowedEnginesStorage = []hivedb.Engine{
		hivedb.EngineRocksDB,
	}

	AllowedEnginesStorageAuto = append(AllowedEnginesStorage, hivedb.EngineAuto)
)

var (
	ErrEpochPruned       = ierrors.New("epoch pruned")
	ErrNoPruningNeeded   = ierrors.New("no pruning needed")
	ErrDatabaseFull      = ierrors.New("database full")
	ErrDatabaseShutdown  = ierrors.New("cannot open DBInstance that is shutdown")
	ErrDatabaseNotClosed = ierrors.New("cannot open DBInstance that is not closed")
)

Functions

func CheckEngine

func CheckEngine(dbPath string, createDatabaseIfNotExists bool, dbEngine hivedb.Engine, allowedEngines ...hivedb.Engine) (hivedb.Engine, error)

CheckEngine is a wrapper around hivedb.CheckEngine to throw a custom error message in case of engine mismatch.

func NewRocksDB

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

NewRocksDB creates a new RocksDB instance.

func StoreWithDefaultSettings

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

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

Types

type Config

type Config struct {
	Engine       db.Engine
	Directory    string
	Version      byte
	PrefixHealth []byte
}

func (Config) WithDirectory

func (c Config) WithDirectory(directory string) Config

type DBInstance

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

func NewDBInstance

func NewDBInstance(dbConfig Config, openedCallback func(d *DBInstance)) *DBInstance

func (*DBInstance) Close

func (d *DBInstance) Close()

func (*DBInstance) CloseWithoutLocking

func (d *DBInstance) CloseWithoutLocking()

func (*DBInstance) Flush

func (d *DBInstance) Flush()

func (*DBInstance) KVStore

func (d *DBInstance) KVStore() kvstore.KVStore

func (*DBInstance) LockAccess

func (d *DBInstance) LockAccess()

func (*DBInstance) Open

func (d *DBInstance) Open() error

Open re-opens a closed DBInstance. It must only be called while holding a lock on DBInstance, otherwise it might cause a race condition and corruption of node's state.

func (*DBInstance) Shutdown

func (d *DBInstance) Shutdown()

func (*DBInstance) UnlockAccess

func (d *DBInstance) UnlockAccess()