# rosedb **Repository Path**: asione/rosedb ## Basic Information - **Project Name**: rosedb - **Description**: No description available - **Primary Language**: Go - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 1 - **Created**: 2021-07-22 - **Last Updated**: 2022-02-14 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ![rosedb_ico.png](https://i.loli.net/2021/04/28/gIL2FXZcOesPmyD.png) ![](https://img.shields.io/github/license/roseduan/rosedb) [![Go Report Card](https://goreportcard.com/badge/github.com/roseduan/rosedb) ](https://goreportcard.com/report/github.com/roseduan/rosedb)![GitHub top language](https://img.shields.io/github/languages/top/roseduan/rosedb) [![GitHub stars](https://img.shields.io/github/stars/roseduan/rosedb) ](https://github.com/roseduan/rosedb/stargazers)[![codecov](https://codecov.io/gh/roseduan/rosedb/branch/main/graph/badge.svg?token=YZUB9QT6XF)](https://codecov.io/gh/roseduan/rosedb) [![CodeFactor](https://www.codefactor.io/repository/github/roseduan/rosedb/badge)](https://www.codefactor.io/repository/github/roseduan/rosedb) [![Go Reference](https://pkg.go.dev/badge/github.com/roseduan/rosedb.svg)](https://pkg.go.dev/github.com/roseduan/rosedb) [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go#database) [English](https://github.com/roseduan/rosedb#rosedb) | [简体中文](https://github.com/roseduan/rosedb/blob/main/README-CN.md) rosedb is a fast, stable and embedded k-v database based on bitcask, data file in disk is similar to WAL in LSM tree, so it has great write performance and high throughput. It also supports many kinds of data structures such as `string`, `list`, `hash`, `set`, `sorted set`. rosedb is in pure `Go`, and it is simple and easy enough to use in production. Our vision is to build an efficient kv storage engine for Go-based applications, you can give us any advices, and also please give us a star ✨，that will help us a lot, thanks! [![Stargazers over time](https://starchart.cc/roseduan/rosedb.svg)](https://starchart.cc/roseduan/rosedb) ## Feature * Support rich data structures : `string`, `list`, `hash`, `set`, `zset`. * Easy to embedded (`import "github.com/roseduan/rosedb"`). * Low latency and high throughput(see Benchmark). * Operations of various data types can be parallel. * Has builtin rosedb-cli for command line, also support redis-cli. * Support expiration and TTL. * Support prefix scan and range scan for string keys. ## Usage ### Cli example Change the directory to rosedb/cmd/server. Run the `main.go` ![Xnip2021-04-14_14-33-11.png](https://i.loli.net/2021/04/14/EsMFv48YB3P9j7k.png) Open a new shell, and change the directory to rosedb/cmd/cli, and run the `main.go`： ![Xnip2021-04-14_14-35-50.png](https://i.loli.net/2021/04/14/9uh1ElVF3C4D6dM.png) Or you can just use `redis-cli` or any other redis client： ![2021-05-14 上午11.19.24.png](https://i.loli.net/2021/05/14/eYkMyTzl5CXUN83.png) ### Embedded example Import rosedb in the application: ```go import "github.com/roseduan/rosedb" ``` And open a database: ```go package main import ( "github.com/roseduan/rosedb" "log" ) func main() { config := rosedb.DefaultConfig() db, err := rosedb.Open(config) if err != nil { log.Fatal(err) } // don`t forget to close! defer db.Close() //... } ``` ### Deploy and run on Docker ```shell docker build -t="rosedb:v1.2.7" . docker run --name=rosedb -itd -p 5200:5200 rosedb:v1.2.7 docker exec -it rosedb sh $ rosedb-cli 127.0.0.1:5200>set hello rosedb OK 127.0.0.1:5200>get hello rosedb ``` ## Command ### String * Set * SetNx * Get * GetSet * Append * StrLen * StrExists * StrRem * PrefixScan * RangeScan * Expire * Persist * TTL ### List * LPush * RPush * LPop * RPop * LIndex * LRem * LInsert * LSet * LTrim * LRange * LLen * LKeyExists * LValExists ### Hash * HSet * HSetNx * HGet * HGetAll * HDel * HExists * HLen * HKeys * HVals ### Set * SAdd * SPop * SIsMember * SRandMember * SRem * SMove * SCard * SMembers * SUnion * SDiff ### Zset * ZAdd * ZScore * ZCard * ZRank * ZRevRank * ZIncrBy * ZRange * ZRangeWithScores * ZRevRange * ZRevRangeWithScores * ZRem * ZGetByRank * ZRevGetByRank * ZScoreRange * ZRevScoreRange ## TODO + [x] Support expiration and TTL + [x] Add prefix scan and range scan for string type + [x] Cli for command line use + [x] Improve the performance of reopening db. + [x] Improve the performance of reclaim operation. + [ ] Support transaction, ACID features + [ ] Compress the written data + [ ] Add cache elimination strategy (Such as LRU, LFU, Random, etc...) + [ ] Improve related documents ## Benchmark ### Benchmark Environment * Go version：1.14.4 * System: macOS Catalina 10.15.7 * CPU: 2.6GHz 6-Core Intel Core i7 * Memory: 16 GB 2667 MHz DDR4 * The benchmark code: [rosedb-bench](https://github.com/roseduan/rosedb-bench) * The test databases I choose: * Badger * GoLevelDB * Pudge ### Benchmark Result **execute 100w times** ``` go test -bench=. -benchtime=1000000x badger 2021/05/16 21:59:53 INFO: All 0 tables opened in 0s badger 2021/05/16 21:59:53 INFO: Discard stats nextEmptySlot: 0 badger 2021/05/16 21:59:53 INFO: Set nextTxnTs to 0 goos: darwin goarch: amd64 pkg: rosedb-bench BenchmarkPutValue_BadgerDB-12 1000000 11518 ns/op 2110 B/op 46 allocs/op BenchmarkGetValue_BadgerDB-12 1000000 3547 ns/op 1172 B/op 20 allocs/op BenchmarkPutValue_GoLevelDB-12 1000000 4659 ns/op 352 B/op 9 allocs/op BenchmarkGetValue_GoLevelDB-12 1000000 2838 ns/op 814 B/op 13 allocs/op BenchmarkPutValue_Pudge-12 1000000 8512 ns/op 791 B/op 22 allocs/op BenchmarkGetValue_Pudge-12 1000000 1253 ns/op 200 B/op 6 allocs/op BenchmarkPutValue_RoseDB_KeyValRam-12 1000000 4371 ns/op 566 B/op 11 allocs/op BenchmarkGetValue_RoseDB_KeyValRam-12 1000000 481 ns/op 56 B/op 3 allocs/op BenchmarkPutValue_RoseDB_KeyOnlyRam-12 1000000 4255 ns/op 566 B/op 11 allocs/op BenchmarkGetValue_RoseDB_KeyOnlyRam-12 1000000 2986 ns/op 312 B/op 8 allocs/op PASS ok rosedb-bench 46.388s ``` **execute 250w times** ``` go test -bench=. -benchtime=2500000x badger 2021/05/16 22:06:08 INFO: All 0 tables opened in 0s badger 2021/05/16 22:06:08 INFO: Discard stats nextEmptySlot: 0 badger 2021/05/16 22:06:08 INFO: Set nextTxnTs to 0 goos: darwin goarch: amd64 pkg: rosedb-bench BenchmarkPutValue_BadgerDB-12 2500000 11660 ns/op 2150 B/op 46 allocs/op BenchmarkGetValue_BadgerDB-12 2500000 4180 ns/op 1222 B/op 21 allocs/op BenchmarkPutValue_GoLevelDB-12 2500000 4637 ns/op 336 B/op 9 allocs/op BenchmarkGetValue_GoLevelDB-12 2500000 2942 ns/op 817 B/op 14 allocs/op BenchmarkPutValue_Pudge-12 2500000 9238 ns/op 763 B/op 22 allocs/op BenchmarkGetValue_Pudge-12 2500000 1275 ns/op 200 B/op 6 allocs/op BenchmarkPutValue_RoseDB_KeyValRam-12 2500000 4474 ns/op 566 B/op 11 allocs/op BenchmarkGetValue_RoseDB_KeyValRam-12 2500000 525 ns/op 56 B/op 3 allocs/op BenchmarkPutValue_RoseDB_KeyOnlyRam-12 2500000 4294 ns/op 566 B/op 11 allocs/op BenchmarkGetValue_RoseDB_KeyOnlyRam-12 2500000 3038 ns/op 312 B/op 8 allocs/op PASS ok rosedb-bench 119.529s ``` ### Benchmark Conclusion **Badger** Its read and wirte performance are stable. Write: 11000+ ns/op. Read: 4000+ ns/op. **GoLevelDB** Its write performance is almost 2.5x faster than Badger, and its read performance is almost 3000 ns/op, a little faster than Badger. **Pudge** Its write performance is between GoLevelDB and Badger, almost 8500 ns/op, slower than GoLevelDB. Its read performance is very fast and stable, almost 2x faster than GoLevelDB. **RoseDB** Its write performance is stable, alomost the same as GoLevelDB, 2.5x faster than Badger. In KeyValueRamMode, since the values are all in memory, so it is the fastest of all. In KeyOnlyRamMode, it is almost the same as GoLevelDB. ## Contributing If you are intrested in contributing to rosedb, please see here: [CONTRIBUTING](https://github.com/roseduan/rosedb/blob/main/CONTRIBUTING.md) ## Contact me If you have any questions, you can contact me by email: roseduan520@gmail.com ## License rosedb is licensed under the term of the [MIT License](https://github.com/roseduan/rosedb/blob/main/LICENSE)