kvstore

README

kvstore

Key Value Store abstraction

Documentation

Index

• type Bucket
  • func (b *Bucket) Del(ctx context.Context, key string, value interface{}) (err error)
  • func (b *Bucket) Get(ctx context.Context, key string, value interface{}) (err error)
  • func (b *Bucket) Put(ctx context.Context, key string, value interface{}) (err error)
  • func (b *Bucket) PutProto(ctx context.Context, key string, value proto.Message) (err error)
• type IndexUpdate
• type Store
  • func NewStore(b backend.Backend) (store *Store)
  • func (s *Store) Bucket(name string) (bucket *Bucket, err error)

Types

type Bucket

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

Bucket a bucket

func (*Bucket) Del

func (b *Bucket) Del(ctx context.Context, key string, value interface{}) (err error)

Del deletes a value

func (*Bucket) Get

func (b *Bucket) Get(ctx context.Context, key string, value interface{}) (err error)

Get gets a value and unmarshals it

func (*Bucket) Put

func (b *Bucket) Put(ctx context.Context, key string, value interface{}) (err error)

Put marshals the value to json before storing

func (*Bucket) PutProto

func (b *Bucket) PutProto(ctx context.Context, key string, value proto.Message) (err error)

PutProto puts a protobuf message

type IndexUpdate

type IndexUpdate struct {
	B string // bucket
	K string // Key
	D bool   // Delete
}

IndexUpdate an update to an index

type Store

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

Store a store

func NewStore

func NewStore(b backend.Backend) (store *Store)

NewStore creates a new kvstore instance

func (*Store) Bucket

func (s *Store) Bucket(name string) (bucket *Bucket, err error)

Bucket creates or returns a bucket