db

Documentation

Index

• type BadgerDB
  • func NewBadgerDB(path string) (*BadgerDB, error)
  • func (db *BadgerDB) Close() error
  • func (db *BadgerDB) Del(key []byte) error
  • func (db *BadgerDB) Get(key []byte) ([]byte, error)
  • func (db *BadgerDB) Has(key []byte) (bool, error)
  • func (db *BadgerDB) NewBatch() Batch
  • func (db *BadgerDB) NewIterator() Iterator
  • func (db *BadgerDB) Path() string
  • func (db *BadgerDB) Put(key []byte, value []byte) error
• type BadgerIterator
  • func (i *BadgerIterator) Key() []byte
  • func (i *BadgerIterator) Next() bool
  • func (i *BadgerIterator) Release()
  • func (i *BadgerIterator) Released() bool
  • func (i *BadgerIterator) Seek(key []byte)
  • func (i *BadgerIterator) Value() []byte
• type Batch
  • func NewTableBatch(db Database, prefix string) Batch
• type Database
  • func NewTable(db Database, prefix string) Database
• type Iden3Storage
  • func NewIden3Storage(path string) (Iden3Storage, error)
  • func (s Iden3Storage) Close()
  • func (s Iden3Storage) Get(key []byte) ([]byte, error)
  • func (s Iden3Storage) Info() string
  • func (s Iden3Storage) Iterate(fn func([]byte, []byte) (bool, error)) error
  • func (s Iden3Storage) List(limit int) ([]iden3db.KV, error)
  • func (s Iden3Storage) NewTx() (iden3db.Tx, error)
  • func (s Iden3Storage) WithPrefix(prefix []byte) iden3db.Storage
• type Iden3Tx
  • func (t Iden3Tx) Add(tx iden3db.Tx)
  • func (t Iden3Tx) Close()
  • func (t Iden3Tx) Commit() error
  • func (t Iden3Tx) Get(key []byte) ([]byte, error)
  • func (t Iden3Tx) Put(key, value []byte)
• type Iterator
• type Reader
• type Writer

Types

type BadgerDB

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

BadgerDB implements chainsafe's database interface. The implementation is inspired by the original by chainsafe, but also different.

func NewBadgerDB

func NewBadgerDB(path string) (*BadgerDB, error)

func (*BadgerDB) Close

func (db *BadgerDB) Close() error

func (*BadgerDB) Del

func (db *BadgerDB) Del(key []byte) error

func (*BadgerDB) Get

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

func (*BadgerDB) Has

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

func (*BadgerDB) NewBatch

func (db *BadgerDB) NewBatch() Batch

func (*BadgerDB) NewIterator

func (db *BadgerDB) NewIterator() Iterator

func (*BadgerDB) Path

func (db *BadgerDB) Path() string

func (*BadgerDB) Put

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

type BadgerIterator

type BadgerIterator struct {
	Iter *badger.Iterator
	// contains filtered or unexported fields
}

func (*BadgerIterator) Key

func (i *BadgerIterator) Key() []byte

func (*BadgerIterator) Next

func (i *BadgerIterator) Next() bool

func (*BadgerIterator) Release

func (i *BadgerIterator) Release()

func (*BadgerIterator) Released

func (i *BadgerIterator) Released() bool

func (*BadgerIterator) Seek

func (i *BadgerIterator) Seek(key []byte)

func (*BadgerIterator) Value

func (i *BadgerIterator) Value() []byte

type Batch

type Batch interface {
	Writer

	ValueSize() int
	Write() error
	Reset()
}

Batch is a write-only operation.

func NewTableBatch

func NewTableBatch(db Database, prefix string) Batch

NewTableBatch returns a Batch object which prefixes all keys with a given string.

type Database

type Database interface {
	Reader
	Writer
	io.Closer

	NewBatch() Batch
	Path() string
	NewIterator() Iterator
}

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

func NewTable

func NewTable(db Database, prefix string) Database

NewTable returns a Database object that prefixes all keys with a given string.

type Iden3Storage

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

Iden3Storage is an overlay on top of BadgerDB to satisfy iden3's current interface.

func NewIden3Storage

func NewIden3Storage(path string) (Iden3Storage, error)

func (Iden3Storage) Close

func (s Iden3Storage) Close()

func (Iden3Storage) Get

func (s Iden3Storage) Get(key []byte) ([]byte, error)

func (Iden3Storage) Info

func (s Iden3Storage) Info() string

func (Iden3Storage) Iterate

func (s Iden3Storage) Iterate(fn func([]byte, []byte) (bool, error)) error

func (Iden3Storage) List

func (s Iden3Storage) List(limit int) ([]iden3db.KV, error)

func (Iden3Storage) NewTx

func (s Iden3Storage) NewTx() (iden3db.Tx, error)

func (Iden3Storage) WithPrefix

func (s Iden3Storage) WithPrefix(prefix []byte) iden3db.Storage

type Iden3Tx

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

func (Iden3Tx) Add

func (t Iden3Tx) Add(tx iden3db.Tx)

func (Iden3Tx) Close

func (t Iden3Tx) Close()

func (Iden3Tx) Commit

func (t Iden3Tx) Commit() error

func (Iden3Tx) Get

func (t Iden3Tx) Get(key []byte) ([]byte, error)

func (Iden3Tx) Put

func (t Iden3Tx) Put(key, value []byte)

type Iterator

type Iterator interface {
	Next() bool
	Key() []byte
	Value() []byte
	Release()
}

Iterator iterates over key/value pairs in ascending key order. Must be released after use.

type Reader

type Reader interface {
	Get(key []byte) ([]byte, error)
	Has(key []byte) (bool, error)
}

Reader interface

type Writer

type Writer interface {
	Put(key []byte, value []byte) error
	Del(key []byte) error
}

Writer interface