store

Documentation

Overview

Package store is an interface for distribute data storage.

Index

• type Option
  • func Namespace(ns string) Option
  • func Nodes(a ...string) Option
  • func Prefix(p string) Option
• type Options
• type ReadOption
  • func ReadPrefix() ReadOption
• type ReadOptions
• type Record
• type Store

Types

type Option

type Option func(o *Options)

func Namespace

func Namespace(ns string) Option

Namespace offers a way to have multiple isolated stores in the same backend, if supported.

func Nodes

func Nodes(a ...string) Option

Nodes is a list of nodes used to back the store

func Prefix

func Prefix(p string) Option

Prefix sets a prefix to any key ids used

type Options

type Options struct {
	// nodes to connect to
	Nodes []string
	// Namespace of the store
	Namespace string
	// Prefix of the keys used
	Prefix string
	// Alternative options
	Context context.Context
}

type ReadOption

type ReadOption func(o *ReadOptions)

func ReadPrefix

func ReadPrefix() ReadOption

ReadPrefix uses the key as a prefix

type ReadOptions

type ReadOptions struct {
	// Read key as a prefix
	Prefix bool
}

type Record

type Record struct {
	Key    string
	Value  []byte
	Expiry time.Duration
}

Record represents a data record

type Store

type Store interface {
	// Initialise store options
	Init(...Option) error
	// List all the known records
	List() ([]*Record, error)
	// Read records with keys
	Read(key string, opts ...ReadOption) ([]*Record, error)
	// Write records
	Write(*Record) error
	// Delete records with keys
	Delete(key string) error
	// Name of the store
	String() string
}

Store is a data storage interface

var (
	// ErrNotFound is returned when a Read key doesn't exist
	ErrNotFound = errors.New("not found")
	// Default store
	DefaultStore Store = new(noop)
)