Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

redisx

package module

Go to main page

Versions in this module

v1

v1.3.0

Jul 21, 2026

Changes in this version

+ const Version

+ var ErrLockLost = errors.New("redisx: lock lost")

+ var ErrLockNoExpiry = errors.New("redisx: lock has no expiry")

+ var ErrLockNotObtained = errors.New("redisx: lock not obtained")

+ var ErrMessageDeadLettered = errors.New("redisx: message dead-lettered")

+ func GetBytes(ctx context.Context, p *Proxy, key string) ([]byte, error)

+ func GetCodec[T any](ctx context.Context, p *Proxy, key string, codec Codec) (T, error)

+ func GetJSON[T any](ctx context.Context, p *Proxy, key string) (T, error)

+ func SetBytes(ctx context.Context, p *Proxy, key string, data []byte, ...) error

+ func SetCodec(ctx context.Context, p *Proxy, key string, codec Codec, value any, ...) error

+ func SetJSON(ctx context.Context, p *Proxy, key string, value any, expiration time.Duration) error

+ type Client struct

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

+ func NewClientContext(ctx context.Context, opts ...Option) (*Client, error)

+ func (c *Client) AddHook(hook redis.Hook)

+ func (c *Client) Close() error

+ func (c *Client) DefaultClient() *redis.Client

+ func (c *Client) GetClient(db int) (*redis.Client, bool)

+ func (c *Client) HealthCheck(ctx context.Context) error

+ func (c *Client) MustSelectDB(db int) *Proxy

+ func (c *Client) PoolStats() map[int]*redis.PoolStats

+ func (c *Client) Prefix() string

+ func (c *Client) SelectDB(db int) (*Proxy, error)

+ type Codec interface

+ Marshal func(v any) ([]byte, error)

+ Unmarshal func(data []byte, v any) error

+ type Config struct

+ Addr string

+ AllowPartialInit bool

+ ChannelPrefix string

+ ChannelPrefixSeparator string

+ DefaultDB int

+ DialTimeout time.Duration

+ IdleTimeout time.Duration

+ InitDBs []DBConfig

+ KeyPrefix string

+ KeyPrefixSeparator string

+ MaxRetries int

+ MinIdleConns int

+ Password string

+ PoolSize int

+ ReadTimeout time.Duration

+ TLSConfig *tls.Config

+ Username string

+ WriteTimeout time.Duration

+ type DBConfig struct

+ DB int

+ Prefix string

+ type FencedLock struct

+ func (l *FencedLock) Fence() int64

+ type InitError struct

+ Failed map[int]error

+ func (e *InitError) Error() string

+ func (e *InitError) Unwrap() []error

+ type Lock struct

+ func (l *Lock) Key() string

+ func (l *Lock) Refresh(ctx context.Context, ttl time.Duration) error

+ func (l *Lock) Release(ctx context.Context) error

+ func (l *Lock) TTL(ctx context.Context) (time.Duration, error)

+ type Option func(*Config)

+ func WithAddr(addr string) Option

+ func WithAllowPartialInit() Option

+ func WithChannelPrefix(prefix string) Option

+ func WithChannelPrefixSeparator(separator string) Option

+ func WithDB(db int) Option

+ func WithDBConfig(db int, prefix string) Option

+ func WithDialTimeout(d time.Duration) Option

+ func WithIdleTimeout(d time.Duration) Option

+ func WithInitDBPrefix(db int, prefix string) Option

+ func WithInitDBs(dbs ...int) Option

+ func WithKeyPrefix(prefix string) Option

+ func WithKeyPrefixSeparator(separator string) Option

+ func WithMaxRetries(n int) Option

+ func WithMinIdleConns(n int) Option

+ func WithPassword(password string) Option

+ func WithPoolSize(size int) Option

+ func WithReadTimeout(d time.Duration) Option

+ func WithTLSConfig(tlsConfig *tls.Config) Option

+ func WithUsername(username string) Option

+ func WithWriteTimeout(d time.Duration) Option

+ type Proxy struct

+ func WrapClient(rdb *redis.Client, opts ...ProxyOption) (*Proxy, error)

+ func (p *Proxy) Consume(ctx context.Context, handler func(*redis.Message), channels ...string) error

+ func (p *Proxy) ConsumePattern(ctx context.Context, handler func(*redis.Message), patterns ...string) error

+ func (p *Proxy) ConsumeStream(ctx context.Context, cfg StreamConfig, handler func(redis.XMessage) error) error

+ func (p *Proxy) Decr(ctx context.Context, key string) *redis.IntCmd

+ func (p *Proxy) DecrBy(ctx context.Context, key string, value int64) *redis.IntCmd

+ func (p *Proxy) Del(ctx context.Context, keys ...string) *redis.IntCmd

+ func (p *Proxy) DelByPattern(ctx context.Context, pattern string) (int64, error)

+ func (p *Proxy) Eval(ctx context.Context, script string, keys []string, args ...any) *redis.Cmd

+ func (p *Proxy) EvalScript(ctx context.Context, script *redis.Script, keys []string, args ...any) *redis.Cmd

+ func (p *Proxy) EvalSha(ctx context.Context, sha1 string, keys []string, args ...any) *redis.Cmd

+ func (p *Proxy) Exists(ctx context.Context, keys ...string) *redis.IntCmd

+ func (p *Proxy) Expire(ctx context.Context, key string, expiration time.Duration) *redis.BoolCmd

+ func (p *Proxy) ExpireAt(ctx context.Context, key string, tm time.Time) *redis.BoolCmd

+ func (p *Proxy) FencedLock(ctx context.Context, key string, ttl time.Duration) (*FencedLock, error)

+ func (p *Proxy) Get(ctx context.Context, key string) *redis.StringCmd

+ func (p *Proxy) GetDel(ctx context.Context, key string) *redis.StringCmd

+ func (p *Proxy) GetSet(ctx context.Context, key string, value any) *redis.StringCmd

+ func (p *Proxy) HDel(ctx context.Context, key string, fields ...string) *redis.IntCmd

+ func (p *Proxy) HExists(ctx context.Context, key, field string) *redis.BoolCmd

+ func (p *Proxy) HGet(ctx context.Context, key, field string) *redis.StringCmd

+ func (p *Proxy) HGetAll(ctx context.Context, key string) *redis.MapStringStringCmd

+ func (p *Proxy) HIncrBy(ctx context.Context, key, field string, incr int64) *redis.IntCmd

+ func (p *Proxy) HIncrByFloat(ctx context.Context, key, field string, incr float64) *redis.FloatCmd

+ func (p *Proxy) HLen(ctx context.Context, key string) *redis.IntCmd

+ func (p *Proxy) HMGet(ctx context.Context, key string, fields ...string) *redis.SliceCmd

+ func (p *Proxy) HMSet(ctx context.Context, key string, values ...any) *redis.BoolCmd

+ func (p *Proxy) HSet(ctx context.Context, key string, values ...any) *redis.IntCmd

+ func (p *Proxy) Incr(ctx context.Context, key string) *redis.IntCmd

+ func (p *Proxy) IncrBy(ctx context.Context, key string, value int64) *redis.IntCmd

+ func (p *Proxy) IncrByFloat(ctx context.Context, key string, value float64) *redis.FloatCmd

+ func (p *Proxy) Key(k string) string

+ func (p *Proxy) Keys(ks ...string) []string

+ func (p *Proxy) LIndex(ctx context.Context, key string, index int64) *redis.StringCmd

+ func (p *Proxy) LLen(ctx context.Context, key string) *redis.IntCmd

+ func (p *Proxy) LPop(ctx context.Context, key string) *redis.StringCmd

+ func (p *Proxy) LPush(ctx context.Context, key string, values ...any) *redis.IntCmd

+ func (p *Proxy) LRange(ctx context.Context, key string, start, stop int64) *redis.StringSliceCmd

+ func (p *Proxy) LRem(ctx context.Context, key string, count int64, value any) *redis.IntCmd

+ func (p *Proxy) LTrim(ctx context.Context, key string, start, stop int64) *redis.StatusCmd

+ func (p *Proxy) MGet(ctx context.Context, keys ...string) *redis.SliceCmd

+ func (p *Proxy) MSet(ctx context.Context, values ...any) *redis.StatusCmd

+ func (p *Proxy) PSubscribe(ctx context.Context, patterns ...string) *redis.PubSub

+ func (p *Proxy) PTTL(ctx context.Context, key string) *redis.DurationCmd

+ func (p *Proxy) Persist(ctx context.Context, key string) *redis.BoolCmd

+ func (p *Proxy) Pipeline() redis.Pipeliner

+ func (p *Proxy) Publish(ctx context.Context, channel string, message any) *redis.IntCmd

+ func (p *Proxy) RPop(ctx context.Context, key string) *redis.StringCmd

+ func (p *Proxy) RPush(ctx context.Context, key string, values ...any) *redis.IntCmd

+ func (p *Proxy) RawClient() *redis.Client

+ func (p *Proxy) Rename(ctx context.Context, key, newkey string) *redis.StatusCmd

+ func (p *Proxy) SAdd(ctx context.Context, key string, members ...any) *redis.IntCmd

+ func (p *Proxy) SCard(ctx context.Context, key string) *redis.IntCmd

+ func (p *Proxy) SIsMember(ctx context.Context, key string, member any) *redis.BoolCmd

+ func (p *Proxy) SMembers(ctx context.Context, key string) *redis.StringSliceCmd

+ func (p *Proxy) SPop(ctx context.Context, key string) *redis.StringCmd

+ func (p *Proxy) SRandMember(ctx context.Context, key string) *redis.StringCmd

+ func (p *Proxy) SRem(ctx context.Context, key string, members ...any) *redis.IntCmd

+ func (p *Proxy) Scan(ctx context.Context, cursor uint64, match string, count int64) *redis.ScanCmd

+ func (p *Proxy) ScanKeys(ctx context.Context, match string) iter.Seq2[string, error]

+ func (p *Proxy) Set(ctx context.Context, key string, value any, expiration time.Duration) *redis.StatusCmd

+ func (p *Proxy) SetEX(ctx context.Context, key string, value any, expiration time.Duration) *redis.StatusCmd

+ func (p *Proxy) SetNX(ctx context.Context, key string, value any, expiration time.Duration) *redis.BoolCmd

+ func (p *Proxy) Subscribe(ctx context.Context, channels ...string) *redis.PubSub

+ func (p *Proxy) TTL(ctx context.Context, key string) *redis.DurationCmd

+ func (p *Proxy) TryLock(ctx context.Context, key string, ttl time.Duration) (*Lock, error)

+ func (p *Proxy) TxPipeline() redis.Pipeliner

+ func (p *Proxy) Type(ctx context.Context, key string) *redis.StatusCmd

+ func (p *Proxy) WithLock(ctx context.Context, key string, ttl time.Duration, ...) error

+ func (p *Proxy) WithPrefix(prefix string) (*Proxy, error)

+ func (p *Proxy) XAck(ctx context.Context, stream, group string, ids ...string) *redis.IntCmd

+ func (p *Proxy) XAdd(ctx context.Context, args *redis.XAddArgs) *redis.StringCmd

+ func (p *Proxy) XDel(ctx context.Context, stream string, ids ...string) *redis.IntCmd

+ func (p *Proxy) XGroupCreateMkStream(ctx context.Context, stream, group, start string) *redis.StatusCmd

+ func (p *Proxy) XGroupDelConsumer(ctx context.Context, stream, group, consumer string) *redis.IntCmd

+ func (p *Proxy) XGroupDestroy(ctx context.Context, stream, group string) *redis.IntCmd

+ func (p *Proxy) XInfoConsumers(ctx context.Context, stream, group string) *redis.XInfoConsumersCmd

+ func (p *Proxy) XInfoGroups(ctx context.Context, stream string) *redis.XInfoGroupsCmd

+ func (p *Proxy) XLen(ctx context.Context, stream string) *redis.IntCmd

+ func (p *Proxy) XPending(ctx context.Context, stream, group string) *redis.XPendingCmd

+ func (p *Proxy) XPendingExt(ctx context.Context, args *redis.XPendingExtArgs) *redis.XPendingExtCmd

+ func (p *Proxy) XRange(ctx context.Context, stream, start, stop string) *redis.XMessageSliceCmd

+ func (p *Proxy) XTrimMaxLen(ctx context.Context, stream string, maxLen int64) *redis.IntCmd

+ func (p *Proxy) ZAdd(ctx context.Context, key string, members ...redis.Z) *redis.IntCmd

+ func (p *Proxy) ZCard(ctx context.Context, key string) *redis.IntCmd

+ func (p *Proxy) ZCount(ctx context.Context, key, minScore, maxScore string) *redis.IntCmd

+ func (p *Proxy) ZIncrBy(ctx context.Context, key string, increment float64, member string) *redis.FloatCmd

+ func (p *Proxy) ZRange(ctx context.Context, key string, start, stop int64) *redis.StringSliceCmd

+ func (p *Proxy) ZRangeByScore(ctx context.Context, key string, opt *redis.ZRangeBy) *redis.StringSliceCmd

+ func (p *Proxy) ZRank(ctx context.Context, key, member string) *redis.IntCmd

+ func (p *Proxy) ZRem(ctx context.Context, key string, members ...any) *redis.IntCmd

+ func (p *Proxy) ZRemRangeByScore(ctx context.Context, key, minScore, maxScore string) *redis.IntCmd

+ func (p *Proxy) ZRevRange(ctx context.Context, key string, start, stop int64) *redis.StringSliceCmd

+ func (p *Proxy) ZScore(ctx context.Context, key, member string) *redis.FloatCmd

+ type ProxyOption func(*proxyConfig)

+ func WithProxyChannelPrefix(prefix string) ProxyOption

+ func WithProxyChannelPrefixSeparator(separator string) ProxyOption

+ func WithProxyPrefix(prefix string) ProxyOption

+ func WithProxyPrefixSeparator(separator string) ProxyOption

+ type StreamConfig struct

+ AutoClaimMinIdle time.Duration

+ BatchSize int64

+ Block time.Duration

+ Consumer string

+ DeadLetterStream string

+ Group string

+ MaxDeliver int64

+ OnError func(msg redis.XMessage, err error)

+ Stream string

v1.2.3

Jul 7, 2026

v1.2.2

Jun 12, 2026

v1.2.1

Jun 12, 2026

v1.2.0

Jun 12, 2026

v1.1.1

Jun 11, 2026

v1.1.0

Jun 10, 2026