filekv

package module

v0.0.1 Latest Latest Go to latest Published: Dec 16, 2022 License: MIT Imports: 10 Imported by: 3

Details

file based kv store with optional dedupe mechanism via bloom filters (only supports set and scan operations)

View Source

const MaxBufSize = 512 * 1024 * 1024

View Source

const Separator = ";;;"

This section is empty.

This section is empty.

type FileDB struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

FileDB - represents a file db implementation

func Open(options Options) (*FileDB, error)

Open a new file based db

func (fdb *FileDB) Close()

Close ...

func (f *FileDB) Merge(items ...interface{}) (uint, error)

func (f *FileDB) MergeFile(filename string) (uint, error)

func (f *FileDB) MergeReader(reader io.Reader) (uint, error)

func (fdb *FileDB) Process() error

Process added files/slices/elements

func (fdb *FileDB) Reset() error

Reset the db

func (fdb *FileDB) Scan(handler func([]byte, []byte) error) error

Scan - iterate over the whole store using the handler function

func (fdb *FileDB) Set(k, v []byte) error

func (fdb *FileDB) Size() int64

Size - returns the size of the database in bytes

type Options struct {
	Path     string
	Dedupe   bool
	Compress bool
	MaxItems uint
	FPRatio  float64
	Cleanup  bool
}

var DefaultOptions Options = Options{
	Dedupe:   true,
	Compress: false,
	MaxItems: math.MaxInt32,
	FPRatio:  0.0000001,
	Cleanup:  true,
}

type Stats struct {
	NumberOfAddedItems uint
	NumberOfDupedItems uint
	NumberOfItems      uint
}