store

Documentation

Index

• type Option
  • func BurstRate(burstRate uint64) Option
  • func GCInterval(gcInterval time.Duration) Option
  • func GCTimeLimit(gcTimeLimit time.Duration) Option
  • func IndexBitSize(indexBitSize uint8) Option
  • func IndexFileSize(indexFileSize uint32) Option
  • func SyncInterval(syncInterval time.Duration) Option
• type Store
  • func OpenStore(ctx context.Context, path string, primary primary.PrimaryStorage, ...) (*Store, error)
  • func (s *Store) Close() error
  • func (s *Store) Err() error
  • func (s *Store) Flush()
  • func (s *Store) FreelistStorageSize() (int64, error)
  • func (s *Store) Get(key []byte) ([]byte, bool, error)
  • func (s *Store) GetSize(key []byte) (types.Size, bool, error)
  • func (s *Store) Has(key []byte) (bool, error)
  • func (s *Store) IndexStorageSize() (int64, error)
  • func (s *Store) PrimaryStorageSize() (int64, error)
  • func (s *Store) Put(key []byte, value []byte) error
  • func (s *Store) Remove(key []byte) (bool, error)
  • func (s *Store) Start()
  • func (s *Store) StorageSize() (int64, error)

Types

type Option

type Option func(*config)

func BurstRate

func BurstRate(burstRate uint64) Option

BurstRate specifies how much unwritten data can accumulate before causing data to be flushed to disk.

func GCInterval

func GCInterval(gcInterval time.Duration) Option

GCInterval is the amount of time to wait between GC cycles.

func GCTimeLimit

func GCTimeLimit(gcTimeLimit time.Duration) Option

GCTimeLimit is the maximum amount of time that a GC cycle may run.

func IndexBitSize

func IndexBitSize(indexBitSize uint8) Option

IndexBitSize is the number of bits in an index prefix.

func IndexFileSize

func IndexFileSize(indexFileSize uint32) Option

IndexFileSize is the maximum offset an index record can have within an individual index file, before the record must be stored in another file.

func SyncInterval

func SyncInterval(syncInterval time.Duration) Option

SyncInterval determines how frequently changes are flushed to disk.

type Store

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

func OpenStore

func OpenStore(ctx context.Context, path string, primary primary.PrimaryStorage, immutable bool, options ...Option) (*Store, error)

OpenStore opens the index and freelist and returns a Store with the given primary.

Specifying 0 for indexSizeBits and indexFileSize results in using their default values. A gcInterval of 0 disables garbage collection.

func (*Store) Close

func (s *Store) Close() error

Close stops store goroutines and calls Close on the index, primary, and freelist. This flushes any outstanding work and buffered data to their files.

func (*Store) Err

func (s *Store) Err() error

func (*Store) Flush

func (s *Store) Flush()

Flush writes outstanding work and buffered data to the primary, index, and freelist files. It then syncs these files to permanent storage.

func (*Store) FreelistStorageSize

func (s *Store) FreelistStorageSize() (int64, error)

FreelistStorageSize returns the storage used by the freelist files.

func (*Store) Get

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

func (*Store) GetSize

func (s *Store) GetSize(key []byte) (types.Size, bool, error)

func (*Store) Has

func (s *Store) Has(key []byte) (bool, error)

func (*Store) IndexStorageSize

func (s *Store) IndexStorageSize() (int64, error)

IndexStorageSize returns the storage used by the index files.

func (*Store) PrimaryStorageSize

func (s *Store) PrimaryStorageSize() (int64, error)

PrimaryStorageSize returns the storage used by the primary storage files.

func (*Store) Put

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

func (*Store) Remove

func (s *Store) Remove(key []byte) (bool, error)

func (*Store) Start

func (s *Store) Start()

func (*Store) StorageSize

func (s *Store) StorageSize() (int64, error)

StorageSize returns the storage used by the index, primary, and freelist files.