README
¶
Goku
Goku is a library written in Go to create a simple thread safe in-memory datastore that is persisted to disk.
Usage
package main
import (
"fmt"
"github.com/abhicnv007/goku"
)
func main() {
g := goku.New(".db")
defer g.Close()
g.Add("foo", "bar")
if val, ok := g.Get("foo"); ok {
// use val
fmt.Println(val) // Output: bar
}
}
How does it work?
Goku creates an append only file at the location and logs out all operations to this file. In the event of a crash, the events from log are replayed and the data is reconstructed in memory.
g := goku.New(".db")
g.Add("foo", "bar")
// many more adds
// program crash
g = goku.New(".db") // load the data back from the file
g.Get("foo") // bar
The .db file can be freely trnasferred.
Benchmarks
goos: darwin
goarch: amd64
pkg: github.com/abhicnv007/goku
BenchmarkAdd-12 275427 19766 ns/op 10483 B/op 2 allocs/op
BenchmarkGet-12 44926000 401 ns/op 0 B/op 0 allocs/op
TODO
- Allow for dump and restore
- Test file corruption
Documentation
¶
Overview ¶
Package goku is a library that implements an in memory but persistant datastore
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Goku ¶
type Goku struct {
// contains filtered or unexported fields
}
Goku is the core data strcture of the library. It stores all the key value pairs and pointers to the log file
func New ¶
New creates a new instance of Goku. Each instance has it's own private store. It creates a append log at the path given, which contains all operations performed on Goku allowing recovery of data in case of program crash.
Example:
g := goku.New(".goku_data")
func (*Goku) Add ¶
Add a key value pair to the Goku instance and also persists the operation to disk.
func (*Goku) Clear ¶
func (g *Goku) Clear()
Clear deletes all elements and truncates the log from disk.
Example:
g := goku.New(".db")
defer g.Clear()
Source Files
Directories