dbmanager

Documentation

Index

• type ChainKVStoreProvider
• type DB
  • func NewDB(dirname string) (DB, error)
  • func NewMemDB() (DB, error)
• type DBManager
  • func NewDBManager(log *logger.Logger, inMemory bool, databaseDir string, ...) *DBManager
  • func (m *DBManager) Close()
  • func (m *DBManager) GetKVStore(chainID *isc.ChainID) kvstore.KVStore
  • func (m *DBManager) GetOrCreateKVStore(chainID *isc.ChainID) kvstore.KVStore
  • func (m *DBManager) GetRegistryKVStore() kvstore.KVStore
  • func (m *DBManager) RunGC(_ context.Context)

Types

type ChainKVStoreProvider

type ChainKVStoreProvider func(chainID *isc.ChainID) kvstore.KVStore

type DB

type DB interface {
	// NewStore creates a new KVStore backed by the database.
	NewStore() kvstore.KVStore
	// Close closes a DB.
	Close() error

	// RequiresGC returns whether the database requires a call of GC() to clean deleted items.
	RequiresGC() bool
	// GC runs the garbage collection to clean deleted database items.
	GC() error
}

DB represents a database abstraction.

func NewDB

func NewDB(dirname string) (DB, error)

NewDB returns a new persisting DB object.

func NewMemDB

func NewMemDB() (DB, error)

NewMemDB returns a new in-memory (not persisted) DB object.

type DBManager

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

func NewDBManager

func NewDBManager(log *logger.Logger, inMemory bool, databaseDir string, registryConfig *registry.Config) *DBManager

func (*DBManager) Close

func (m *DBManager) Close()

func (*DBManager) GetKVStore

func (m *DBManager) GetKVStore(chainID *isc.ChainID) kvstore.KVStore

func (*DBManager) GetOrCreateKVStore

func (m *DBManager) GetOrCreateKVStore(chainID *isc.ChainID) kvstore.KVStore

func (*DBManager) GetRegistryKVStore

func (m *DBManager) GetRegistryKVStore() kvstore.KVStore

func (*DBManager) RunGC

func (m *DBManager) RunGC(_ context.Context)