devnulldb

Documentation

Index

• type Database
  • func New() *Database
  • func (db *Database) Close() error
  • func (db *Database) Compact(start []byte, limit []byte) error
  • func (db *Database) Delete(key []byte) error
  • func (db *Database) Drop()
  • func (db *Database) Get(key []byte) ([]byte, error)
  • func (db *Database) GetSnapshot() (kvdb.Snapshot, error)
  • func (db *Database) Has(key []byte) (bool, error)
  • func (db *Database) Len() int
  • func (db *Database) NewBatch() kvdb.Batch
  • func (db *Database) NewIterator(prefix []byte, start []byte) kvdb.Iterator
  • func (db *Database) Put(key []byte, value []byte) error
  • func (db *Database) Stat(property string) (string, error)
• type Snapshot
  • func (s *Snapshot) Release()

Types

type Database

type Database struct{}

Database is an always empty database.

func New

func New() *Database

New returns an always empty database.

func (*Database) Close

func (db *Database) Close() error

Close deallocates the internal map and ensures any consecutive data access op failes with an error.

func (*Database) Compact

func (db *Database) Compact(start []byte, limit []byte) error

Compact is not supported on a memory database.

func (*Database) Delete

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

Delete removes the key from the key-value store.

func (*Database) Drop

func (db *Database) Drop()

Drop whole database.

func (*Database) Get

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

Get retrieves the given key if it's present in the key-value store.

func (*Database) GetSnapshot

func (db *Database) GetSnapshot() (kvdb.Snapshot, error)

GetSnapshot returns a latest snapshot of the underlying DB. A snapshot is a frozen snapshot of a DB state at a particular point in time. The content of snapshot are guaranteed to be consistent.

The snapshot must be released after use, by calling Release method.

func (*Database) Has

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

Has retrieves if a key is present in the key-value store.

func (*Database) Len

func (db *Database) Len() int

Len returns the number of entries currently present in the memory database.

Note, this method is only used for testing (i.e. not public in general) and does not have explicit checks for closed-ness to allow simpler testing code.

func (*Database) NewBatch

func (db *Database) NewBatch() kvdb.Batch

NewBatch creates a write-only key-value store that buffers changes to its host database until a final write is called.

func (*Database) NewIterator

func (db *Database) NewIterator(prefix []byte, start []byte) kvdb.Iterator

NewIterator creates a binary-alphabetical iterator over a subset of database content with a particular key prefix, starting at a particular initial key (or after, if it does not exist).

func (*Database) Put

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

Put inserts the given value into the key-value store.

func (*Database) Stat

func (db *Database) Stat(property string) (string, error)

Stat returns a particular internal stat of the database.

type Snapshot

type Snapshot struct {
	*Database
}

Snapshot is a DB snapshot.

func (*Snapshot) Release

func (s *Snapshot) Release()