db

Documentation

Index

• type BadgerStore
  • func (s *BadgerStore) Close() error
  • func (s *BadgerStore) Erase() error
  • func (s *BadgerStore) NewTransaction(update bool) *BadgerStoreTxn
  • func (s *BadgerStore) NewWriteBatch() *BadgerStoreBatch
  • func (s *BadgerStore) Purge() error
  • func (s *BadgerStore) Size() (int64, int64)
  • func (s *BadgerStore) UpdateInBatch(fn func(batch StoreBatch) error) error
  • func (s *BadgerStore) UpdateInTx(fn func(txn StoreTxn) error) error
  • func (s *BadgerStore) ViewInTx(fn func(txn StoreTxn) error) error
• type BadgerStoreBatch
  • func (b *BadgerStoreBatch) Cancel()
  • func (b *BadgerStoreBatch) Delete(key []byte) error
  • func (b *BadgerStoreBatch) Flush() error
  • func (b *BadgerStoreBatch) Set(key, val []byte) error
  • func (b *BadgerStoreBatch) SetWithMeta(key, val []byte, meta byte) error
• type BadgerStoreTxn
  • func (t *BadgerStoreTxn) Commit() error
  • func (t *BadgerStoreTxn) Count(prefix []byte) (uint64, error)
  • func (t *BadgerStoreTxn) Delete(key []byte) error
  • func (t *BadgerStoreTxn) Discard()
  • func (t *BadgerStoreTxn) Drop(prefix []byte) error
  • func (t *BadgerStoreTxn) DropOfTxn(prefix []byte) error
  • func (t *BadgerStoreTxn) Get(key []byte, fn func([]byte, byte) error) error
  • func (t *BadgerStoreTxn) Iterator(pre byte, fn func([]byte, []byte, byte) error) error
  • func (t *BadgerStoreTxn) PrefixIterator(prefix []byte, fn func([]byte, []byte, byte) error) error
  • func (t *BadgerStoreTxn) RangeIterator(startKey []byte, endKey []byte, fn func([]byte, []byte, byte) error) error
  • func (t *BadgerStoreTxn) Set(key []byte, val []byte) error
  • func (t *BadgerStoreTxn) SetWithMeta(key, val []byte, meta byte) error
  • func (t *BadgerStoreTxn) Stream(prefix []byte, filter func(item *badger.Item) bool, ...) error
  • func (t *BadgerStoreTxn) Upgrade(migrations []Migration) error
• type Migration
• type Migrations
  • func (m Migrations) Len() int
  • func (m Migrations) Less(i, j int) bool
  • func (m Migrations) Swap(i, j int)
• type Store
  • func NewBadgerStore(dir string) (Store, error)
• type StoreBatch
• type StoreTxn

Types

type BadgerStore

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

BadgerStore represents a block lattice store backed by a badger database.

func (*BadgerStore) Close

func (s *BadgerStore) Close() error

Close closes the database

func (*BadgerStore) Erase

func (s *BadgerStore) Erase() error

func (*BadgerStore) NewTransaction

func (s *BadgerStore) NewTransaction(update bool) *BadgerStoreTxn

func (*BadgerStore) NewWriteBatch

func (s *BadgerStore) NewWriteBatch() *BadgerStoreBatch

func (*BadgerStore) Purge

func (s *BadgerStore) Purge() error

Purge purges any old/deleted keys from the database.

func (*BadgerStore) Size

func (s *BadgerStore) Size() (int64, int64)

Close closes the database

func (*BadgerStore) UpdateInBatch

func (s *BadgerStore) UpdateInBatch(fn func(batch StoreBatch) error) error

func (*BadgerStore) UpdateInTx

func (s *BadgerStore) UpdateInTx(fn func(txn StoreTxn) error) error

func (*BadgerStore) ViewInTx

func (s *BadgerStore) ViewInTx(fn func(txn StoreTxn) error) error

type BadgerStoreBatch

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

func (*BadgerStoreBatch) Cancel

func (b *BadgerStoreBatch) Cancel()

func (*BadgerStoreBatch) Delete

func (b *BadgerStoreBatch) Delete(key []byte) error

func (*BadgerStoreBatch) Flush

func (b *BadgerStoreBatch) Flush() error

func (*BadgerStoreBatch) Set

func (b *BadgerStoreBatch) Set(key, val []byte) error

func (*BadgerStoreBatch) SetWithMeta

func (b *BadgerStoreBatch) SetWithMeta(key, val []byte, meta byte) error

type BadgerStoreTxn

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

func (*BadgerStoreTxn) Commit

func (t *BadgerStoreTxn) Commit() error

func (*BadgerStoreTxn) Count

func (t *BadgerStoreTxn) Count(prefix []byte) (uint64, error)

func (*BadgerStoreTxn) Delete

func (t *BadgerStoreTxn) Delete(key []byte) error

func (*BadgerStoreTxn) Discard

func (t *BadgerStoreTxn) Discard()

func (*BadgerStoreTxn) Drop

func (t *BadgerStoreTxn) Drop(prefix []byte) error

func (*BadgerStoreTxn) DropOfTxn

func (t *BadgerStoreTxn) DropOfTxn(prefix []byte) error

func (*BadgerStoreTxn) Get

func (t *BadgerStoreTxn) Get(key []byte, fn func([]byte, byte) error) error

func (*BadgerStoreTxn) Iterator

func (t *BadgerStoreTxn) Iterator(pre byte, fn func([]byte, []byte, byte) error) error

func (*BadgerStoreTxn) PrefixIterator

func (t *BadgerStoreTxn) PrefixIterator(prefix []byte, fn func([]byte, []byte, byte) error) error

func (*BadgerStoreTxn) RangeIterator

func (t *BadgerStoreTxn) RangeIterator(startKey []byte, endKey []byte, fn func([]byte, []byte, byte) error) error

RangeIterator scan keys between [startKey, endKey)

func (*BadgerStoreTxn) Set

func (t *BadgerStoreTxn) Set(key []byte, val []byte) error

func (*BadgerStoreTxn) SetWithMeta

func (t *BadgerStoreTxn) SetWithMeta(key, val []byte, meta byte) error

func (*BadgerStoreTxn) Stream

func (t *BadgerStoreTxn) Stream(prefix []byte, filter func(item *badger.Item) bool, callback func(list *pb.KVList) error) error

func (*BadgerStoreTxn) Upgrade

func (t *BadgerStoreTxn) Upgrade(migrations []Migration) error

type Migration

type Migration interface {
	Migrate(txn StoreTxn) error
	StartVersion() int
	EndVersion() int
}

type Migrations

type Migrations []Migration

func (Migrations) Len

func (m Migrations) Len() int

func (Migrations) Less

func (m Migrations) Less(i, j int) bool

func (Migrations) Swap

func (m Migrations) Swap(i, j int)

type Store

type Store interface {
	io.Closer
	Purge() error
	Erase() error
	ViewInTx(fn func(txn StoreTxn) error) error
	UpdateInTx(fn func(txn StoreTxn) error) error
	NewTransaction(update bool) *BadgerStoreTxn
	NewWriteBatch() *BadgerStoreBatch
	UpdateInBatch(fn func(batch StoreBatch) error) error
	Size() (int64, int64)
}

Store is an interface that all stores need to implement.

func NewBadgerStore

func NewBadgerStore(dir string) (Store, error)

NewBadgerStore initializes/opens a badger database in the given directory.

type StoreBatch

type StoreBatch interface {
	Set(key, val []byte) error
	SetWithMeta(key, val []byte, meta byte) error
	Delete(key []byte) error
	Cancel()
	Flush() error
}

type StoreTxn

type StoreTxn interface {
	Set(key, val []byte) error
	SetWithMeta(key, val []byte, meta byte) error
	Get(key []byte, fn func([]byte, byte) error) error
	Delete(key []byte) error
	Iterator(pre byte, fn func([]byte, []byte, byte) error) error
	PrefixIterator(prefix []byte, fn func([]byte, []byte, byte) error) error
	RangeIterator(startKey []byte, endKey []byte, fn func([]byte, []byte, byte) error) error
	Commit() error
	Discard()
	Drop(prefix []byte) error
	DropOfTxn(prefix []byte) error
	Upgrade(migrations []Migration) error
	Count(prefix []byte) (uint64, error)
	Stream(prefix []byte, filter func(item *badger.Item) bool, callback func(list *pb.KVList) error) error
}