db

Documentation

Index

• Constants
• Variables
• type KVStore
  • func NewBoltDB(path string, options *bolt.Options) KVStore
  • func NewMemKVStore() KVStore
• type KVStoreBatch
  • func NewBaseKVStoreBatch() KVStoreBatch
  • func NewBoltDBBatch(bdb *boltDB) KVStoreBatch
  • func NewMemKVStoreBatch(data *sync.Map, bucket *map[string]struct{}) KVStoreBatch

Constants

const (
	// Put indicate the type of write operation to be Put
	Put int32 = iota
	// Delete indicate the type of write operation to be Delete
	Delete int32 = 1
	// PutIfNotExists indicate the type of write operation to be PutIfNotExists
	PutIfNotExists int32 = 2
)

Variables

var (
	// ErrInvalidDB indicates invalid operation attempted to Blockchain database
	ErrInvalidDB = errors.New("invalid DB operation")
	// ErrNotExist indicates certain item does not exist in Blockchain database
	ErrNotExist = errors.New("not exist in DB")
	// ErrAlreadyExist indicates certain item already exists in Blockchain database
	ErrAlreadyExist = errors.New("already exist in DB")
)

Types

type KVStore

type KVStore interface {
	lifecycle.StartStopper

	// Put insert or update a record identified by (namespace, key)
	Put(string, []byte, []byte) error
	// Put puts a record only if (namespace, key) doesn't exist, otherwise return ErrAlreadyExist
	PutIfNotExists(string, []byte, []byte) error
	// Get gets a record by (namespace, key)
	Get(string, []byte) ([]byte, error)
	// Delete deletes a record by (namespace, key)
	Delete(string, []byte) error
	// Batch return a kv store batch api object
	Batch() KVStoreBatch
}

KVStore is the interface of KV store.

func NewBoltDB

func NewBoltDB(path string, options *bolt.Options) KVStore

NewBoltDB instantiates a boltdb based KV store

func NewMemKVStore

func NewMemKVStore() KVStore

NewMemKVStore instantiates an in-memory KV store

type KVStoreBatch

type KVStoreBatch interface {
	// Put insert or update a record identified by (namespace, key)
	Put(string, []byte, []byte, string, ...interface{}) error
	// PutIfNotExists puts a record only if (namespace, key) doesn't exist, otherwise return ErrAlreadyExist
	PutIfNotExists(string, []byte, []byte, string, ...interface{}) error
	// Delete deletes a record by (namespace, key)
	Delete(string, []byte, string, ...interface{}) error
	// Clear clear batch write queue
	Clear() error
	// Commit commit queued write to db
	Commit() error
}

KVStoreBatch is the interface of KV store.

func NewBaseKVStoreBatch

func NewBaseKVStoreBatch() KVStoreBatch

NewBaseKVStoreBatch instantiates an in-memory KV store

func NewBoltDBBatch

func NewBoltDBBatch(bdb *boltDB) KVStoreBatch

NewBoltDBBatch instantiates a boltdb based KV store

func NewMemKVStoreBatch

func NewMemKVStoreBatch(data *sync.Map, bucket *map[string]struct{}) KVStoreBatch

NewMemKVStoreBatch instantiates an in-memory KV store