Repository files navigation

go-redis is the official Redis client library for the Go programming language. It offers a straightforward interface for interacting with Redis servers.

Ingo-redis we are aiming to support the last three releases of Redis. Currently, this means we do support:

• Redis 7.2 - using Redis Stack 7.2 for modules support
• Redis 7.4 - using Redis Stack 7.4 for modules support
• Redis 8.0 - using Redis CE 8.0 where modules are included

Although thego.mod states it requires at minimumgo 1.18, our CI is configured to run the tests against all threeversions of Redis and latest two versions of Go (1.23,1.24). We observe that some modules related test may not pass withRedis Stack 7.2 and some commands are changed with Redis CE 8.0.Please do refer to the documentation and the tests if you experience any issues. We do plan to update the go versionin thego.mod togo 1.24 in one of the next releases.

Learn for free at Redis University

Build faster with the Redis Launchpad

Try the Redis Cloud

Dive in developer tutorials

Join the Redis community

Work at Redis

• English
• 简体中文

• Discussions
• Chat
• Reference
• Examples

• Redis Mock
• Distributed Locks
• Redis Cache
• Rate limiting

This client also works withKvrocks, a distributedkey value NoSQL database that uses RocksDB as storage engine and is compatible with Redis protocol.

• Redis commands except QUIT and SYNC.
• Automatic connection pooling.
• StreamingCredentialsProvider (e.g. entra id, oauth) (experimental)
• Pub/Sub.
• Pipelines and transactions.
• Scripting.
• Redis Sentinel.
• Redis Cluster.
• Redis Ring.
• Redis Performance Monitoring.
• Redis Probabilistic [RedisStack]

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

go mod init github.com/my/repo

Then install go-redis/v9:

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

import ("context""fmt""github.com/redis/go-redis/v9")varctx=context.Background()funcExampleClient() {rdb:=redis.NewClient(&redis.Options{Addr:"localhost:6379",Password:"",// no password setDB:0,// use default DB    })err:=rdb.Set(ctx,"key","value",0).Err()iferr!=nil {panic(err)    }val,err:=rdb.Get(ctx,"key").Result()iferr!=nil {panic(err)    }fmt.Println("key",val)val2,err:=rdb.Get(ctx,"key2").Result()iferr==redis.Nil {fmt.Println("key2 does not exist")    }elseiferr!=nil {panic(err)    }else {fmt.Println("key2",val2)    }// Output: key value// key2 does not exist}

The Redis client supports multiple ways to provide authentication credentials, with a clear priority order. Here are the available options:

The streaming credentials provider allows for dynamic credential updates during the connection lifetime. This is particularly useful for managed identity services and token-based authentication.

typeStreamingCredentialsProviderinterface {Subscribe(listenerCredentialsListener) (Credentials,UnsubscribeFunc,error)}typeCredentialsListenerinterface {OnNext(credentialsCredentials)// Called when credentials are updatedOnError(errerror)// Called when an error occurs}typeCredentialsinterface {BasicAuth() (usernamestring,passwordstring)RawCredentials()string}

Example usage:

rdb:=redis.NewClient(&redis.Options{Addr:"localhost:6379",StreamingCredentialsProvider:&MyCredentialsProvider{},})

Note: The streaming credentials provider can be used withgo-redis-entraid to enable Entra ID (formerly Azure AD) authentication. This allows for seamless integration with Azure's managed identity services and token-based authentication.

Example with Entra ID:

import ("github.com/redis/go-redis/v9""github.com/redis/go-redis-entraid")// Create an Entra ID credentials providerprovider:=entraid.NewDefaultAzureIdentityProvider()// Configure Redis client with Entra ID authenticationrdb:=redis.NewClient(&redis.Options{Addr:"your-redis-server.redis.cache.windows.net:6380",StreamingCredentialsProvider:provider,TLSConfig:&tls.Config{MinVersion:tls.VersionTLS12,    },})

The context-based provider allows credentials to be determined at the time of each operation, using the context.

rdb:=redis.NewClient(&redis.Options{Addr:"localhost:6379",CredentialsProviderContext:func(ctx context.Context) (string,string,error) {// Return username, password, and any errorreturn"user","pass",nil    },})

A simple function-based provider that returns static credentials.

rdb:=redis.NewClient(&redis.Options{Addr:"localhost:6379",CredentialsProvider:func() (string,string) {// Return username and passwordreturn"user","pass"    },})

The most basic way to provide credentials is through theUsername andPassword fields in the options.

rdb:=redis.NewClient(&redis.Options{Addr:"localhost:6379",Username:"user",Password:"pass",})

The client will use credentials in the following priority order:

1. Streaming Credentials Provider (if set)
2. Context-based Credentials Provider (if set)
3. Regular Credentials Provider (if set)
4. Username/Password fields (if set)

If none of these are set, the client will attempt to connect without authentication.

The client supports both RESP2 and RESP3 protocols. You can specify the protocol version in the options:

rdb:=redis.NewClient(&redis.Options{Addr:"localhost:6379",Password:"",// no password setDB:0,// use default DBProtocol:3,// specify 2 for RESP 2 or 3 for RESP 3})

go-redis also supports connecting via theredis uri specification.The example below demonstrates how the connection can easily be configured using a string, adheringto this specification.

import ("github.com/redis/go-redis/v9")funcExampleClient()*redis.Client {url:="redis://user:password@localhost:6379/0?protocol=3"opts,err:=redis.ParseURL(url)iferr!=nil {panic(err)    }returnredis.NewClient(opts)}

import ("github.com/redis/go-redis/v9""github.com/redis/go-redis/extra/redisotel/v9""errors")funcmain() {...rdb:=redis.NewClient(&redis.Options{...})iferr:=errors.Join(redisotel.InstrumentTracing(rdb),redisotel.InstrumentMetrics(rdb));err!=nil {log.Fatal(err)    }

go-redis supports extending the client identification phase to allow projects to send their own custom client identification.

By default, go-redis automatically sends the client library name and version during the connection process. This feature is available in redis-server as of version 7.2. As a result, the command is "fire and forget", meaning it should fail silently, in the case that the redis server does not support this feature.

When connection identity verification is not required or needs to be explicitly disabled, aDisableIdentity configuration option exists.Initially there was a typo and the option was namedDisableIndentity instead ofDisableIdentity. The misspelled option is marked as Deprecated and will be removed in V10 of this library.Although both options will work at the moment, the correct option isDisableIdentity. The deprecated option will be removed in V10 of this library, so please use the correct option name to avoid any issues.

To disable verification, set theDisableIdentity option totrue in the Redis client options:

rdb:=redis.NewClient(&redis.Options{Addr:"localhost:6379",Password:"",DB:0,DisableIdentity:true,// Disable set-info on connect})

When integrating Redis with application functionalities using RESP3, it's important to note that some response structures aren't final yet. This is especially true for more complex structures like search and query results. We recommend using RESP2 when using the search and query capabilities, but we plan to stabilize the RESP3-based API-s in the coming versions. You can find more guidance in the upcoming release notes.

To enable unstable RESP3, set the option in your client configuration:

redis.NewClient(&redis.Options{UnstableResp3:true,})

Note: When UnstableResp3 mode is enabled, it's necessary to use RawResult() and RawVal() to retrieve a raw data.Since, raw response is the only option for unstable search commands Val() and Result() calls wouldn't have any affect on them:

res1,err:=client.FTSearchWithArgs(ctx,"txt","foo bar",&redis.FTSearchOptions{}).RawResult()val1:=client.FTSearchWithArgs(ctx,"txt","foo bar",&redis.FTSearchOptions{}).RawVal()

In the Redis-Search module,the default dialect is 2. If needed, you can explicitly specify a different dialect using the appropriate configuration in your queries.

Important: Be aware that the query dialect may impact the results returned. If needed, you can revert to a different dialect version by passing the desired dialect in the arguments of the command you want to execute.For example:

res2, err := rdb.FTSearchWithArgs(ctx,"idx:bicycle","@pickup_zone:[CONTAINS $bike]",&redis.FTSearchOptions{Params: map[string]interface{}{"bike": "POINT(-0.1278 51.5074)",},DialectVersion: 3,},).Result()

You can find further details in thequery dialect documentation.

We welcome contributions to the go-redis library! If you have a bug fix, feature request, or improvement, please open an issue or pull request on GitHub.We appreciate your help in making go-redis better for everyone.If you are interested in contributing to the go-redis library, please check out ourcontributing guidelines for more information on how to get started.

Some corner cases:

// SET key value EX 10 NXset,err:=rdb.SetNX(ctx,"key","value",10*time.Second).Result()// SET key value keepttl NXset,err:=rdb.SetNX(ctx,"key","value",redis.KeepTTL).Result()// SORT list LIMIT 0 2 ASCvals,err:=rdb.Sort(ctx,"list",&redis.Sort{Offset:0,Count:2,Order:"ASC"}).Result()// ZRANGEBYSCORE zset -inf +inf WITHSCORES LIMIT 0 2vals,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 SUMvals,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 commandres,err:=rdb.Do(ctx,"set","key","value").Result()

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 inmain_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 linkto the corresponding folder for redis-server and copy the config file totestdata/redis/:

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

Lastly, run:

gotest

Another option is to run your specific tests with an already running redis. The example below, testsagainst a redis running on port 9999.:

REDIS_PORT=9999 gotest<your options>

• Golang ORM for PostgreSQL, MySQL, MSSQL, and SQLite
• Golang PostgreSQL
• Golang HTTP router
• Golang ClickHouse ORM

The go-redis project was originally initiated by ⭐uptrace/uptrace.Uptrace is an open-source APM tool that supports distributed tracing, metrics, and logs. You canuse it to monitor applications and set up automatic alerts to receive notifications via email,Slack, Telegram, and others.

SeeOpenTelemetry example whichdemonstrates how you can use Uptrace to monitor go-redis.

Thanks to all the people who already contributed!