redcon/README.md

175 lines
4.1 KiB
Markdown
Raw Normal View History

2016-08-20 20:23:11 +03:00
<p align="center">
<img
src="logo.png"
width="336" height="75" border="0" alt="REDCON">
<br>
<a href="https://travis-ci.org/tidwall/redcon"><img src="https://img.shields.io/travis/tidwall/redcon.svg?style=flat-square" alt="Build Status"></a>
<a href="https://godoc.org/github.com/tidwall/redcon"><img src="https://img.shields.io/badge/api-reference-blue.svg?style=flat-square" alt="GoDoc"></a>
</p>
2016-07-28 17:54:02 +03:00
2016-08-20 20:23:11 +03:00
<p align="center">Fast Redis server implementation for Go</a></p>
2016-08-20 21:30:29 +03:00
Redcon is a Redis server implementation for Go that is fast and simple to use. The reason for this library it to give an efficient server front-end for the [BuntDB](https://github.com/tidwall/buntdb) and [Tile38](https://github.com/tidwall/tile38) projects.
2016-08-20 20:23:11 +03:00
Features
--------
2016-08-20 21:30:29 +03:00
- Create a [Fast](#benchmarks) custom Redis compatible server in Go
2016-08-20 21:23:34 +03:00
- Simple interface. One function `ListenAndServe` and one type `Conn`
- Support for pipelining and telnet commands
2016-08-20 20:23:11 +03:00
- Works with Redis clients such as [redigo](https://github.com/garyburd/redigo), [redis-py](https://github.com/andymccurdy/redis-py), [node_redis](https://github.com/NodeRedis/node_redis), and [jedis](https://github.com/xetorthio/jedis)
2016-08-20 21:23:34 +03:00
2016-07-28 17:54:02 +03:00
2016-07-28 20:43:10 +03:00
Installing
----------
```
2016-08-20 20:23:11 +03:00
go get -u github.com/tidwall/redcon
2016-07-28 20:43:10 +03:00
```
Example
-------
2016-07-28 17:54:02 +03:00
Here's a full example of a Redis clone that accepts:
- SET key value
- GET key
- DEL key
- PING
- QUIT
You can run this example from a terminal:
```sh
2016-08-20 21:34:06 +03:00
go run example/clone.go
2016-07-28 17:54:02 +03:00
```
```go
package main
import (
"log"
"strings"
"sync"
"github.com/tidwall/redcon"
)
var addr = ":6380"
func main() {
var mu sync.RWMutex
var items = make(map[string]string)
go log.Printf("started server at %s", addr)
err := redcon.ListenAndServe(addr,
func(conn redcon.Conn, commands [][]string) {
for _, args := range commands {
switch strings.ToLower(args[0]) {
default:
conn.WriteError("ERR unknown command '" + args[0] + "'")
case "ping":
conn.WriteString("PONG")
case "quit":
conn.WriteString("OK")
conn.Close()
case "set":
if len(args) != 3 {
conn.WriteError("ERR wrong number of arguments for '" + args[0] + "' command")
continue
}
mu.Lock()
items[args[1]] = args[2]
mu.Unlock()
conn.WriteString("OK")
case "get":
if len(args) != 2 {
conn.WriteError("ERR wrong number of arguments for '" + args[0] + "' command")
continue
}
mu.RLock()
val, ok := items[args[1]]
mu.RUnlock()
if !ok {
conn.WriteNull()
} else {
conn.WriteBulk(val)
}
case "del":
if len(args) != 2 {
conn.WriteError("ERR wrong number of arguments for '" + args[0] + "' command")
continue
}
mu.Lock()
_, ok := items[args[1]]
delete(items, args[1])
mu.Unlock()
if !ok {
conn.WriteInt(0)
} else {
conn.WriteInt(1)
}
}
}
},
func(conn redcon.Conn) bool {
2016-08-16 15:51:20 +03:00
// use this function to accept or deny the connection.
// log.Printf("accept: %s", conn.RemoteAddr())
2016-07-28 17:54:02 +03:00
return true
},
func(conn redcon.Conn, err error) {
2016-08-16 15:51:20 +03:00
// this is called when the connection has been closed
// log.Printf("closed: %s, err: %v", conn.RemoteAddr(), err)
2016-07-28 17:54:02 +03:00
},
)
if err != nil {
log.Fatal(err)
}
}
```
2016-08-20 21:23:34 +03:00
Benchmarks
----------
**Redis**: Single-threaded, no disk persistence.
2016-08-20 21:45:35 +03:00
```
$ redis-server --port 6379 --appendonly no
```
2016-08-20 21:23:34 +03:00
```
redis-benchmark -p 6379 -t set,get -n 10000000 -q -P 512 -c 512
SET: 941265.12 requests per second
GET: 1189909.50 requests per second
```
**Redcon**: Single-threaded, no disk persistence.
2016-08-20 21:45:35 +03:00
```
$ GOMAXPROCS=1 go run example/clone.go
```
2016-08-20 21:23:34 +03:00
```
redis-benchmark -p 6380 -t set,get -n 10000000 -q -P 512 -c 512
SET: 1320655.00 requests per second
2016-08-20 21:35:57 +03:00
GET: 1552354.25 requests per second
2016-08-20 21:23:34 +03:00
```
**Redcon**: Multi-threaded, no disk persistence.
```
2016-08-20 21:45:35 +03:00
$ GOMAXPROCS=0 go run example/clone.go
```
```
$ redis-benchmark -p 6380 -t set,get -n 10000000 -q -P 512 -c 512
2016-08-20 21:23:34 +03:00
SET: 2740477.00 requests per second
GET: 3210272.75 requests per second
```
2016-08-20 21:31:28 +03:00
*Running on a MacBook Pro 15" 2.8 GHz Intel Core i7 using Go 1.7*
2016-08-20 21:23:34 +03:00
2016-07-28 17:54:02 +03:00
Contact
-------
Josh Baker [@tidwall](http://twitter.com/tidwall)
License
-------
Redcon source code is available under the MIT [License](/LICENSE).