kiwi

README

kiwi

Kiwi is a multi-backend key-value store written in Go.

Features

• Supports multiple indexing schemes: B+ Tree

References

1. https://hackthology.com/linear-hashing.html
2. http://research.cs.vt.edu/AVresearch/hashing/
3. https://cstack.github.io/db_tutorial/
4. https://github.com/boltdb/bolt
5. https://artem.krylysov.com/blog/2018/03/24/pogreb-key-value-store/
6. https://hackthology.com/an-in-memory-go-implementation-of-linear-hashing.html

Documentation

Index

• Variables
• type DB
  • func Open(filePath string, opts *Options) (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) String() string
• type IndexType
• type Options

Variables

var DefaultOptions = Options{
	IndexType: BPlusTree,
	ReadOnly:  false,
	FileMode:  0664,
	Log:       func(msg string, args ...interface{}) {},
}

DefaultOptions provides some sane defaults for initializing Kiwi DB.

Types

type DB

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

DB represents an instance of Kiwi database.

func Open

func Open(filePath string, opts *Options) (*DB, error)

Open opens the named file as Kiwi database and returns a DB instance for accessing it. If the file doesn't exist, it will be created and initialized if not in read-only mode.

func (*DB) Close

func (db *DB) Close() error

Close closes the underlying files and the indexers.

func (*DB) String

func (db *DB) String() string

type IndexType

type IndexType int

IndexType represents the type of the index to be used by Kiwi.

const (
	BPlusTree IndexType = 0
)

Indexing schemes supported.

type Options

type Options struct {
	IndexType IndexType
	ReadOnly  bool
	FileMode  os.FileMode
	Log       func(msg string, args ...interface{})
}

Options represents configuration settings for kiwi database.