common

Documentation

Index

• Constants
• Variables
• func Concat(xs ...string) string
• func CreateFile(path string) (*os.File, error)
• func EnsureDir(path string) error
• func ListDir[T any](path string, mut func(string) (T, bool)) ([]T, error)
• func Max(a, b []byte) []byte
• func Min(a, b []byte) []byte
• type DbOp
• type InnerStorage
• type InnerStorageIterator
• type InternalKey
  • func DeserializeKey(key []byte) *InternalKey
  • func NewInternalKey(ukey []byte, seqNum uint64, kind DbOp) *InternalKey
  • func SearchInternalKey(key []byte) *InternalKey
  • func (ik *InternalKey) Compare(other *InternalKey) int
  • func (ik *InternalKey) Equal(other *InternalKey) bool
  • func (ik *InternalKey) GetMeta() KeyMeta
  • func (ik *InternalKey) GetSize() int
  • func (ik *InternalKey) Kind() uint8
  • func (ik *InternalKey) SeqNum() uint64
  • func (ik *InternalKey) Serialize() []byte
  • func (ik *InternalKey) SoftCompare(other *InternalKey) int
  • func (ik *InternalKey) SoftEqual(other *InternalKey) bool
  • func (ik *InternalKey) String() string
• type Iterator
• type KeyMeta
  • func (km KeyMeta) Kind() DbOp
  • func (km KeyMeta) SeqNum() uint64

Constants

const (
	MAX_MEMTABLE_THRESHOLD = 1 * (1 << 20)

	MAX_SINK_SIZE = 8

	SST_DIR  = "sst"
	WAL      = "wal"
	MANIFEST = "MANIFEST"
)

const MetaLen = 8

Variables

var (
	EndOfIterator        = errors.New("out of records")
	ErrKeyNotFound       = errors.New("key not found")
	ErrPathFile          = errors.New("provied path points to a file instead of directory")
	ErrKeyAlreadyExists  = errors.New("key already exists")
	ErrIteratorExhausted = errors.New("iterator exhausted")
)

var TOMBSTONE []byte

Functions

func Concat

func Concat(xs ...string) string

func CreateFile

func CreateFile(path string) (*os.File, error)

func EnsureDir

func EnsureDir(path string) error

func ListDir

func ListDir[T any](path string, mut func(string) (T, bool)) ([]T, error)

func Max

func Max(a, b []byte) []byte

func Min

func Min(a, b []byte) []byte

Types

type DbOp

type DbOp = uint8

const (
	SET DbOp = iota
	DELETE
)

type InnerStorage

type InnerStorage interface {
	Set(uKey *InternalKey, value []byte) error
	Get(key []byte) ([]byte, bool)
	GetSize() uint64
	NewIter() InnerStorageIterator
}

type InnerStorageIterator

type InnerStorageIterator interface {
	Valid() bool
	Next() (*InternalKey, []byte)
}

type InternalKey

type InternalKey struct {
	UserKey []byte
	Meta    KeyMeta
}

func DeserializeKey

func DeserializeKey(key []byte) *InternalKey

func NewInternalKey

func NewInternalKey(ukey []byte, seqNum uint64, kind DbOp) *InternalKey

func SearchInternalKey

func SearchInternalKey(key []byte) *InternalKey

func (*InternalKey) Compare

func (ik *InternalKey) Compare(other *InternalKey) int

func (*InternalKey) Equal

func (ik *InternalKey) Equal(other *InternalKey) bool

func (*InternalKey) GetMeta

func (ik *InternalKey) GetMeta() KeyMeta

func (*InternalKey) GetSize

func (ik *InternalKey) GetSize() int

func (*InternalKey) Kind

func (ik *InternalKey) Kind() uint8

func (*InternalKey) SeqNum

func (ik *InternalKey) SeqNum() uint64

func (*InternalKey) Serialize

func (ik *InternalKey) Serialize() []byte

func (*InternalKey) SoftCompare

func (ik *InternalKey) SoftCompare(other *InternalKey) int

func (*InternalKey) SoftEqual

func (ik *InternalKey) SoftEqual(other *InternalKey) bool

func (*InternalKey) String

func (ik *InternalKey) String() string

type Iterator

type Iterator interface {
	Next() (*InternalKey, []byte, error)
	Key() *InternalKey
	Valid() bool
	Value() []byte
	SeekToFirst() (*InternalKey, []byte, error)
}

type KeyMeta

type KeyMeta uint64

func (KeyMeta) Kind

func (km KeyMeta) Kind() DbOp

func (KeyMeta) SeqNum

func (km KeyMeta) SeqNum() uint64