nuts

Documentation

Index

• Constants
• Variables
• func BackupReader(dst string, src io.Reader) error
• func BackupWriter(src string, dst io.Writer) error
• func DisableStrictMode()
• func EnableStrictMode()
• func New(cfg Config) (store.Store, error)
• func PrefixKey(prefix []byte) string
• func ReadTTL(md *nutsdb.MetaData) uint32
• func WatchKey(key []byte) (hash uint64)
• type Config
• type RWMode
• type Store
  • func (s *Store) Begin(writable bool) (*nutsdb.Tx, error)
  • func (s *Store) Break(ctx context.Context) error
  • func (s *Store) Close() error
  • func (s *Store) DB() (*nutsdb.DB, error)
  • func (s *Store) Del(key []byte) error
  • func (s *Store) Get(key []byte) (*store.Value, error)
  • func (s *Store) GetNamespace() string
  • func (s *Store) Namespace(namespace string) (store.Namespace, error)
  • func (s *Store) PrefixScan(prefix []byte, offset, limit int) ([]*store.Value, error)
  • func (s *Store) PrefixSearchScan(prefix []byte, reg string, offset, limit int) ([]*store.Value, error)
  • func (s *Store) Restore(src io.Reader) (err error)
  • func (s *Store) Set(key, value []byte) error
  • func (s *Store) SetWithTTL(key, value []byte, ttl uint32) error
  • func (s *Store) Snapshot() (io.Reader, error)
  • func (s *Store) State() uint32
  • func (s *Store) Transaction(writable bool, fn func(tx *nutsdb.Tx) error) error
  • func (s *Store) TrySet(key, value []byte) error
  • func (s *Store) TrySetWithTTL(key, value []byte, ttl uint32) error
  • func (s *Store) Watch(key []byte) (store.WatcherNotify, error)
  • func (s *Store) WatchPrefix(prefix []byte) store.WatcherNotify
• type Watcher
  • func (w *Watcher) Namespace(namespace string) *WatcherChild
• type WatcherChannel
  • func (c *WatcherChannel) AddNotify(dest *WatcherNotify)
  • func (c *WatcherChannel) UpdateValue(key []byte, value *[]byte, ttl uint32)
• type WatcherChild
  • func (c *WatcherChild) Update(key, value []byte, ttl uint32)
  • func (c *WatcherChild) Watch(key []byte) *WatcherNotify
  • func (c *WatcherChild) WatchPrefix(prefix []byte) *WatcherNotify
• type WatcherNotify
  • func (n *WatcherNotify) Close() error
  • func (n *WatcherNotify) Notify() chan *store.WatchValue

Constants

const (
	StateOk uint32 = iota
	StateBreak
)

const (
	// FileIO represents the read and write mode using standard I/O.
	FileIO = nutsdb.FileIO

	// MMap represents the read and write mode using mmap.
	MMap = nutsdb.MMap
)

const WatcherNotifyValueSize = 1024

Variables

var (
	ErrStateBreak = errors.New("state break")
)

Functions

func BackupReader

func BackupReader(dst string, src io.Reader) error

func BackupWriter

func BackupWriter(src string, dst io.Writer) error

func DisableStrictMode

func DisableStrictMode()

func EnableStrictMode

func EnableStrictMode()

func New

func New(cfg Config) (store.Store, error)

func PrefixKey

func PrefixKey(prefix []byte) string

func ReadTTL

func ReadTTL(md *nutsdb.MetaData) uint32

func WatchKey

func WatchKey(key []byte) (hash uint64)

WatchKey from: https://en.wikipedia.org/wiki/Jenkins_hash_function (Jenkins' One-At-A-Time hashing)

Types

type Config

type Config struct {
	NodeNum int64
	Sync    bool
	DataDir string
	RWMode  RWMode
}

type RWMode

type RWMode = nutsdb.RWMode

RWMode represents the read and write mode.

type Store

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

func (*Store) Begin

func (s *Store) Begin(writable bool) (*nutsdb.Tx, error)

func (*Store) Break

func (s *Store) Break(ctx context.Context) error

func (*Store) Close

func (s *Store) Close() error

func (*Store) DB

func (s *Store) DB() (*nutsdb.DB, error)

func (*Store) Del

func (s *Store) Del(key []byte) error

func (*Store) Get

func (s *Store) Get(key []byte) (*store.Value, error)

func (*Store) GetNamespace

func (s *Store) GetNamespace() string

func (*Store) Namespace

func (s *Store) Namespace(namespace string) (store.Namespace, error)

func (*Store) PrefixScan

func (s *Store) PrefixScan(prefix []byte, offset, limit int) ([]*store.Value, error)

func (*Store) PrefixSearchScan

func (s *Store) PrefixSearchScan(prefix []byte, reg string, offset, limit int) ([]*store.Value, error)

func (*Store) Restore

func (s *Store) Restore(src io.Reader) (err error)

func (*Store) Set

func (s *Store) Set(key, value []byte) error

func (*Store) SetWithTTL

func (s *Store) SetWithTTL(key, value []byte, ttl uint32) error

func (*Store) Snapshot

func (s *Store) Snapshot() (io.Reader, error)

func (*Store) State

func (s *Store) State() uint32

func (*Store) Transaction

func (s *Store) Transaction(writable bool, fn func(tx *nutsdb.Tx) error) error

func (*Store) TrySet

func (s *Store) TrySet(key, value []byte) error

func (*Store) TrySetWithTTL

func (s *Store) TrySetWithTTL(key, value []byte, ttl uint32) error

func (*Store) Watch

func (s *Store) Watch(key []byte) (store.WatcherNotify, error)

func (*Store) WatchPrefix

func (s *Store) WatchPrefix(prefix []byte) store.WatcherNotify

type Watcher

type Watcher struct {
	Namespaces sync.Map // map[string]*WatcherChild
}

func (*Watcher) Namespace

func (w *Watcher) Namespace(namespace string) *WatcherChild

type WatcherChannel

type WatcherChannel struct {
	PrefixWatch bool
	Seq         uint64
	LastUpdate  int64
	Value       *[]byte
	Prefix      []byte
	Notify      sync.Map // map[string]*WatcherNotify
	// contains filtered or unexported fields
}

func (*WatcherChannel) AddNotify

func (c *WatcherChannel) AddNotify(dest *WatcherNotify)

func (*WatcherChannel) UpdateValue

func (c *WatcherChannel) UpdateValue(key []byte, value *[]byte, ttl uint32)

type WatcherChild

type WatcherChild struct {
	Namespace      string
	Channels       sync.Map // map[uint64]*WatcherChannel
	PrefixChannels sync.Map // map[string]*WatcherChannel
}

func (*WatcherChild) Update

func (c *WatcherChild) Update(key, value []byte, ttl uint32)

func (*WatcherChild) Watch

func (c *WatcherChild) Watch(key []byte) *WatcherNotify

func (*WatcherChild) WatchPrefix

func (c *WatcherChild) WatchPrefix(prefix []byte) *WatcherNotify

type WatcherNotify

type WatcherNotify struct {
	Values chan *store.WatchValue
	UUID   string
	// contains filtered or unexported fields
}

func (*WatcherNotify) Close

func (n *WatcherNotify) Close() error

func (*WatcherNotify) Notify

func (n *WatcherNotify) Notify() chan *store.WatchValue