detached e7b3a25

README.md RawHistoryFolder

Read-only mirror. Development happens at git.bnema.dev; issues and pull requests are closed here.


Features

  • Data in memory, persisted to an append-only log with snapshots
  • One writer groups commits into a single fsync
  • Lock-free reads from immutable snapshots
  • Conditional writes (RequireAbsent, RequireVersion)
  • Standard library only, plus zerowrap for logs

Status: early development, no stable API. Linux only.

Usage

import kv "bnema.dev/ermite-kv"

db, err := kv.Open(ctx, "/var/lib/app/kv", kv.Options{})
if err != nil {
	return err
}
defer db.Close(ctx)

var b kv.Batch
b.RequireAbsent([]byte("user/alice"))
b.Put([]byte("user/alice"), []byte(`{"name":"Alice"}`))
seq, err := db.Apply(ctx, &b) // durable and visible when it returns
if errors.Is(err, kv.ErrConflict) {
	// the key already exists
}

for key, item := range db.Snapshot(ctx).Prefix(ctx, []byte("user/")) {
	fmt.Printf("%s = %s (version %d)\n", key, item.Value, item.Version)
}

Durability and visibility guarantees are in the package documentation (go doc bnema.dev/ermite-kv).

Test

go test -race ./...
ERMITE_KV_CRASH_ITERATIONS=200 go test -run TestCrash .   # SIGKILL crash test
ERMITE_KV_LOG_LEVEL=debug go test -run TestPowerLoss .    # with logs

License

MIT. See LICENSE.

source
1<h1 align="center">ermite-kv</h1>
2
3<p align="center">
4  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="License: MIT"></a>
5  <a href="https://github.com/bnema/ermite-kv/commits/main"><img src="https://badgen.net/github/last-commit/bnema/ermite-kv/main?icon=github" alt="Last commit"></a>
6  <a href="https://github.com/bnema/ermite-kv/stargazers"><img src="https://badgen.net/github/stars/bnema/ermite-kv?icon=github" alt="GitHub stars"></a>
7</p>
8
9<p align="center">An embedded key-value store for Go.</p>
10
11> Read-only mirror. Development happens at git.bnema.dev; issues and pull requests are closed here.
12
13---
14
15## Features
16
17- Data in memory, persisted to an append-only log with snapshots
18- One writer groups commits into a single `fsync`
19- Lock-free reads from immutable snapshots
20- Conditional writes (`RequireAbsent`, `RequireVersion`)
21- Standard library only, plus [zerowrap](https://github.com/bnema/zerowrap) for logs
22
23Status: early development, no stable API. Linux only.
24
25## Usage
26
27```go
28import kv "bnema.dev/ermite-kv"
29
30db, err := kv.Open(ctx, "/var/lib/app/kv", kv.Options{})
31if err != nil {
32	return err
33}
34defer db.Close(ctx)
35
36var b kv.Batch
37b.RequireAbsent([]byte("user/alice"))
38b.Put([]byte("user/alice"), []byte(`{"name":"Alice"}`))
39seq, err := db.Apply(ctx, &b) // durable and visible when it returns
40if errors.Is(err, kv.ErrConflict) {
41	// the key already exists
42}
43
44for key, item := range db.Snapshot(ctx).Prefix(ctx, []byte("user/")) {
45	fmt.Printf("%s = %s (version %d)\n", key, item.Value, item.Version)
46}
47```
48
49Durability and visibility guarantees are in the package documentation (`go doc bnema.dev/ermite-kv`).
50
51## Test
52
53```sh
54go test -race ./...
55ERMITE_KV_CRASH_ITERATIONS=200 go test -run TestCrash .   # SIGKILL crash test
56ERMITE_KV_LOG_LEVEL=debug go test -run TestPowerLoss .    # with logs
57```
58
59## License
60
61MIT. See [LICENSE](LICENSE).

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 2

↑↓ moveenter openesc close