bzredis

README

bzredis

Documentation

Index

• func Init(mo MapStringOptions)
• func InitAndPing(ctx context.Context, mo MapStringOptions) error
• type MapStringOptions
• type Options
  • func DefaultOptions() *Options
  • func (c *Options) RedisOptions() *redis.Options
  • func (o *Options) WithAddr(addr string) *Options
  • func (o *Options) WithDB(db int) *Options
  • func (o *Options) WithDialTimeout(dialTimeout time.Duration) *Options
  • func (o *Options) WithMaxRetries(maxRetries int) *Options
  • func (o *Options) WithMinIdleConns(minIdleConns int) *Options
  • func (o *Options) WithPassword(password string) *Options
  • func (o *Options) WithPoolSize(poolSize int) *Options
  • func (o *Options) WithReadTimeout(readTimeout time.Duration) *Options
  • func (o *Options) WithWriteTimeout(writeTimeout time.Duration) *Options
• type Redis
  • func GetRedis(name string) (*Redis, error)
  • func NewRedis(opt RedisOptions) *Redis
  • func NewRedisPing(ctx context.Context, opt RedisOptions) (*Redis, error)
• type RedisOptions

Functions

func Init

func Init(mo MapStringOptions)

func InitAndPing

func InitAndPing(ctx context.Context, mo MapStringOptions) error

Types

type MapStringOptions

type MapStringOptions map[string]*Options

type Options

type Options struct {
	Addr     string `json:"addr" yaml:"addr"`
	Password string `json:"password" yaml:"password"`
	DB       int    `json:"db" yaml:"db"`

	DialTimeout  time.Duration `json:"dial_timeout" yaml:"dial_timeout"`
	ReadTimeout  time.Duration `json:"read_timeout" yaml:"read_timeout"`
	WriteTimeout time.Duration `json:"write_timeout" yaml:"write_timeout"`
	MaxRetries   int           `json:"max_retries" yaml:"max_retries"`
	PoolSize     int           `json:"pool_size" yaml:"pool_size"`
	MinIdleConns int           `json:"min_idle_conns" yaml:"min_idle_conns"`
}

func DefaultOptions

func DefaultOptions() *Options

func (*Options) RedisOptions

func (c *Options) RedisOptions() *redis.Options

RedisOptions 转换为 redis.Options

func (*Options) WithAddr

func (o *Options) WithAddr(addr string) *Options

func (*Options) WithDB

func (o *Options) WithDB(db int) *Options

func (*Options) WithDialTimeout

func (o *Options) WithDialTimeout(dialTimeout time.Duration) *Options

func (*Options) WithMaxRetries

func (o *Options) WithMaxRetries(maxRetries int) *Options

func (*Options) WithMinIdleConns

func (o *Options) WithMinIdleConns(minIdleConns int) *Options

func (*Options) WithPassword

func (o *Options) WithPassword(password string) *Options

func (*Options) WithPoolSize

func (o *Options) WithPoolSize(poolSize int) *Options

func (*Options) WithReadTimeout

func (o *Options) WithReadTimeout(readTimeout time.Duration) *Options

func (*Options) WithWriteTimeout

func (o *Options) WithWriteTimeout(writeTimeout time.Duration) *Options

type Redis

type Redis struct {
	*redis.Client
}

func GetRedis

func GetRedis(name string) (*Redis, error)

func NewRedis

func NewRedis(opt RedisOptions) *Redis

func NewRedisPing

func NewRedisPing(ctx context.Context, opt RedisOptions) (*Redis, error)

type RedisOptions

type RedisOptions interface {
	RedisOptions() *redis.Options
}