Skip to content

Commit

Permalink
Update Go version to 1.20 in go.mod
Browse files Browse the repository at this point in the history 
Refactor handleConn function in redis/server.go
Rename flushChanges function to save in store.go
Refactor Serve function in nodis.go
Update examples and benchmark in README.md
  • Loading branch information
@diiyw
diiyw committed Apr 23, 2024
1 parent c5b5ccf commit bedfe76
Show file tree
Hide file tree
Showing 11 changed files with 667 additions and 194 deletions.
46 changes: 45 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,12 @@ func main() {
n.LPush("list", []byte("value1"))
}
```
- Watch changes from remote `Server`
## Examples

<details>
<summary> Watch changes</summary>

Server:
```go
package main

Expand Down Expand Up @@ -135,8 +140,43 @@ func main() {
select {}
}
```
</details>
<details>
<summary> Simple Redis Server</summary>

```go
package main

import (
"fmt"
"net/http"

"github.com/diiyw/nodis"
)

func main() {
opt := nodis.DefaultOptions
n := nodis.Open(opt)
if err := n.Serve(":6380"); err != nil {
fmt.Printf("Serve() = %v", err)
}
}
```
You can use redis-cli to connect to the server.

```bash
redis-cli -p 6380
> set key value
```

</details>

## Benchmark
<details>
<summary>Embed benchmark</summary>

Windows 11: 12C/32G

```bash
goos: windows
goarch: amd64
Expand All @@ -152,7 +192,9 @@ BenchmarkZRank-12 11430135 104.1 ns/op 7 B/op 0 all
BenchmarkHSet-12 1341817 863.5 ns/op 743 B/op 11 allocs/op
BenchmarkHGet-12 9801158 105.9 ns/op 7 B/op 0 allocs/op
```

Linux VM: 4C/8GB

```bash
goos: linux
goarch: amd64
Expand All @@ -169,5 +211,7 @@ BenchmarkHSet-4 735676 1971 ns/op 742 B/op 11 allocs/o
BenchmarkHGet-4 4442625 243.4 ns/op 7 B/op 0 allocs/op
```

</details>

## Note
If you want to persist data, please make sure to call the `Close()` method when your application exits.
151 changes: 141 additions & 10 deletions README_zh-cn.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
<div class="column" align="left">
<a href="https://godoc.org/github.com/diiyw/nodis"><img src="https://godoc.org/github.com/diiyw/nodis?status.svg" /></a>
<a href="https://goreportcard.com/report/github.com/diiyw/nodis"><img src="https://goreportcard.com/badge/github.com/diiyw/nodis" /></a>
<a href="https://codecov.io/gh/diiyw/nodis"><img src="https://codecov.io/gh/diiyw/nodis/branch/master/graph/badge.svg?token=CupujOXpbe"/></a>
<a href="https://codecov.io/gh/diiyw/nodis"><img src="https://codecov.io/gh/diiyw/nodis/branch/main/graph/badge.svg?token=CupujOXpbe"/></a>
</div>


[English](https://github.com/diiyw/nodis/blob/main/README.md) | 简体中文
English | [简体中文](https://github.com/diiyw/nodis/blob/main/README_zh-cn.md)

Nodis 是使用GO语言实现的、简单可嵌入到应用中内存数据库。
使用GO实现的Redis协议的内存数据库，支持持久化，快照，WAL，自定义存储后端，WebAssembly等功能。

## 支持的类型

Expand All @@ -22,18 +22,41 @@ Nodis 是使用GO语言实现的、简单可嵌入到应用中内存数据库。

## 特点

- 快速可嵌入的
- 低内存使用，只有热数据才在内存中
- 快照和WAL存储的支持
- 支持自定义存储后端
- 通过Wasm运行在浏览器中
- 支持redis协议，可使用redis客户端连接
- 快速可嵌入的内存数据库
- 低内存占用，只存储热数据在内存
- 支持快照和WAL
- 支持自定义存储后端（例如S3，浏览器、Sqlite等）
- 支持WebAssembly运行在浏览器 (^v1.2.0)
- 支持远程观察变化 (^v1.2.0)
- 支持Redis协议 (^v1.5.0)

## Get Started
## 支持的Redis命令
| **Client Handling** | **Configuration** | **Key Commands** | **String Commands** | **Set Commands** | **Hash Commands** | **List Commands** | **Sorted Set Commands** |
|---------------------|-----------------|-----------------|---------------------|-----------------|-----------------|------------------|----------------|
| CLIENT | FLUSHALL | DEL | GET | SADD | HSET | LPUSH | ZADD |
| PING | FLUSHDB | EXISTS | SET | SSCAN | HGET | RPUSH | ZCARD |
| QUIT | SAVE | EXPIRE | INCR | SCARD | HDEL | LPOP | ZRANK |
| | INFO | EXPIREAT | DECR | SPOP | HLEN | RPOP | ZREVRANK |
| | | KEYS | SETBIT | SDIFF | HKEYS | LLEN | ZSCORE |
| | | TTL | GETBIT | SINTER | HEXISTS | LINDEX | ZINCRBY |
| | | RENAME | INCR | SISMEMBER | HGETALL | LINSERT | ZRANGE |
| | | TYPE | DESR | SMEMBERS | HINCRBY | LPUSHX | ZREVRANGE |
| | | SCAN | | SREM | HCRBYFLOAT | RPUSHX | ZRANGEBYSCORE |
| | | | | | HSETNX | LREM | ZREVRANGEBYSCORE |
| | | | | | HMGET | LSET | ZREM |
| | | | | | HMSET | LRANGE | ZREMRANGEBYRANK |
| | | | | | HCLEAR | LPOPRPUSH | ZREMRANGEBYSCORE |
| | | | | | HSCAN | RPOPLPUSH | ZCLEAR |
| | | | | | HVALS | | ZEXISTS |

## Get Started
```bash
go get github.com/diiyw/[email protected]
```
Or use test version
```bash
go get github.com/diiyw/nodis@main
```
```go
package main

Expand All @@ -48,8 +71,116 @@ func main() {
n.Set("key", []byte("value"))
n.LPush("list", []byte("value1"))
}
```
## Examples

<details>
<summary> Watch changes</summary>

Server:
```go
package main

import (
"fmt"
"github.com/diiyw/nodis"
"github.com/diiyw/nodis/pb"
"github.com/diiyw/nodis/sync"
"time"
)

func main() {
var opt = nodis.DefaultOptions
n := nodis.Open(opt)
opt.Synchronizer = sync.NewWebsocket()
n.Watch([]string{"*"}, func(op *pb.Operation) {
fmt.Println("Server:", op.Key, string(op.Value))
})
go func() {
for {
time.Sleep(time.Second)
n.Set("test", []byte(time.Now().Format("2006-01-02 15:04:05")))
}
}()
err := n.Publish("127.0.0.1:6380", []string{"*"})
if err != nil {
panic(err)
}
}
```
- Browser client built with WebAssembly

```bash
GOOS=js GOARCH=wasm go build -o test.wasm
```
```go
package main

import (
"fmt"
"github.com/diiyw/nodis"
"github.com/diiyw/nodis/fs"
"github.com/diiyw/nodis/pb"
"github.com/diiyw/nodis/sync"
)

func main() {
var opt = nodis.DefaultOptions
opt.Filesystem = &fs.Memory{}
opt.Synchronizer = sync.NewWebsocket()
n := nodis.Open(opt)
n.Watch([]string{"*"}, func(op *pb.Operation) {
fmt.Println("Subscribe: ", op.Key)
})
err := n.Subscribe("ws://127.0.0.1:6380")
if err != nil {
panic(err)
}
select {}
}
```
</details>

## Benchmark
<details>
<summary>Embed benchmark</summary>
Windows 11: 12C/32G

```bash
goos: windows
goarch: amd64
pkg: github.com/diiyw/nodis/bench
BenchmarkSet-12 1469863 715.9 ns/op 543 B/op 7 allocs/op
BenchmarkGet-12 12480278 96.47 ns/op 7 B/op 0 allocs/op
BenchmarkLPush-12 1484466 786.2 ns/op 615 B/op 9 allocs/op
BenchmarkLPop-12 77275986 15.10 ns/op 0 B/op 0 allocs/op
BenchmarkSAdd-12 1542252 831.9 ns/op 663 B/op 10 allocs/op
BenchmarkSMembers-12 12739020 95.18 ns/op 8 B/op 1 allocs/op
BenchmarkZAdd-12 1000000 1177 ns/op 550 B/op 10 allocs/op
BenchmarkZRank-12 11430135 104.1 ns/op 7 B/op 0 allocs/op
BenchmarkHSet-12 1341817 863.5 ns/op 743 B/op 11 allocs/op
BenchmarkHGet-12 9801158 105.9 ns/op 7 B/op 0 allocs/op
```

Linux VM: 4C/8GB

```bash
goos: linux
goarch: amd64
pkg: github.com/diiyw/nodis/bench
BenchmarkSet-4 806912 1658 ns/op 543 B/op 7 allocs/op
BenchmarkGet-4 5941904 190.6 ns/op 7 B/op 0 allocs/op
BenchmarkLPush-4 852932 1757 ns/op 615 B/op 9 allocs/op
BenchmarkLPop-4 40668902 27.22 ns/op 0 B/op 0 allocs/op
BenchmarkSAdd-4 706376 1913 ns/op 662 B/op 10 allocs/op
BenchmarkSMembers-4 4819993 208.1 ns/op 8 B/op 1 allocs/op
BenchmarkZAdd-4 729039 2013 ns/op 550 B/op 10 allocs/op
BenchmarkZRank-4 4959448 246.4 ns/op 7 B/op 0 allocs/op
BenchmarkHSet-4 735676 1971 ns/op 742 B/op 11 allocs/op
BenchmarkHGet-4 4442625 243.4 ns/op 7 B/op 0 allocs/op
```

</details>

## Note

Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module github.com/diiyw/nodis

go 1.19
go 1.20

require (
github.com/gorilla/websocket v1.5.1
Expand Down
Loading

0 comments on commit bedfe76

Please sign in to comment.