database

Documentation

Index

• Constants
• type DB
  • func NewDB(dirname string) (DB, error)
  • func NewMemDB() (DB, error)

Constants

const (
	// PrefixAutoPeering defines the prefix of the autopeering db.
	PrefixAutoPeering byte = iota
	// PrefixHealth defines the prefix of the health db.
	PrefixHealth
	// PrefixMessageLayer defines the storage prefix for the message layer.
	PrefixMessageLayer
	// PrefixValueTransfers defines the storage prefix for value transfer.
	PrefixValueTransfers
)

Types

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.