mirror of
https://github.com/taigrr/bitcask
synced 2025-01-18 04:03:17 -08:00
77 lines
1.8 KiB
Markdown
77 lines
1.8 KiB
Markdown
# bitcask
|
|
|
|
[](https://cloud.drone.io/prologic/bitcask)
|
|
[](https://codecov.io/gh/prologic/bitcask)
|
|
[](https://goreportcard.com/report/prologic/bitcask)
|
|
[](https://godoc.org/github.com/prologic/bitcask)
|
|
[](https://sourcegraph.com/github.com/prologic/bitcask?badge)
|
|
|
|
A Bitcask (LSM+WAL) Key/Value Store written in Go.
|
|
|
|
## Features
|
|
|
|
* Embeddable
|
|
* Builtin CLI
|
|
* Predictable read/write performance
|
|
* Low latecny
|
|
* High throughput (See: [Performance](README.md#Performance)
|
|
|
|
## Install
|
|
|
|
```#!bash
|
|
$ go get github.com/prologic/bitcask
|
|
```
|
|
|
|
## Usage (library)
|
|
|
|
Install the package into your project:
|
|
|
|
```#!bash
|
|
$ go get github.com/prologic/bitcask
|
|
```
|
|
|
|
```#!go
|
|
package main
|
|
|
|
import (
|
|
"log"
|
|
|
|
"github.com/prologic/bitcask"
|
|
)
|
|
|
|
func main() {
|
|
db, _ := bitcask.Open("/tmp/db")
|
|
db.Set("Hello", []byte("World"))
|
|
db.Close()
|
|
}
|
|
```
|
|
|
|
See the [godoc](https://godoc.org/github.com/prologic/bitcask) for further
|
|
documentation and other examples.
|
|
|
|
## Usage (tool)
|
|
|
|
```#!bash
|
|
$ bitcask -p /tmp/db set Hello World
|
|
$ bitcask -p /tmp/db get Hello
|
|
World
|
|
```
|
|
|
|
## Performance
|
|
|
|
Benchmarks run on a 11" Macbook with a 1.4Ghz Intel Core i7:
|
|
|
|
```
|
|
$ make bench
|
|
...
|
|
BenchmarkGet-4 300000 5065 ns/op 144 B/op 4 allocs/op
|
|
BenchmarkPut-4 100000 14640 ns/op 699 B/op 7 allocs/op
|
|
```
|
|
|
|
* ~180,000 reads/sec
|
|
* ~60,000 writes/sec
|
|
|
|
## License
|
|
|
|
bitcask is licensed under the [MIT License](https://github.com/prologic/bitcask/blob/master/LICENSE)
|