storage

Documentation

Index

• Variables
• type Beginner
• type DebugBatch
  • func (b *DebugBatch) Begin(writable bool) KeyValueTxn
  • func (b *DebugBatch) BeginWithPrefix(writable bool, prefix string) KeyValueTxn
  • func (b *DebugBatch) Commit() error
  • func (b *DebugBatch) Discard()
  • func (b *DebugBatch) Get(key Key) (v []byte, err error)
  • func (b *DebugBatch) PretendWrite()
  • func (b *DebugBatch) Put(key Key, value []byte) error
  • func (b *DebugBatch) PutAll(values map[Key][]byte) error
• type KeyValueStore
• type KeyValueTxn
• type Logger

Variables

var ErrNotOpen = errors.InternalError.With("not open")

ErrNotOpen is returned by KeyValueDB.Get, .Put, and .Close if the database is not open.

Types

type Beginner

type Beginner interface {
	// Begin begins a transaction or sub-transaction.
	Begin(writable bool) KeyValueTxn

	// Begin begins a transaction or sub-transaction with the given prefix
	// applied to keys.
	BeginWithPrefix(writable bool, prefix string) KeyValueTxn
}

type DebugBatch

type DebugBatch struct {
	Batch  KeyValueTxn
	Logger Logger

	Writable bool
	// contains filtered or unexported fields
}

func (*DebugBatch) Begin

func (b *DebugBatch) Begin(writable bool) KeyValueTxn

func (*DebugBatch) BeginWithPrefix

func (b *DebugBatch) BeginWithPrefix(writable bool, prefix string) KeyValueTxn

func (*DebugBatch) Commit

func (b *DebugBatch) Commit() error

func (*DebugBatch) Discard

func (b *DebugBatch) Discard()

func (*DebugBatch) Get

func (b *DebugBatch) Get(key Key) (v []byte, err error)

func (*DebugBatch) PretendWrite

func (b *DebugBatch) PretendWrite()

func (*DebugBatch) Put

func (b *DebugBatch) Put(key Key, value []byte) error

func (*DebugBatch) PutAll

func (b *DebugBatch) PutAll(values map[Key][]byte) error

type KeyValueStore

type KeyValueStore interface {
	Beginner

	// Close closes the store.
	Close() error
}

type KeyValueTxn

type KeyValueTxn interface {
	Beginner

	// Get gets a value.
	Get(key Key) ([]byte, error)
	// Put puts a value.
	Put(key Key, value []byte) error
	// PutAll puts many values.
	PutAll(map[Key][]byte) error
	// Commit commits the transaction.
	Commit() error
	// Discard discards the transaction.
	Discard()
}

type Logger

type Logger interface {
	Debug(msg string, keyVals ...interface{})
	Info(msg string, keyVals ...interface{})
	Error(msg string, keyVals ...interface{})
}

Logger defines a generic logging interface compatible with Tendermint (stolen from Tendermint).