mredis

Documentation

Index

• Constants
• func NewRedisClient(opts ...RedisOption) (*redis.Client, error)
• func NewRedisClusterClient(opts ...ClusterOption) (*redis.ClusterClient, error)
• type Client
  • func NewClient(opts ...Option) (Client, error)
• type ClusterOption
• type Option
  • func SetAddrs(addrs []string) Option
  • func SetAuth(username, password string) Option
  • func SetMinIdleConns(minIdle int) Option
  • func SetPoolSize(poolSize int) Option
  • func SetReadTimeout(readTimeout time.Duration) Option
  • func SetTLSConfig(tlsConfig *tls.Config) Option
  • func SetWriteTimeout(writeTimeout time.Duration) Option
• type Options
• type RedisOption

Constants

const (
	ModeCluster = "cluster"
	ModeSingle  = "single"
)

Functions

func NewRedisClient

func NewRedisClient(opts ...RedisOption) (*redis.Client, error)

func NewRedisClusterClient

func NewRedisClusterClient(opts ...ClusterOption) (*redis.ClusterClient, error)

Types

type Client

type Client interface {
	redis.Cmdable
}

func NewClient

func NewClient(opts ...Option) (Client, error)

type ClusterOption

type ClusterOption func(cfg *redis.ClusterOptions)

type Option

type Option func(cfg *Options)

func SetAddrs

func SetAddrs(addrs []string) Option

func SetAuth

func SetAuth(username, password string) Option

func SetMinIdleConns

func SetMinIdleConns(minIdle int) Option

func SetPoolSize

func SetPoolSize(poolSize int) Option

func SetReadTimeout

func SetReadTimeout(readTimeout time.Duration) Option

func SetTLSConfig

func SetTLSConfig(tlsConfig *tls.Config) Option

func SetWriteTimeout

func SetWriteTimeout(writeTimeout time.Duration) Option

type Options

type Options struct {
	Addrs        []string
	Username     string
	Password     string
	Mode         string
	ReadTimeout  time.Duration
	WriteTimeout time.Duration
	PoolSize     int
	MinIdleConns int
	TLSConfig    *tls.Config
}

type RedisOption

type RedisOption func(cfg *redis.Options)