kiwi

package module

v0.0.0-...-932458b Latest Latest Go to latest Published: Nov 19, 2023 License: GPL-3.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/spy16/kiwi

Links

Open Source Insights

README ¶

kiwi

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

Features

Supports multiple indexing schemes: B+ Tree

References

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

Constants ¶

This section is empty.

Variables ¶

View Source

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

DefaultOptions provides some sane defaults for initializing Kiwi DB.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
kiwi
index Package index defines common interface and errors for indexing implementations to use.	Package index defines common interface and errors for indexing implementations to use.
bptree Package bptree implements an on-disk B+ tree indexing scheme that can store key-value pairs and provide fast lookups and range scans.	Package bptree implements an on-disk B+ tree indexing scheme that can store key-value pairs and provide fast lookups and range scans.
linearhash
io
pager

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL