linkdb

README

linkdb

A persistent key-value store built using linked list datastructure

Documentation

Overview

linkdb is a key-value store for persistent storage. It aims to store both small and large values efficiently with minimal disk IOPS per operation. Since it keeps all the keys in memory, it is not suitable for storing large number of keys.

Index

• Constants
• type Database
  • func Format[T proto.Message](disk Disk, metadata T, initValues ...T) (Database[T], error)
  • func Open[T proto.Message](disk Disk) (Database[T], error)
• type Disk

Constants

const (
	MinBlockSize = 4 * 1024
)

Types

type Database

type Database[T proto.Message] interface {
	Metadata() T
	Get(key string) (T, []byte, error)
	GetRange(key string, off int64, len int64) (T, []byte, error)
	Put(key string, t T, value []byte) error
	List() map[string]T
}

func Format

func Format[T proto.Message](disk Disk, metadata T, initValues ...T) (Database[T], error)

func Open

func Open[T proto.Message](disk Disk) (Database[T], error)

type Disk

type Disk interface {
	io.WriterAt
	io.ReaderAt

	BlockSize() int64
	Capacity() int64
}