storage

Documentation

Index

• Variables
• type FileStore
  • func NewFileStore(fsConfig *FileStoreConfig) *FileStore
  • func (s *FileStore) Close() error
  • func (s *FileStore) Connect() (err error)
  • func (s *FileStore) Delete(key string) error
  • func (s *FileStore) Get(key string) ([]byte, error)
  • func (s *FileStore) GetPrefix(prefix string, offset, limit int) ([]*KeyValue, error)
  • func (s *FileStore) IterateTxnPrefix(prefix string, fn func(StorageTxn, string) error) error
  • func (s *FileStore) IterateValuesPrefix(prefix string, fn func(string, []byte) error) error
  • func (s *FileStore) Set(key string, value []byte) error
  • func (s *FileStore) Txn(write bool, fn func(StorageTxn) error) error
• type FileStoreConfig
• type FileStoreTxn
  • func (tx *FileStoreTxn) Delete(key string) error
  • func (tx *FileStoreTxn) Get(key string) ([]byte, error)
  • func (s *FileStoreTxn) GetPrefix(prefix string, offset, limit int) ([]*KeyValue, error)
  • func (tx *FileStoreTxn) IterateTxnPrefix(prefix string, fn func(StorageTxn, string) error) error
  • func (tx *FileStoreTxn) IterateValuesPrefix(prefix string, fn func(string, []byte) error) error
  • func (tx *FileStoreTxn) Set(key string, value []byte) error
• type KeyValue
• type MemStore
  • func NewMemStore(cfg *MemStoreConfig) *MemStore
  • func (m *MemStore) Close() error
  • func (m *MemStore) Connect() error
  • func (m *MemStore) Delete(key string) error
  • func (m *MemStore) Get(key string) ([]byte, error)
  • func (m *MemStore) GetPrefix(prefix string, offset, limit int) ([]*KeyValue, error)
  • func (m *MemStore) IterateTxnPrefix(prefix string, fn func(StorageTxn, string) error) error
  • func (m *MemStore) IterateValuesPrefix(prefix string, fn func(string, []byte) error) error
  • func (m *MemStore) Set(key string, value []byte) error
  • func (m *MemStore) Txn(write bool, fn func(StorageTxn) error) error
• type MemStoreConfig
• type MemStoreTxn
  • func (t *MemStoreTxn) Delete(key string) error
  • func (t *MemStoreTxn) Get(key string) ([]byte, error)
  • func (t *MemStoreTxn) GetPrefix(prefix string, offset int, limit int) ([]*KeyValue, error)
  • func (t *MemStoreTxn) IterateTxnPrefix(prefix string, fn func(txn StorageTxn, key string) error) error
  • func (t *MemStoreTxn) IterateValuesPrefix(prefix string, fn func(key string, val []byte) error) error
  • func (t *MemStoreTxn) Set(key string, value []byte) error
• type Storage
• type StorageTxn

Variables

var (
	// ErrTxnReadOnly is returned when the transaction is read only.
	ErrTxnReadOnly error = errors.New("transaction is read only")
)

Types

type FileStore

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

func NewFileStore

func NewFileStore(fsConfig *FileStoreConfig) *FileStore

func (*FileStore) Close

func (s *FileStore) Close() error

func (*FileStore) Connect

func (s *FileStore) Connect() (err error)

func (*FileStore) Delete

func (s *FileStore) Delete(key string) error

func (*FileStore) Get

func (s *FileStore) Get(key string) ([]byte, error)

func (*FileStore) GetPrefix

func (s *FileStore) GetPrefix(prefix string, offset, limit int) ([]*KeyValue, error)

func (*FileStore) IterateTxnPrefix

func (s *FileStore) IterateTxnPrefix(prefix string, fn func(StorageTxn, string) error) error

func (*FileStore) IterateValuesPrefix

func (s *FileStore) IterateValuesPrefix(prefix string, fn func(string, []byte) error) error

func (*FileStore) Set

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

func (*FileStore) Txn

func (s *FileStore) Txn(write bool, fn func(StorageTxn) error) error

type FileStoreConfig

type FileStoreConfig struct {
	Directory string `koanf:"dir"`
	Logger    *zap.Logger
}

type FileStoreTxn

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

func (*FileStoreTxn) Delete

func (tx *FileStoreTxn) Delete(key string) error

func (*FileStoreTxn) Get

func (tx *FileStoreTxn) Get(key string) ([]byte, error)

func (*FileStoreTxn) GetPrefix

func (s *FileStoreTxn) GetPrefix(prefix string, offset, limit int) ([]*KeyValue, error)

func (*FileStoreTxn) IterateTxnPrefix

func (tx *FileStoreTxn) IterateTxnPrefix(prefix string, fn func(StorageTxn, string) error) error

func (*FileStoreTxn) IterateValuesPrefix

func (tx *FileStoreTxn) IterateValuesPrefix(prefix string, fn func(string, []byte) error) error

func (*FileStoreTxn) Set

func (tx *FileStoreTxn) Set(key string, value []byte) error

type KeyValue

type KeyValue struct {
	Key   string
	Value []byte
}

type MemStore

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

func NewMemStore

func NewMemStore(cfg *MemStoreConfig) *MemStore

func (*MemStore) Close

func (m *MemStore) Close() error

func (*MemStore) Connect

func (m *MemStore) Connect() error

func (*MemStore) Delete

func (m *MemStore) Delete(key string) error

func (*MemStore) Get

func (m *MemStore) Get(key string) ([]byte, error)

func (*MemStore) GetPrefix

func (m *MemStore) GetPrefix(prefix string, offset, limit int) ([]*KeyValue, error)

func (*MemStore) IterateTxnPrefix

func (m *MemStore) IterateTxnPrefix(prefix string, fn func(StorageTxn, string) error) error

func (*MemStore) IterateValuesPrefix

func (m *MemStore) IterateValuesPrefix(prefix string, fn func(string, []byte) error) error

func (*MemStore) Set

func (m *MemStore) Set(key string, value []byte) error

func (*MemStore) Txn

func (m *MemStore) Txn(write bool, fn func(StorageTxn) error) error

type MemStoreConfig

type MemStoreConfig struct {
	Logger *zap.Logger
}

type MemStoreTxn

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

func (*MemStoreTxn) Delete

func (t *MemStoreTxn) Delete(key string) error

func (*MemStoreTxn) Get

func (t *MemStoreTxn) Get(key string) ([]byte, error)

func (*MemStoreTxn) GetPrefix

func (t *MemStoreTxn) GetPrefix(prefix string, offset int, limit int) ([]*KeyValue, error)

func (*MemStoreTxn) IterateTxnPrefix

func (t *MemStoreTxn) IterateTxnPrefix(prefix string, fn func(txn StorageTxn, key string) error) error

func (*MemStoreTxn) IterateValuesPrefix

func (t *MemStoreTxn) IterateValuesPrefix(prefix string, fn func(key string, val []byte) error) error

func (*MemStoreTxn) Set

func (t *MemStoreTxn) Set(key string, value []byte) error

type Storage

type Storage interface {
	StorageTxn
	Txn(write bool, fn func(txn StorageTxn) error) error
	Connect() error
	Close() error
}

type StorageTxn

type StorageTxn interface {
	Get(string) ([]byte, error)
	Set(string, []byte) error
	IterateValuesPrefix(prefix string, fn func(key string, val []byte) error) error
	IterateTxnPrefix(prefix string, fn func(txn StorageTxn, key string) error) error
	GetPrefix(prefix string, offset, limit int) ([]*KeyValue, error)
	Delete(string) error
}