storage

Documentation

Index

• Variables
• type DebugStore
  • func NewDebugStore(cfg *DebugStoreConfig) *DebugStore
  • func (m *DebugStore) Close() error
  • func (m *DebugStore) Connect() error
  • func (m *DebugStore) Delete(key string) error
  • func (m *DebugStore) Get(key string) ([]byte, error)
  • func (m *DebugStore) GetPrefix(prefix string, offset, limit int) ([]*KeyValue, error)
  • func (m *DebugStore) IterateTxnPrefix(prefix string, fn func(StorageTxn, string) error) error
  • func (m *DebugStore) IterateValuesPrefix(prefix string, fn func(string, []byte) error) error
  • func (m *DebugStore) Set(key string, value []byte) error
• type DebugStoreConfig
• type FileStore
  • func NewFileStore(fsConfig *FileStoreConfig) *FileStore
  • func (s *FileStore) Close() error
  • func (s *FileStore) Connect() 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(readOnly 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 MemoryStore
  • func NewMemoryStore(cfg *MemoryStoreConfig) *MemoryStore
• type MemoryStoreConfig
• type Storage
• type StorageTxn

Variables

var (
	// ErrStoreLocked is returned when the storage is locked.
	ErrStoreLocked error = errors.New("storage is locked")
	// ErrKeyNotFound is returned when the key is not found.
	ErrKeyNotFound error = errors.New("key not found")
	// ErrTxnReadOnly is returned when the transaction is read only.
	ErrTxnReadOnly error = errors.New("transaction is read only")
)

Types

type DebugStore

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

func NewDebugStore

func NewDebugStore(cfg *DebugStoreConfig) *DebugStore

func (*DebugStore) Close

func (m *DebugStore) Close() error

func (*DebugStore) Connect

func (m *DebugStore) Connect() error

func (*DebugStore) Delete

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

func (*DebugStore) Get

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

func (*DebugStore) GetPrefix

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

func (*DebugStore) IterateTxnPrefix

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

func (*DebugStore) IterateValuesPrefix

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

func (*DebugStore) Set

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

type DebugStoreConfig

type DebugStoreConfig struct {
	Logger *zap.Logger
}

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() 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(readOnly 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 MemoryStore

type MemoryStore struct {
	*FileStore
}

func NewMemoryStore

func NewMemoryStore(cfg *MemoryStoreConfig) *MemoryStore

type MemoryStoreConfig

type MemoryStoreConfig struct {
	// Path to the directory where the files will be stored.
	// If the directory does not exist, it will be created.
	// If the directory exists, it will be used.
	Logger *zap.Logger
}

type Storage

type Storage interface {
	StorageTxn
	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
}