database

Documentation

Overview

Package database defines interfaces to key value type databases used by various components in go-spacemesh node

Index

• Variables
• type Database
• type Getter
• type LDBDatabase
  • func NewLDBDatabase(file string, cache int, handles int, logger log.Log) (*LDBDatabase, error)
  • func NewMemDatabase() *LDBDatabase
  • func (db *LDBDatabase) Close()
  • func (db *LDBDatabase) Delete(key []byte) error
  • func (db *LDBDatabase) Get(key []byte) ([]byte, error)
  • func (db *LDBDatabase) Has(key []byte) (bool, error)
  • func (db *LDBDatabase) Path() string
  • func (db *LDBDatabase) Put(key []byte, value []byte) error

Variables

var ErrNotFound = errors.ErrNotFound

ErrNotFound is special type error for not found in DB.

Types

type Database

type Database interface {
	Put([]byte, []byte) error
	Delete([]byte) error
	Get([]byte) ([]byte, error)
}

Database wraps all database operations. All methods are safe for concurrent use.

type Getter

type Getter interface {
	Get(key []byte) ([]byte, error)
}

Getter wraps the database read operation.

type LDBDatabase

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

LDBDatabase is a wrapper for leveldb database with concurrent access.

func NewLDBDatabase

func NewLDBDatabase(file string, cache int, handles int, logger log.Log) (*LDBDatabase, error)

NewLDBDatabase returns a LevelDB wrapped object.

func NewMemDatabase

func NewMemDatabase() *LDBDatabase

NewMemDatabase returns a memory database instance.

func (*LDBDatabase) Close

func (db *LDBDatabase) Close()

Close closes database, flushing writes and denying all new write requests.

func (*LDBDatabase) Delete

func (db *LDBDatabase) Delete(key []byte) error

Delete deletes the key from the queue and database.

func (*LDBDatabase) Get

func (db *LDBDatabase) Get(key []byte) ([]byte, error)

Get returns the given key if it's present.

func (*LDBDatabase) Has

func (db *LDBDatabase) Has(key []byte) (bool, error)

Has returns whether the db contains the key.

func (*LDBDatabase) Path

func (db *LDBDatabase) Path() string

Path returns the path to the database directory.

func (*LDBDatabase) Put

func (db *LDBDatabase) Put(key []byte, value []byte) error

Put puts the given key / value to the queue.