gitea/vendor/github.com/go-redis/redis/v8
6543 86e2789960
Vendor Update (#16121)
* update github.com/PuerkitoBio/goquery

* update github.com/alecthomas/chroma

* update github.com/blevesearch/bleve/v2

* update github.com/caddyserver/certmagic

* update github.com/go-enry/go-enry/v2

* update github.com/go-git/go-billy/v5

* update github.com/go-git/go-git/v5

* update github.com/go-redis/redis/v8

* update github.com/go-testfixtures/testfixtures/v3

* update github.com/jaytaylor/html2text

* update github.com/json-iterator/go

* update github.com/klauspost/compress

* update github.com/markbates/goth

* update github.com/mattn/go-isatty

* update github.com/mholt/archiver/v3

* update github.com/microcosm-cc/bluemonday

* update github.com/minio/minio-go/v7

* update github.com/prometheus/client_golang

* update github.com/unrolled/render

* update github.com/xanzy/go-gitlab

* update github.com/yuin/goldmark

* update github.com/yuin/goldmark-highlighting

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-06-10 16:44:25 +02:00
..
internal Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
.gitignore [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
.golangci.yml [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
.prettierrc [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
CHANGELOG.md Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
LICENSE [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
Makefile [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
README.md Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
cluster.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
cluster_commands.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
command.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
commands.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
doc.go [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
error.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
go.mod Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
go.sum Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
iterator.go [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
options.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
pipeline.go [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
pubsub.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
redis.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
result.go [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
ring.go [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
script.go [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
sentinel.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
tx.go [Vendor] Update go-redis to v8.5.0 (#13749) 2021-02-10 21:28:32 +00:00
universal.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00

README.md

All-in-one tool to optimize performance and monitor errors & logs

Redis client for Golang

build workflow PkgGoDev Documentation Chat

Ecosystem

Features

Installation

go-redis supports 2 last Go versions and requires a Go version with modules support. So make sure to initialize a Go module:

go mod init github.com/my/repo

And then install go-redis/v8 (note v8 in the import; omitting it is a popular mistake):

go get github.com/go-redis/redis/v8

Quickstart

import (
    "context"
    "github.com/go-redis/redis/v8"
)

var ctx = context.Background()

func ExampleClient() {
    rdb := redis.NewClient(&redis.Options{
        Addr:     "localhost:6379",
        Password: "", // no password set
        DB:       0,  // use default DB
    })

    err := rdb.Set(ctx, "key", "value", 0).Err()
    if err != nil {
        panic(err)
    }

    val, err := rdb.Get(ctx, "key").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println("key", val)

    val2, err := rdb.Get(ctx, "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
}

Look and feel

Some corner cases:

// SET key value EX 10 NX
set, err := rdb.SetNX(ctx, "key", "value", 10*time.Second).Result()

// SET key value keepttl NX
set, err := rdb.SetNX(ctx, "key", "value", redis.KeepTTL).Result()

// SORT list LIMIT 0 2 ASC
vals, err := rdb.Sort(ctx, "list", &redis.Sort{Offset: 0, Count: 2, Order: "ASC"}).Result()

// ZRANGEBYSCORE zset -inf +inf WITHSCORES LIMIT 0 2
vals, err := rdb.ZRangeByScoreWithScores(ctx, "zset", &redis.ZRangeBy{
    Min: "-inf",
    Max: "+inf",
    Offset: 0,
    Count: 2,
}).Result()

// ZINTERSTORE out 2 zset1 zset2 WEIGHTS 2 3 AGGREGATE SUM
vals, err := rdb.ZInterStore(ctx, "out", &redis.ZStore{
    Keys: []string{"zset1", "zset2"},
    Weights: []int64{2, 3}
}).Result()

// EVAL "return {KEYS[1],ARGV[1]}" 1 "key" "hello"
vals, err := rdb.Eval(ctx, "return {KEYS[1],ARGV[1]}", []string{"key"}, "hello").Result()

// custom command
res, err := rdb.Do(ctx, "set", "key", "value").Result()

Run the test

go-redis will start a redis-server and run the test cases.

The paths of redis-server bin file and redis config file are defined in main_test.go:

var (
	redisServerBin, _  = filepath.Abs(filepath.Join("testdata", "redis", "src", "redis-server"))
	redisServerConf, _ = filepath.Abs(filepath.Join("testdata", "redis", "redis.conf"))
)

For local testing, you can change the variables to refer to your local files, or create a soft link to the corresponding folder for redis-server and copy the config file to testdata/redis/:

ln -s /usr/bin/redis-server ./go-redis/testdata/redis/src
cp ./go-redis/testdata/redis.conf ./go-redis/testdata/redis/

Lastly, run:

go test

See also