gostore

README

gostore

gostore is a simple key-value store written in Go. but it provides a layer of fast access read interface.

Documentation

Index

• Variables
• type Option
  • func WithMaxCacheSize(maxCacheSize int) Option
  • func WithNumRetries(n uint8) Option
  • func WithReadOnly() Option
• type Store
  • func Open(DbPath string, opts ...Option) (*Store, error)
  • func (s *Store) Close() error
  • func (s *Store) Delete(namespace string, key []byte) error
  • func (s *Store) DeleteNamespace(namespace string) error
  • func (s *Store) Get(namespace, key []byte) ([]byte, error)
  • func (s *Store) Load(key string, obj any) error
  • func (s *Store) Memoize(key string, obj any, f func() (any, error)) error
  • func (s *Store) MemoizeWithTTL(key string, obj any, f func() (any, error), ttl int64) error
  • func (s *Store) Put(namespace string, key, value []byte) (err error)
  • func (s *Store) PutWithTTL(namespace, key, value []byte, ttl int64) (err error)
  • func (s *Store) Remove(key string) error
  • func (s *Store) Update(key string, value any) error
  • func (s *Store) UpdateWithTTL(key string, value any, ttl int64) error

Variables

var (
	// ErrKeyNotFound is returned when the key supplied to a Get or Delete
	// method does not exist in the database.
	ErrKeyNotFound = errors.New("key not found")

	// ErrKeyExpired is returned when the key supplied to a Get or Delete
	ErrKeyExpired = errors.New("key expired")

	// ErrBadValue is returned when the value supplied to the Put method
	// is nil.
	ErrBadValue = errors.New("bad value")
)

Types

type Option

type Option func(*option) error

Option the tracer provider option

func WithMaxCacheSize

func WithMaxCacheSize(maxCacheSize int) Option

WithMaxCacheSize sets the maximum number of items in the LRU cache.

func WithNumRetries

func WithNumRetries(n uint8) Option

WithNumRetries defines service name

func WithReadOnly

func WithReadOnly() Option

WithReadOnly set the store to read-only mode

type Store

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

Store is KVStore implementation based bolt DB

func Open

func Open(DbPath string, opts ...Option) (*Store, error)

Open opens a store with the given config

func (*Store) Close

func (s *Store) Close() error

Close closes the store

func (*Store) Delete

func (s *Store) Delete(namespace string, key []byte) error

Delete deletes a record by key

func (*Store) DeleteNamespace

func (s *Store) DeleteNamespace(namespace string) error

DeleteNamespace deletes a namespace

func (*Store) Get

func (s *Store) Get(namespace, key []byte) ([]byte, error)

Get fetches a value by key

func (*Store) Load

func (s *Store) Load(key string, obj any) error

Load read value by key

func (*Store) Memoize

func (s *Store) Memoize(key string, obj any, f func() (any, error)) error

Memoize memoize a function

func (*Store) MemoizeWithTTL

func (s *Store) MemoizeWithTTL(key string, obj any, f func() (any, error), ttl int64) error

func (*Store) Put

func (s *Store) Put(namespace string, key, value []byte) (err error)

Put inserts a <key, value> record

func (*Store) PutWithTTL

func (s *Store) PutWithTTL(namespace, key, value []byte, ttl int64) (err error)

PutWithTTL inserts a <key, value> record with TTL

func (*Store) Remove

func (s *Store) Remove(key string) error

Remove delete a record by key

func (*Store) Update

func (s *Store) Update(key string, value any) error

Update set value by key, value must be gob-encodable

func (*Store) UpdateWithTTL

func (s *Store) UpdateWithTTL(key string, value any, ttl int64) error

UpdateWithTTL set value by key with TTL, value must be gob-encodable