core

Documentation

Overview

Package core provides the core BitDB implementation.

Index

• Variables
• type DB
  • func Open(dir string, opts ...Option) (rdb *DB, rerr error)
  • func SetupTempDB(tb testing.TB, dbOpts ...Option) (db *DB, path string, cleanup func())
  • func (db *DB) AbortOpen() (errs error)
  • func (db *DB) Close() (errs error)
  • func (db *DB) Delete(key string) error
  • func (db *DB) DiskSize() (int64, error)
  • func (db *DB) Get(key string) (string, error)
  • func (db *DB) MergeErrors() <-chan error
  • func (db *DB) Set(key, val string) error
• type Option
  • func WithChecksumEnabled(b bool) Option
  • func WithFsync(b bool) Option
  • func WithMergeEnabled(b bool) Option
  • func WithMergeThreshold(n int) Option
  • func WithOnMergeApply(f func()) Option
  • func WithOnMergeStart(f func()) Option
  • func WithRolloverThreshold(n int64) Option
• type WriteType

Variables

var ErrChecksumMismatch = errors.New("checksum mismatch")

var ErrKeyNotFound = errors.New("key not found")

Types

type DB

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

func Open

func Open(dir string, opts ...Option) (rdb *DB, rerr error)

func SetupTempDB

func SetupTempDB(tb testing.TB, dbOpts ...Option) (db *DB, path string, cleanup func())

func (*DB) AbortOpen

func (db *DB) AbortOpen() (errs error)

AbortOpen In case a failure happens during Open, we need to clean-up stuff opened so far. Keeping this separate from Close, which ensures graceful shutdown.

func (*DB) Close

func (db *DB) Close() (errs error)

func (*DB) Delete

func (db *DB) Delete(key string) error

func (*DB) DiskSize

func (db *DB) DiskSize() (int64, error)

DiskSize returns the sum of all on-disk segment file sizes.

func (*DB) Get

func (db *DB) Get(key string) (string, error)

func (*DB) MergeErrors

func (db *DB) MergeErrors() <-chan error

func (*DB) Set

func (db *DB) Set(key, val string) error

type Option

type Option func(*DB)

func WithChecksumEnabled

func WithChecksumEnabled(b bool) Option

func WithFsync

func WithFsync(b bool) Option

func WithMergeEnabled

func WithMergeEnabled(b bool) Option

func WithMergeThreshold

func WithMergeThreshold(n int) Option

func WithOnMergeApply

func WithOnMergeApply(f func()) Option

func WithOnMergeStart

func WithOnMergeStart(f func()) Option

func WithRolloverThreshold

func WithRolloverThreshold(n int64) Option

type WriteType

type WriteType int8

const (
	TypeDelete WriteType = iota
	TypeSet
)