README
¶
goredis
goredis library wrapped in go-redis.
Example of use
Single Redis
// way 1: redis version 6.0 or above
redisCli, err := goredis.Init("default:123456@127.0.0.1:6379", goredis.WithEnableTrace())
if err != nil {
panic("goredis.Init error: " + err.Error())
}
// way 2: redis version 5.0 or below
redisCli := goredis.Init2("127.0.0.1:6379", "123456", 0, goredis.WithEnableTrace())
Sentinel
addrs := []string{"127.0.0.1:6380", "127.0.0.1:6381", "127.0.0.1:6382"}
rdb := InitSentinel("master", addrs, "default", "123456", goredis.WithEnableTrace())
Cluster
addrs := []string{"127.0.0.1:6380", "127.0.0.1:6381", "127.0.0.1:6382"}
clusterRdb := InitCluster(addrs, "default", "123456", goredis.WithEnableTrace())
Official Documents https://redis.uptrace.dev/zh/guide/go-redis.html
Documentation
¶
Overview ¶
Package goredis is a library wrapped on top of github.com/go-redis/redis.
Index ¶
- Constants
- func Init(dsn string, opts ...Option) (*redis.Client, error)
- func Init2(addr string, password string, db int, opts ...Option) *redis.Client
- func InitCluster(addrs []string, username string, password string, opts ...Option) *redis.ClusterClient
- func InitSentinel(masterName string, addrs []string, username string, password string, ...) *redis.Client
- type Option
Constants ¶
View Source
const ( // ErrRedisNotFound not exist in redis ErrRedisNotFound = redis.Nil // DefaultRedisName default redis name DefaultRedisName = "default" )
Variables ¶
This section is empty.
Functions ¶
func Init ¶
Init connecting to redis dsn supported formats. (1) no password, no db: localhost:6379 (2) with password and db: <user>:<pass>@localhost:6379/2 (3) redis://default:123456@localhost:6379/0?max_retries=3 for more parameters see the redis source code for the setupConnParams function
Types ¶
type Option ¶
type Option func(*options)
Option set the redis options.
func WithDialTimeout ¶
WithDialTimeout set dail timeout
func WithReadTimeout ¶
WithReadTimeout set read timeout
func WithWriteTimeout ¶
WithWriteTimeout set write timeout
Source Files
Click to show internal directories.
Click to hide internal directories.