src: Add DMA localagent

[barometer.git] / src / dma / vendor / github.com / go-redis / redis / README.md

diff --git a/src/dma/vendor/github.com/go-redis/redis/README.md b/src/dma/vendor/github.com/go-redis/redis/README.md
new file mode 100644 (file)
index 0000000..7d05b44
--- /dev/null
+++ b/src/dma/vendor/github.com/go-redis/redis/README.md
@@ -0,0 +1,146 @@
+# Redis client for Golang
+
+[![Build Status](https://travis-ci.org/go-redis/redis.png?branch=master)](https://travis-ci.org/go-redis/redis)
+[![GoDoc](https://godoc.org/github.com/go-redis/redis?status.svg)](https://godoc.org/github.com/go-redis/redis)
+[![Airbrake](https://img.shields.io/badge/kudos-airbrake.io-orange.svg)](https://airbrake.io)
+
+Supports:
+
+- Redis 3 commands except QUIT, MONITOR, SLOWLOG and SYNC.
+- Automatic connection pooling with [circuit breaker](https://en.wikipedia.org/wiki/Circuit_breaker_design_pattern) support.
+- [Pub/Sub](https://godoc.org/github.com/go-redis/redis#PubSub).
+- [Transactions](https://godoc.org/github.com/go-redis/redis#Multi).
+- [Pipeline](https://godoc.org/github.com/go-redis/redis#example-Client-Pipeline) and [TxPipeline](https://godoc.org/github.com/go-redis/redis#example-Client-TxPipeline).
+- [Scripting](https://godoc.org/github.com/go-redis/redis#Script).
+- [Timeouts](https://godoc.org/github.com/go-redis/redis#Options).
+- [Redis Sentinel](https://godoc.org/github.com/go-redis/redis#NewFailoverClient).
+- [Redis Cluster](https://godoc.org/github.com/go-redis/redis#NewClusterClient).
+- [Cluster of Redis Servers](https://godoc.org/github.com/go-redis/redis#example-NewClusterClient--ManualSetup) without using cluster mode and Redis Sentinel.
+- [Ring](https://godoc.org/github.com/go-redis/redis#NewRing).
+- [Instrumentation](https://godoc.org/github.com/go-redis/redis#ex-package--Instrumentation).
+- [Cache friendly](https://github.com/go-redis/cache).
+- [Rate limiting](https://github.com/go-redis/redis_rate).
+- [Distributed Locks](https://github.com/bsm/redis-lock).
+
+API docs: https://godoc.org/github.com/go-redis/redis.
+Examples: https://godoc.org/github.com/go-redis/redis#pkg-examples.
+
+## Installation
+
+Install:
+
+```shell
+go get -u github.com/go-redis/redis
+```
+
+Import:
+
+```go
+import "github.com/go-redis/redis"
+```
+
+## Quickstart
+
+```go
+func ExampleNewClient() {
+       client := redis.NewClient(&redis.Options{
+               Addr:     "localhost:6379",
+               Password: "", // no password set
+               DB:       0,  // use default DB
+       })
+
+       pong, err := client.Ping().Result()
+       fmt.Println(pong, err)
+       // Output: PONG <nil>
+}
+
+func ExampleClient() {
+       err := client.Set("key", "value", 0).Err()
+       if err != nil {
+               panic(err)
+       }
+
+       val, err := client.Get("key").Result()
+       if err != nil {
+               panic(err)
+       }
+       fmt.Println("key", val)
+
+       val2, err := client.Get("key2").Result()
+       if err == redis.Nil {
+               fmt.Println("key2 does not exist")
+       } else if err != nil {
+               panic(err)
+       } else {
+               fmt.Println("key2", val2)
+       }
+       // Output: key value
+       // key2 does not exist
+}
+```
+
+## Howto
+
+Please go through [examples](https://godoc.org/github.com/go-redis/redis#pkg-examples) to get an idea how to use this package.
+
+## Look and feel
+
+Some corner cases:
+
+```go
+// SET key value EX 10 NX
+set, err := client.SetNX("key", "value", 10*time.Second).Result()
+
+// SORT list LIMIT 0 2 ASC
+vals, err := client.Sort("list", redis.Sort{Offset: 0, Count: 2, Order: "ASC"}).Result()
+
+// ZRANGEBYSCORE zset -inf +inf WITHSCORES LIMIT 0 2
+vals, err := client.ZRangeByScoreWithScores("zset", redis.ZRangeBy{
+       Min: "-inf",
+       Max: "+inf",
+       Offset: 0,
+       Count: 2,
+}).Result()
+
+// ZINTERSTORE out 2 zset1 zset2 WEIGHTS 2 3 AGGREGATE SUM
+vals, err := client.ZInterStore("out", redis.ZStore{Weights: []int64{2, 3}}, "zset1", "zset2").Result()
+
+// EVAL "return {KEYS[1],ARGV[1]}" 1 "key" "hello"
+vals, err := client.Eval("return {KEYS[1],ARGV[1]}", []string{"key"}, "hello").Result()
+```
+
+## Benchmark
+
+go-redis vs redigo:
+
+```
+BenchmarkSetGoRedis10Conns64Bytes-4      200000              7621 ns/op             210 B/op          6 allocs/op
+BenchmarkSetGoRedis100Conns64Bytes-4     200000              7554 ns/op             210 B/op          6 allocs/op
+BenchmarkSetGoRedis10Conns1KB-4          200000              7697 ns/op             210 B/op          6 allocs/op
+BenchmarkSetGoRedis100Conns1KB-4         200000              7688 ns/op             210 B/op          6 allocs/op
+BenchmarkSetGoRedis10Conns10KB-4         200000              9214 ns/op             210 B/op          6 allocs/op
+BenchmarkSetGoRedis100Conns10KB-4        200000              9181 ns/op             210 B/op          6 allocs/op
+BenchmarkSetGoRedis10Conns1MB-4            2000            583242 ns/op            2337 B/op          6 allocs/op
+BenchmarkSetGoRedis100Conns1MB-4           2000            583089 ns/op            2338 B/op          6 allocs/op
+BenchmarkSetRedigo10Conns64Bytes-4       200000              7576 ns/op             208 B/op          7 allocs/op
+BenchmarkSetRedigo100Conns64Bytes-4      200000              7782 ns/op             208 B/op          7 allocs/op
+BenchmarkSetRedigo10Conns1KB-4           200000              7958 ns/op             208 B/op          7 allocs/op
+BenchmarkSetRedigo100Conns1KB-4          200000              7725 ns/op             208 B/op          7 allocs/op
+BenchmarkSetRedigo10Conns10KB-4          100000             18442 ns/op             208 B/op          7 allocs/op
+BenchmarkSetRedigo100Conns10KB-4         100000             18818 ns/op             208 B/op          7 allocs/op
+BenchmarkSetRedigo10Conns1MB-4             2000            668829 ns/op             226 B/op          7 allocs/op
+BenchmarkSetRedigo100Conns1MB-4            2000            679542 ns/op             226 B/op          7 allocs/op
+```
+
+Redis Cluster:
+
+```
+BenchmarkRedisPing-4                     200000              6983 ns/op             116 B/op          4 allocs/op
+BenchmarkRedisClusterPing-4              100000             11535 ns/op             117 B/op          4 allocs/op
+```
+
+## See also
+
+- [Golang PostgreSQL ORM](https://github.com/go-pg/pg)
+- [Golang msgpack](https://github.com/vmihailenco/msgpack)
+- [Golang message task queue](https://github.com/go-msgqueue/msgqueue)