scdb

Documentation

Index

• type Store
  • func New(path string, maxKeys *uint64, redundantBlocks *uint16, poolCapacity *uint64, ...) (*Store, error)
  • func (s *Store) Clear() error
  • func (s *Store) Close() error
  • func (s *Store) Compact() error
  • func (s *Store) Delete(k []byte) error
  • func (s *Store) Get(k []byte) ([]byte, error)
  • func (s *Store) Set(k []byte, v []byte, ttl *uint64) error

Types

type Store

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

Store is the public interface to the key-value store that allows us to do operations like Set, Get, Delete, Clear and Compact on the internal.Store

func New

func New(path string, maxKeys *uint64, redundantBlocks *uint16, poolCapacity *uint64, compactionInterval *uint32) (*Store, error)

New creates a new Store at the given path

func (*Store) Clear

func (s *Store) Clear() error

Clear removes all data in the store

func (*Store) Close

func (s *Store) Close() error

Close frees up any resources occupied by store. After this, the store is unusable. You have to re-instantiate it or just run into some crazy errors

func (*Store) Compact

func (s *Store) Compact() error

Compact manually removes dangling key-value pairs in the database file

Dangling keys result from either getting expired or being deleted. When a Store.Delete operation is done, the actual key-value pair is just marked as `deleted` but is not removed.

Something similar happens when a key-value is updated. A new key-value pair is created and the old one is left un-indexed. Compaction is important because it reclaims this space and reduces the size of the database file.

This is done automatically for you at the set `compactionInterval` but you may wish to do it manually for some reason.

This is a very expensive operation so use it sparingly.

func (*Store) Delete

func (s *Store) Delete(k []byte) error

Delete removes the key-value for the given key

func (*Store) Get

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

Get returns the value corresponding to the given key

func (*Store) Set

func (s *Store) Set(k []byte, v []byte, ttl *uint64) error

Set sets the given key value in the store This is used to insert or update any key-value pair in the store