goredis

package
v0.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 28, 2022 License: MIT Imports: 6 Imported by: 0

README

'Prom' for go-redis library (https://github.com/go-redis/redis)

PkgGoDev

Supported/Tested libraries/drivers+version: github.com/go-redis/redis/v8 v8.11.5.

Usage:

import (
    "github.com/btnguyen2k/prom/goredis"
)

hostsAndPorts  := "host1:6379,host2;host3:6380"
password       := ""
maxRetries     := 3
goRedisConnect := goredis.NewGoRedisConnect(hostsAndPorts, password, maxRetries)

// Enable read-only commands for slave nodes. Used by cluster clients only!
goRedisConnect.SetSlaveReadOnly(true)

// Set name of master node. Used by failover/sentinel clients only!
goRedisConnect.SetSentinelMasterName("failover-master")

// from now on, one goRedisConnect instance can be shared & used by all goroutines within the application

db := 0

// get a *redis.Client instance, connecting to Redis database specified by 'db'
client := goRedisConnect.GetClient(db)

// get a failover *redis.Client instance, connecting to Redis database specified by 'db'
failoverClient := goRedisConnect.GetFailoverClient(db)

// get a *redis.ClusterClient instance 
clusterClient := goRedisConnect.GetClusterClient()

See more:

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CmdableWrapper

type CmdableWrapper struct {
	redis.Cmdable
	// contains filtered or unexported fields
}

func (*CmdableWrapper) Append

func (c *CmdableWrapper) Append(ctx context.Context, key, value string) *redis.IntCmd

Append overrides redis.Cmdable.Append to log execution metrics.

func (*CmdableWrapper) BLMove

func (c *CmdableWrapper) BLMove(ctx context.Context, srcKey, destKey, srcPos, destPos string, timeout time.Duration) *redis.StringCmd

BLMove overrides redis.Cmdable.BLMove to log execution metrics.

func (*CmdableWrapper) BLPop

func (c *CmdableWrapper) BLPop(ctx context.Context, timeout time.Duration, keys ...string) *redis.StringSliceCmd

BLPop overrides redis.Cmdable.BLPop to log execution metrics.

func (*CmdableWrapper) BRPop

func (c *CmdableWrapper) BRPop(ctx context.Context, timeout time.Duration, keys ...string) *redis.StringSliceCmd

BRPop overrides redis.Cmdable.BRPop to log execution metrics.

func (*CmdableWrapper) BZPopMax

func (c *CmdableWrapper) BZPopMax(ctx context.Context, timeout time.Duration, keys ...string) *redis.ZWithKeyCmd

BZPopMax overrides redis.Cmdable.BZPopMax to log execution metrics.

func (*CmdableWrapper) BZPopMin

func (c *CmdableWrapper) BZPopMin(ctx context.Context, timeout time.Duration, keys ...string) *redis.ZWithKeyCmd

BZPopMin overrides redis.Cmdable.BZPopMin to log execution metrics.

func (*CmdableWrapper) BitCount

func (c *CmdableWrapper) BitCount(ctx context.Context, key string, bitCount *redis.BitCount) *redis.IntCmd

BitCount overrides redis.Cmdable.BitCount to log execution metrics.

func (*CmdableWrapper) BitField

func (c *CmdableWrapper) BitField(ctx context.Context, key string, args ...interface{}) *redis.IntSliceCmd

BitField overrides redis.Cmdable.BitField to log execution metrics.

func (*CmdableWrapper) BitOpAnd

func (c *CmdableWrapper) BitOpAnd(ctx context.Context, destKey string, keys ...string) *redis.IntCmd

BitOpAnd overrides redis.Cmdable.BitOpAnd to log execution metrics.

func (*CmdableWrapper) BitOpNot

func (c *CmdableWrapper) BitOpNot(ctx context.Context, destKey, key string) *redis.IntCmd

BitOpNot overrides redis.Cmdable.BitOpNot to log execution metrics.

func (*CmdableWrapper) BitOpOr

func (c *CmdableWrapper) BitOpOr(ctx context.Context, destKey string, keys ...string) *redis.IntCmd

BitOpOr overrides redis.Cmdable.BitOpOr to log execution metrics.

func (*CmdableWrapper) BitOpXor

func (c *CmdableWrapper) BitOpXor(ctx context.Context, destKey string, keys ...string) *redis.IntCmd

BitOpXor overrides redis.Cmdable.BitOpXor to log execution metrics.

func (*CmdableWrapper) BitPos

func (c *CmdableWrapper) BitPos(ctx context.Context, key string, bit int64, pos ...int64) *redis.IntCmd

BitPos overrides redis.Cmdable.BitPos to log execution metrics.

func (*CmdableWrapper) Copy

func (c *CmdableWrapper) Copy(ctx context.Context, srcKey, destKey string, destDb int, replace bool) *redis.IntCmd

Copy overrides redis.Cmdable.Copy to log execution metrics.

func (*CmdableWrapper) DBSize

func (c *CmdableWrapper) DBSize(ctx context.Context) *redis.IntCmd

DBSize overrides redis.Cmdable.DBSize to log execution metrics.

func (*CmdableWrapper) Decr

func (c *CmdableWrapper) Decr(ctx context.Context, key string) *redis.IntCmd

Decr overrides redis.Cmdable.Decr to log execution metrics.

func (*CmdableWrapper) DecrBy

func (c *CmdableWrapper) DecrBy(ctx context.Context, key string, value int64) *redis.IntCmd

DecrBy overrides redis.Cmdable.DecrBy to log execution metrics.

func (*CmdableWrapper) Del

func (c *CmdableWrapper) Del(ctx context.Context, keys ...string) *redis.IntCmd

Del overrides redis.Cmdable.Del to log execution metrics.

func (*CmdableWrapper) Dump

func (c *CmdableWrapper) Dump(ctx context.Context, key string) *redis.StringCmd

Dump overrides redis.Cmdable.Dump to log execution metrics.

func (*CmdableWrapper) Eval

func (c *CmdableWrapper) Eval(ctx context.Context, script string, keys []string, args ...interface{}) *redis.Cmd

Eval overrides redis.Cmdable.Eval to log execution metrics.

func (*CmdableWrapper) EvalSha

func (c *CmdableWrapper) EvalSha(ctx context.Context, scriptSha string, keys []string, args ...interface{}) *redis.Cmd

EvalSha overrides redis.Cmdable.EvalSha to log execution metrics.

func (*CmdableWrapper) Exists

func (c *CmdableWrapper) Exists(ctx context.Context, keys ...string) *redis.IntCmd

Exists overrides redis.Cmdable.Exists to log execution metrics.

func (*CmdableWrapper) Expire

func (c *CmdableWrapper) Expire(ctx context.Context, key string, value time.Duration) *redis.BoolCmd

Expire overrides redis.Cmdable.Expire to log execution metrics.

func (*CmdableWrapper) ExpireAt

func (c *CmdableWrapper) ExpireAt(ctx context.Context, key string, value time.Time) *redis.BoolCmd

ExpireAt overrides redis.Cmdable.ExpireAt to log execution metrics.

func (*CmdableWrapper) FlushAll

func (c *CmdableWrapper) FlushAll(ctx context.Context) *redis.StatusCmd

FlushAll overrides redis.Cmdable.FlushAll to log execution metrics.

func (*CmdableWrapper) FlushAllAsync

func (c *CmdableWrapper) FlushAllAsync(ctx context.Context) *redis.StatusCmd

FlushAllAsync overrides redis.Cmdable.FlushAllAsync to log execution metrics.

func (*CmdableWrapper) FlushDB

func (c *CmdableWrapper) FlushDB(ctx context.Context) *redis.StatusCmd

FlushDB overrides redis.Cmdable.FlushDB to log execution metrics.

func (*CmdableWrapper) FlushDBAsync

func (c *CmdableWrapper) FlushDBAsync(ctx context.Context) *redis.StatusCmd

FlushDBAsync overrides redis.Cmdable.FlushDBAsync to log execution metrics.

func (*CmdableWrapper) GeoAdd

func (c *CmdableWrapper) GeoAdd(ctx context.Context, key string, geoLocations ...*redis.GeoLocation) *redis.IntCmd

func (*CmdableWrapper) GeoDist

func (c *CmdableWrapper) GeoDist(ctx context.Context, key, member1, member2, unit string) *redis.FloatCmd

func (*CmdableWrapper) GeoHash

func (c *CmdableWrapper) GeoHash(ctx context.Context, key string, members ...string) *redis.StringSliceCmd

func (*CmdableWrapper) GeoPos

func (c *CmdableWrapper) GeoPos(ctx context.Context, key string, members ...string) *redis.GeoPosCmd

func (*CmdableWrapper) GeoSearch

func (c *CmdableWrapper) GeoSearch(ctx context.Context, key string, query *redis.GeoSearchQuery) *redis.StringSliceCmd

func (*CmdableWrapper) GeoSearchLocation

func (c *CmdableWrapper) GeoSearchLocation(ctx context.Context, key string, query *redis.GeoSearchLocationQuery) *redis.GeoSearchLocationCmd

func (*CmdableWrapper) GeoSearchStore

func (c *CmdableWrapper) GeoSearchStore(ctx context.Context, key, store string, query *redis.GeoSearchStoreQuery) *redis.IntCmd

func (*CmdableWrapper) Get

func (c *CmdableWrapper) Get(ctx context.Context, key string) *redis.StringCmd

Get overrides redis.Cmdable.Get to log execution metrics.

func (*CmdableWrapper) GetBit

func (c *CmdableWrapper) GetBit(ctx context.Context, key string, offset int64) *redis.IntCmd

GetBit overrides redis.Cmdable.GetBit to log execution metrics.

func (*CmdableWrapper) GetDel

func (c *CmdableWrapper) GetDel(ctx context.Context, key string) *redis.StringCmd

GetDel overrides redis.Cmdable.GetDel to log execution metrics.

func (*CmdableWrapper) GetEx

func (c *CmdableWrapper) GetEx(ctx context.Context, key string, expiration time.Duration) *redis.StringCmd

GetEx overrides redis.Cmdable.GetEx to log execution metrics.

func (*CmdableWrapper) GetRange

func (c *CmdableWrapper) GetRange(ctx context.Context, key string, start, end int64) *redis.StringCmd

GetRange overrides redis.Cmdable.GetRange to log execution metrics.

func (*CmdableWrapper) GetSet

func (c *CmdableWrapper) GetSet(ctx context.Context, key string, value interface{}) *redis.StringCmd

GetSet overrides redis.Cmdable.GetSet to log execution metrics.

func (*CmdableWrapper) HDel

func (c *CmdableWrapper) HDel(ctx context.Context, key string, fields ...string) *redis.IntCmd

HDel overrides redis.Cmdable.HDel to log execution metrics.

func (*CmdableWrapper) HExists

func (c *CmdableWrapper) HExists(ctx context.Context, key, field string) *redis.BoolCmd

HExists overrides redis.Cmdable.HExists to log execution metrics.

func (*CmdableWrapper) HGet

func (c *CmdableWrapper) HGet(ctx context.Context, key, field string) *redis.StringCmd

HGet overrides redis.Cmdable.HGet to log execution metrics.

func (*CmdableWrapper) HGetAll

func (c *CmdableWrapper) HGetAll(ctx context.Context, key string) *redis.StringStringMapCmd

HGetAll overrides redis.Cmdable.HGetAll to log execution metrics.

func (*CmdableWrapper) HIncrBy

func (c *CmdableWrapper) HIncrBy(ctx context.Context, key, field string, value int64) *redis.IntCmd

HIncrBy overrides redis.Cmdable.HIncrBy to log execution metrics.

func (*CmdableWrapper) HIncrByFloat

func (c *CmdableWrapper) HIncrByFloat(ctx context.Context, key, field string, value float64) *redis.FloatCmd

HIncrByFloat overrides redis.Cmdable.HIncrByFloat to log execution metrics.

func (*CmdableWrapper) HKeys

func (c *CmdableWrapper) HKeys(ctx context.Context, key string) *redis.StringSliceCmd

HKeys overrides redis.Cmdable.HKeys to log execution metrics.

func (*CmdableWrapper) HLen

func (c *CmdableWrapper) HLen(ctx context.Context, key string) *redis.IntCmd

HLen overrides redis.Cmdable.HLen to log execution metrics.

func (*CmdableWrapper) HMGet

func (c *CmdableWrapper) HMGet(ctx context.Context, key string, fields ...string) *redis.SliceCmd

HMGet overrides redis.Cmdable.HMGet to log execution metrics.

func (*CmdableWrapper) HRandField

func (c *CmdableWrapper) HRandField(ctx context.Context, key string, count int, withValues bool) *redis.StringSliceCmd

HRandField overrides redis.Cmdable.HRandField to log execution metrics.

func (*CmdableWrapper) HScan

func (c *CmdableWrapper) HScan(ctx context.Context, key string, cursor uint64, match string, count int64) *redis.ScanCmd

HScan overrides redis.Cmdable.HScan to log execution metrics.

func (*CmdableWrapper) HSet

func (c *CmdableWrapper) HSet(ctx context.Context, key string, values ...interface{}) *redis.IntCmd

HSet overrides redis.Cmdable.HSet to log execution metrics.

func (*CmdableWrapper) HSetNX

func (c *CmdableWrapper) HSetNX(ctx context.Context, key, field string, value interface{}) *redis.BoolCmd

HSetNX overrides redis.Cmdable.HSetNX to log execution metrics.

func (*CmdableWrapper) HVals

func (c *CmdableWrapper) HVals(ctx context.Context, key string) *redis.StringSliceCmd

HVals overrides redis.Cmdable.HVals to log execution metrics.

func (*CmdableWrapper) Incr

func (c *CmdableWrapper) Incr(ctx context.Context, key string) *redis.IntCmd

Incr overrides redis.Cmdable.Decr to log execution metrics.

func (*CmdableWrapper) IncrBy

func (c *CmdableWrapper) IncrBy(ctx context.Context, key string, value int64) *redis.IntCmd

IncrBy overrides redis.Cmdable.IncrBy to log execution metrics.

func (*CmdableWrapper) IncrByFloat

func (c *CmdableWrapper) IncrByFloat(ctx context.Context, key string, value float64) *redis.FloatCmd

IncrByFloat overrides redis.Cmdable.IncrByFloat to log execution metrics.

func (*CmdableWrapper) Keys

func (c *CmdableWrapper) Keys(ctx context.Context, pattern string) *redis.StringSliceCmd

Keys overrides redis.Cmdable.Keys to log execution metrics.

func (*CmdableWrapper) LIndex

func (c *CmdableWrapper) LIndex(ctx context.Context, key string, index int64) *redis.StringCmd

LIndex overrides redis.Cmdable.LIndex to log execution metrics.

func (*CmdableWrapper) LInsert

func (c *CmdableWrapper) LInsert(ctx context.Context, key, op string, pivot, value interface{}) *redis.IntCmd

LInsert overrides redis.Cmdable.LInsert to log execution metrics.

func (*CmdableWrapper) LLen

func (c *CmdableWrapper) LLen(ctx context.Context, key string) *redis.IntCmd

LLen overrides redis.Cmdable.LLen to log execution metrics.

func (*CmdableWrapper) LMove

func (c *CmdableWrapper) LMove(ctx context.Context, srcKey, destKey, srcPos, destPos string) *redis.StringCmd

LMove overrides redis.Cmdable.LMove to log execution metrics.

func (*CmdableWrapper) LPop

func (c *CmdableWrapper) LPop(ctx context.Context, key string) *redis.StringCmd

LPop overrides redis.Cmdable.LPop to log execution metrics.

func (*CmdableWrapper) LPos

func (c *CmdableWrapper) LPos(ctx context.Context, key, value string, args redis.LPosArgs) *redis.IntCmd

LPos overrides redis.Cmdable.LPos to log execution metrics.

func (*CmdableWrapper) LPush

func (c *CmdableWrapper) LPush(ctx context.Context, key string, values ...interface{}) *redis.IntCmd

LPush overrides redis.Cmdable.LPush to log execution metrics.

func (*CmdableWrapper) LPushX

func (c *CmdableWrapper) LPushX(ctx context.Context, key string, values ...interface{}) *redis.IntCmd

LPushX overrides redis.Cmdable.LPushX to log execution metrics.

func (*CmdableWrapper) LRange

func (c *CmdableWrapper) LRange(ctx context.Context, key string, start, stop int64) *redis.StringSliceCmd

LRange overrides redis.Cmdable.LRange to log execution metrics.

func (*CmdableWrapper) LRem

func (c *CmdableWrapper) LRem(ctx context.Context, key string, count int64, value interface{}) *redis.IntCmd

LRem overrides redis.Cmdable.LRem to log execution metrics.

func (*CmdableWrapper) LSet

func (c *CmdableWrapper) LSet(ctx context.Context, key string, index int64, value interface{}) *redis.StatusCmd

LSet overrides redis.Cmdable.LSet to log execution metrics.

func (*CmdableWrapper) LTrim

func (c *CmdableWrapper) LTrim(ctx context.Context, key string, start, stop int64) *redis.StatusCmd

LTrim overrides redis.Cmdable.LTrim to log execution metrics.

func (*CmdableWrapper) MGet

func (c *CmdableWrapper) MGet(ctx context.Context, keys ...string) *redis.SliceCmd

MGet overrides redis.Cmdable.MGet to log execution metrics.

func (*CmdableWrapper) MSet

func (c *CmdableWrapper) MSet(ctx context.Context, values ...interface{}) *redis.StatusCmd

MSet overrides redis.Cmdable.MSet to log execution metrics.

func (*CmdableWrapper) MSetNX

func (c *CmdableWrapper) MSetNX(ctx context.Context, values ...interface{}) *redis.BoolCmd

MSetNX overrides redis.Cmdable.MSetNX to log execution metrics.

func (*CmdableWrapper) Migrate

func (c *CmdableWrapper) Migrate(ctx context.Context, host, port, key string, db int, timeout time.Duration) *redis.StatusCmd

Migrate overrides redis.Cmdable.Migrate to log execution metrics.

func (*CmdableWrapper) Move

func (c *CmdableWrapper) Move(ctx context.Context, key string, db int) *redis.BoolCmd

Move overrides redis.Cmdable.Move to log execution metrics.

func (*CmdableWrapper) ObjectEncoding

func (c *CmdableWrapper) ObjectEncoding(ctx context.Context, key string) *redis.StringCmd

ObjectEncoding overrides redis.Cmdable.ObjectEncoding to log execution metrics.

func (*CmdableWrapper) ObjectIdleTime

func (c *CmdableWrapper) ObjectIdleTime(ctx context.Context, key string) *redis.DurationCmd

ObjectIdleTime overrides redis.Cmdable.ObjectIdleTime to log execution metrics.

func (*CmdableWrapper) ObjectRefCount

func (c *CmdableWrapper) ObjectRefCount(ctx context.Context, key string) *redis.IntCmd

ObjectRefCount overrides redis.Cmdable.ObjectRefCount to log execution metrics.

func (*CmdableWrapper) PExpire

func (c *CmdableWrapper) PExpire(ctx context.Context, key string, value time.Duration) *redis.BoolCmd

PExpire overrides redis.Cmdable.PExpire to log execution metrics.

func (*CmdableWrapper) PExpireAt

func (c *CmdableWrapper) PExpireAt(ctx context.Context, key string, value time.Time) *redis.BoolCmd

PExpireAt overrides redis.Cmdable.PExpireAt to log execution metrics.

func (*CmdableWrapper) PFAdd

func (c *CmdableWrapper) PFAdd(ctx context.Context, key string, elements ...interface{}) *redis.IntCmd

PFAdd overrides redis.Cmdable.PFAdd to log execution metrics.

func (*CmdableWrapper) PFCount

func (c *CmdableWrapper) PFCount(ctx context.Context, keys ...string) *redis.IntCmd

PFCount overrides redis.Cmdable.PFCount to log execution metrics.

func (*CmdableWrapper) PFMerge

func (c *CmdableWrapper) PFMerge(ctx context.Context, destKey string, keys ...string) *redis.StatusCmd

PFMerge overrides redis.Cmdable.PFMerge to log execution metrics.

func (*CmdableWrapper) PTTL

func (c *CmdableWrapper) PTTL(ctx context.Context, key string) *redis.DurationCmd

PTTL overrides redis.Cmdable.PTTL to log execution metrics.

func (*CmdableWrapper) Persist

func (c *CmdableWrapper) Persist(ctx context.Context, key string) *redis.BoolCmd

Persist overrides redis.Cmdable.Persist to log execution metrics.

func (*CmdableWrapper) Ping

func (c *CmdableWrapper) Ping(ctx context.Context) *redis.StatusCmd

Ping overrides redis.Cmdable.Ping to log execution metrics.

func (*CmdableWrapper) PubSubChannels

func (c *CmdableWrapper) PubSubChannels(ctx context.Context, pattern string) *redis.StringSliceCmd

PubSubChannels overrides redis.Cmdable.PubSubChannels to log execution metrics.

func (*CmdableWrapper) PubSubNumPat

func (c *CmdableWrapper) PubSubNumPat(ctx context.Context) *redis.IntCmd

PubSubNumPat overrides redis.Cmdable.PubSubNumPat to log execution metrics.

func (*CmdableWrapper) PubSubNumSub

func (c *CmdableWrapper) PubSubNumSub(ctx context.Context, channels ...string) *redis.StringIntMapCmd

PubSubNumSub overrides redis.Cmdable.PubSubNumSub to log execution metrics.

func (*CmdableWrapper) Publish

func (c *CmdableWrapper) Publish(ctx context.Context, channel string, message interface{}) *redis.IntCmd

Publish overrides redis.Cmdable.Publish to log execution metrics.

func (*CmdableWrapper) RPop

func (c *CmdableWrapper) RPop(ctx context.Context, key string) *redis.StringCmd

RPop overrides redis.Cmdable.RPop to log execution metrics.

func (*CmdableWrapper) RPush

func (c *CmdableWrapper) RPush(ctx context.Context, key string, values ...interface{}) *redis.IntCmd

RPush overrides redis.Cmdable.RPush to log execution metrics.

func (*CmdableWrapper) RPushX

func (c *CmdableWrapper) RPushX(ctx context.Context, key string, values ...interface{}) *redis.IntCmd

RPushX overrides redis.Cmdable.RPushX to log execution metrics.

func (*CmdableWrapper) RandomKey

func (c *CmdableWrapper) RandomKey(ctx context.Context) *redis.StringCmd

RandomKey overrides redis.Cmdable.RandomKey to log execution metrics.

func (*CmdableWrapper) ReadOnly

func (c *CmdableWrapper) ReadOnly(ctx context.Context) *redis.StatusCmd

ReadOnly overrides redis.Cmdable.ReadOnly to log execution metrics.

func (*CmdableWrapper) ReadWrite

func (c *CmdableWrapper) ReadWrite(ctx context.Context) *redis.StatusCmd

ReadWrite overrides redis.Cmdable.ReadWrite to log execution metrics.

func (*CmdableWrapper) Rename

func (c *CmdableWrapper) Rename(ctx context.Context, key, newKey string) *redis.StatusCmd

Rename overrides redis.Cmdable.Rename to log execution metrics.

func (*CmdableWrapper) RenameNX

func (c *CmdableWrapper) RenameNX(ctx context.Context, key, newKey string) *redis.BoolCmd

RenameNX overrides redis.Cmdable.RenameNX to log execution metrics.

func (*CmdableWrapper) Restore

func (c *CmdableWrapper) Restore(ctx context.Context, key string, ttl time.Duration, value string) *redis.StatusCmd

Restore overrides redis.Cmdable.Restore to log execution metrics.

func (*CmdableWrapper) SAdd

func (c *CmdableWrapper) SAdd(ctx context.Context, key string, values ...interface{}) *redis.IntCmd

SAdd overrides redis.Cmdable.SAdd to log execution metrics.

func (*CmdableWrapper) SCard

func (c *CmdableWrapper) SCard(ctx context.Context, key string) *redis.IntCmd

SCard overrides redis.Cmdable.SCard to log execution metrics.

func (*CmdableWrapper) SDiff

func (c *CmdableWrapper) SDiff(ctx context.Context, keys ...string) *redis.StringSliceCmd

SDiff overrides redis.Cmdable.SDiff to log execution metrics.

func (*CmdableWrapper) SDiffStore

func (c *CmdableWrapper) SDiffStore(ctx context.Context, destKey string, keys ...string) *redis.IntCmd

SDiffStore overrides redis.Cmdable.SDiffStore to log execution metrics.

func (*CmdableWrapper) SInter

func (c *CmdableWrapper) SInter(ctx context.Context, keys ...string) *redis.StringSliceCmd

SInter overrides redis.Cmdable.SInter to log execution metrics.

func (*CmdableWrapper) SInterStore

func (c *CmdableWrapper) SInterStore(ctx context.Context, destKey string, keys ...string) *redis.IntCmd

SInterStore overrides redis.Cmdable.SInterStore to log execution metrics.

func (*CmdableWrapper) SIsMember

func (c *CmdableWrapper) SIsMember(ctx context.Context, key string, value interface{}) *redis.BoolCmd

SIsMember overrides redis.Cmdable.SIsMember to log execution metrics.

func (*CmdableWrapper) SMIsMember

func (c *CmdableWrapper) SMIsMember(ctx context.Context, key string, values ...interface{}) *redis.BoolSliceCmd

SMIsMember overrides redis.Cmdable.SMIsMember to log execution metrics.

func (*CmdableWrapper) SMembers

func (c *CmdableWrapper) SMembers(ctx context.Context, key string) *redis.StringSliceCmd

SMembers overrides redis.Cmdable.SMembers to log execution metrics.

func (*CmdableWrapper) SMove

func (c *CmdableWrapper) SMove(ctx context.Context, srcKey, destKey string, value interface{}) *redis.BoolCmd

SMove overrides redis.Cmdable.SMove to log execution metrics.

func (*CmdableWrapper) SPop

func (c *CmdableWrapper) SPop(ctx context.Context, key string) *redis.StringCmd

SPop overrides redis.Cmdable.SPop to log execution metrics.

func (*CmdableWrapper) SPopN

func (c *CmdableWrapper) SPopN(ctx context.Context, key string, count int64) *redis.StringSliceCmd

SPopN overrides redis.Cmdable.SPopN to log execution metrics.

func (*CmdableWrapper) SRandMember

func (c *CmdableWrapper) SRandMember(ctx context.Context, key string) *redis.StringCmd

SRandMember overrides redis.Cmdable.SRandMember to log execution metrics.

func (*CmdableWrapper) SRandMemberN

func (c *CmdableWrapper) SRandMemberN(ctx context.Context, key string, count int64) *redis.StringSliceCmd

SRandMemberN overrides redis.Cmdable.SRandMemberN to log execution metrics.

func (*CmdableWrapper) SRem

func (c *CmdableWrapper) SRem(ctx context.Context, key string, values ...interface{}) *redis.IntCmd

SRem overrides redis.Cmdable.SRem to log execution metrics.

func (*CmdableWrapper) SScan

func (c *CmdableWrapper) SScan(ctx context.Context, key string, cursor uint64, pattern string, count int64) *redis.ScanCmd

SScan overrides redis.Cmdable.SScan to log execution metrics.

func (*CmdableWrapper) SUnion

func (c *CmdableWrapper) SUnion(ctx context.Context, keys ...string) *redis.StringSliceCmd

SUnion overrides redis.Cmdable.SUnion to log execution metrics.

func (*CmdableWrapper) SUnionStore

func (c *CmdableWrapper) SUnionStore(ctx context.Context, destKey string, keys ...string) *redis.IntCmd

SUnionStore overrides redis.Cmdable.SUnionStore to log execution metrics.

func (*CmdableWrapper) Scan

func (c *CmdableWrapper) Scan(ctx context.Context, cursor uint64, match string, count int64) *redis.ScanCmd

Scan overrides redis.Cmdable.Scan to log execution metrics.

func (*CmdableWrapper) ScriptExists

func (c *CmdableWrapper) ScriptExists(ctx context.Context, hashes ...string) *redis.BoolSliceCmd

ScriptExists overrides redis.Cmdable.ScriptExists to log execution metrics.

func (*CmdableWrapper) ScriptFlush

func (c *CmdableWrapper) ScriptFlush(ctx context.Context) *redis.StatusCmd

ScriptFlush overrides redis.Cmdable.ScriptFlush to log execution metrics.

func (*CmdableWrapper) ScriptKill

func (c *CmdableWrapper) ScriptKill(ctx context.Context) *redis.StatusCmd

ScriptKill overrides redis.Cmdable.ScriptKill to log execution metrics.

func (*CmdableWrapper) ScriptLoad

func (c *CmdableWrapper) ScriptLoad(ctx context.Context, script string) *redis.StringCmd

ScriptLoad overrides redis.Cmdable.ScriptLoad to log execution metrics.

func (*CmdableWrapper) Set

func (c *CmdableWrapper) Set(ctx context.Context, key string, value interface{}, expiration time.Duration) *redis.StatusCmd

Set overrides redis.Cmdable.Set to log execution metrics.

func (*CmdableWrapper) SetBit

func (c *CmdableWrapper) SetBit(ctx context.Context, key string, offset int64, value int) *redis.IntCmd

SetBit overrides redis.Cmdable.SetBit to log execution metrics.

func (*CmdableWrapper) SetEX

func (c *CmdableWrapper) SetEX(ctx context.Context, key string, value interface{}, expiration time.Duration) *redis.StatusCmd

SetEX overrides redis.Cmdable.SetEX to log execution metrics.

func (*CmdableWrapper) SetNX

func (c *CmdableWrapper) SetNX(ctx context.Context, key string, value interface{}, expiration time.Duration) *redis.BoolCmd

SetNX overrides redis.Cmdable.SetNX to log execution metrics.

func (*CmdableWrapper) SetRange

func (c *CmdableWrapper) SetRange(ctx context.Context, key string, offset int64, value string) *redis.IntCmd

SetRange overrides redis.Cmdable.SetRange to log execution metrics.

func (*CmdableWrapper) Sort

func (c *CmdableWrapper) Sort(ctx context.Context, key string, sort *redis.Sort) *redis.StringSliceCmd

Sort overrides redis.Cmdable.Sort to log execution metrics.

func (*CmdableWrapper) StrLen

func (c *CmdableWrapper) StrLen(ctx context.Context, key string) *redis.IntCmd

StrLen overrides redis.Cmdable.StrLen to log execution metrics.

func (*CmdableWrapper) TTL

func (c *CmdableWrapper) TTL(ctx context.Context, key string) *redis.DurationCmd

TTL overrides redis.Cmdable.TTL to log execution metrics.

func (*CmdableWrapper) Touch

func (c *CmdableWrapper) Touch(ctx context.Context, keys ...string) *redis.IntCmd

Touch overrides redis.Cmdable.Touch to log execution metrics.

func (*CmdableWrapper) Type

func (c *CmdableWrapper) Type(ctx context.Context, key string) *redis.StatusCmd

Type overrides redis.Cmdable.Type to log execution metrics.

func (c *CmdableWrapper) Unlink(ctx context.Context, keys ...string) *redis.IntCmd

Unlink overrides redis.Cmdable.Unlink to log execution metrics.

func (*CmdableWrapper) XAck

func (c *CmdableWrapper) XAck(ctx context.Context, stream, group string, ids ...string) *redis.IntCmd

XAck overrides redis.Cmdable.XAck to log execution metrics.

func (*CmdableWrapper) XAdd

func (c *CmdableWrapper) XAdd(ctx context.Context, args *redis.XAddArgs) *redis.StringCmd

XAdd overrides redis.Cmdable.XAdd to log execution metrics.

func (*CmdableWrapper) XAutoClaim

func (c *CmdableWrapper) XAutoClaim(ctx context.Context, args *redis.XAutoClaimArgs) *redis.XAutoClaimCmd

XAutoClaim overrides redis.Cmdable.XAutoClaim to log execution metrics.

func (*CmdableWrapper) XAutoClaimJustID

func (c *CmdableWrapper) XAutoClaimJustID(ctx context.Context, args *redis.XAutoClaimArgs) *redis.XAutoClaimJustIDCmd

XAutoClaimJustID overrides redis.Cmdable.XAutoClaimJustID to log execution metrics.

func (*CmdableWrapper) XDel

func (c *CmdableWrapper) XDel(ctx context.Context, stream string, ids ...string) *redis.IntCmd

XDel overrides redis.Cmdable.XDel to log execution metrics.

func (*CmdableWrapper) XGroupCreate

func (c *CmdableWrapper) XGroupCreate(ctx context.Context, stream, group, start string) *redis.StatusCmd

XGroupCreate overrides redis.Cmdable.XGroupCreate to log execution metrics.

func (*CmdableWrapper) XGroupCreateConsumer

func (c *CmdableWrapper) XGroupCreateConsumer(ctx context.Context, stream, group, consumer string) *redis.IntCmd

XGroupCreateConsumer overrides redis.Cmdable.XGroupCreateConsumer to log execution metrics.

func (*CmdableWrapper) XGroupCreateMkStream

func (c *CmdableWrapper) XGroupCreateMkStream(ctx context.Context, stream, group, start string) *redis.StatusCmd

XGroupCreateMkStream overrides redis.Cmdable.XGroupCreateMkStream to log execution metrics.

func (*CmdableWrapper) XGroupDelConsumer

func (c *CmdableWrapper) XGroupDelConsumer(ctx context.Context, stream, group, consumer string) *redis.IntCmd

XGroupDelConsumer overrides redis.Cmdable.XGroupDelConsumer to log execution metrics.

func (*CmdableWrapper) XGroupDestroy

func (c *CmdableWrapper) XGroupDestroy(ctx context.Context, stream, group string) *redis.IntCmd

XGroupDestroy overrides redis.Cmdable.XGroupDestroy to log execution metrics.

func (*CmdableWrapper) XGroupSetID

func (c *CmdableWrapper) XGroupSetID(ctx context.Context, stream, group, start string) *redis.StatusCmd

XGroupSetID overrides redis.Cmdable.XGroupSetID to log execution metrics.

func (*CmdableWrapper) XInfoConsumers

func (c *CmdableWrapper) XInfoConsumers(ctx context.Context, key, group string) *redis.XInfoConsumersCmd

XInfoConsumers overrides redis.Cmdable.XInfoConsumers to log execution metrics.

func (*CmdableWrapper) XInfoGroups

func (c *CmdableWrapper) XInfoGroups(ctx context.Context, key string) *redis.XInfoGroupsCmd

XInfoGroups overrides redis.Cmdable.XInfoGroups to log execution metrics.

func (*CmdableWrapper) XInfoStream

func (c *CmdableWrapper) XInfoStream(ctx context.Context, key string) *redis.XInfoStreamCmd

XInfoStream overrides redis.Cmdable.XInfoStream to log execution metrics.

func (*CmdableWrapper) XInfoStreamFull

func (c *CmdableWrapper) XInfoStreamFull(ctx context.Context, key string, count int) *redis.XInfoStreamFullCmd

XInfoStreamFull overrides redis.Cmdable.XInfoStreamFull to log execution metrics.

func (*CmdableWrapper) XLen

func (c *CmdableWrapper) XLen(ctx context.Context, stream string) *redis.IntCmd

XLen overrides redis.Cmdable.XLen to log execution metrics.

func (*CmdableWrapper) XPending

func (c *CmdableWrapper) XPending(ctx context.Context, stream, group string) *redis.XPendingCmd

XPending overrides redis.Cmdable.XPending to log execution metrics.

func (*CmdableWrapper) XPendingExt

func (c *CmdableWrapper) XPendingExt(ctx context.Context, args *redis.XPendingExtArgs) *redis.XPendingExtCmd

XPendingExt overrides redis.Cmdable.XPendingExt to log execution metrics.

func (*CmdableWrapper) XRange

func (c *CmdableWrapper) XRange(ctx context.Context, stream, start, stop string) *redis.XMessageSliceCmd

XRange overrides redis.Cmdable.XRange to log execution metrics.

func (*CmdableWrapper) XRangeN

func (c *CmdableWrapper) XRangeN(ctx context.Context, stream, start, stop string, count int64) *redis.XMessageSliceCmd

XRangeN overrides redis.Cmdable.XRangeN to log execution metrics.

func (*CmdableWrapper) XRead

func (c *CmdableWrapper) XRead(ctx context.Context, args *redis.XReadArgs) *redis.XStreamSliceCmd

XRead overrides redis.Cmdable.XRead to log execution metrics.

func (*CmdableWrapper) XReadGroup

func (c *CmdableWrapper) XReadGroup(ctx context.Context, args *redis.XReadGroupArgs) *redis.XStreamSliceCmd

XReadGroup overrides redis.Cmdable.XReadGroup to log execution metrics.

func (*CmdableWrapper) XRevRange

func (c *CmdableWrapper) XRevRange(ctx context.Context, stream, start, stop string) *redis.XMessageSliceCmd

XRevRange overrides redis.Cmdable.XRevRange to log execution metrics.

func (*CmdableWrapper) XRevRangeN

func (c *CmdableWrapper) XRevRangeN(ctx context.Context, stream, start, stop string, count int64) *redis.XMessageSliceCmd

XRevRangeN overrides redis.Cmdable.XRevRangeN to log execution metrics.

func (*CmdableWrapper) XTrimMaxLen

func (c *CmdableWrapper) XTrimMaxLen(ctx context.Context, key string, maxLen int64) *redis.IntCmd

XTrimMaxLen overrides redis.Cmdable.XTrimMaxLen to log execution metrics.

func (*CmdableWrapper) XTrimMaxLenApprox

func (c *CmdableWrapper) XTrimMaxLenApprox(ctx context.Context, key string, maxLen, limit int64) *redis.IntCmd

XTrimMaxLenApprox overrides redis.Cmdable.XTrimMaxLenApprox to log execution metrics.

func (*CmdableWrapper) XTrimMinID

func (c *CmdableWrapper) XTrimMinID(ctx context.Context, key, minId string) *redis.IntCmd

XTrimMinID overrides redis.Cmdable.XTrimMinID to log execution metrics.

func (*CmdableWrapper) XTrimMinIDApprox

func (c *CmdableWrapper) XTrimMinIDApprox(ctx context.Context, key, minId string, limit int64) *redis.IntCmd

XTrimMinIDApprox overrides redis.Cmdable.XTrimMinIDApprox to log execution metrics.

func (*CmdableWrapper) ZAdd

func (c *CmdableWrapper) ZAdd(ctx context.Context, key string, values ...*redis.Z) *redis.IntCmd

ZAdd overrides redis.Cmdable.ZAdd to log execution metrics.

func (*CmdableWrapper) ZCard

func (c *CmdableWrapper) ZCard(ctx context.Context, key string) *redis.IntCmd

ZCard overrides redis.Cmdable.ZCard to log execution metrics.

func (*CmdableWrapper) ZCount

func (c *CmdableWrapper) ZCount(ctx context.Context, key, min, max string) *redis.IntCmd

ZCount overrides redis.Cmdable.ZCount to log execution metrics.

func (*CmdableWrapper) ZDiff

func (c *CmdableWrapper) ZDiff(ctx context.Context, keys ...string) *redis.StringSliceCmd

ZDiff overrides redis.Cmdable.ZDiff to log execution metrics.

func (*CmdableWrapper) ZDiffStore

func (c *CmdableWrapper) ZDiffStore(ctx context.Context, destKey string, keys ...string) *redis.IntCmd

ZDiffStore overrides redis.Cmdable.ZDiffStore to log execution metrics.

func (*CmdableWrapper) ZDiffWithScores

func (c *CmdableWrapper) ZDiffWithScores(ctx context.Context, keys ...string) *redis.ZSliceCmd

ZDiffWithScores overrides redis.Cmdable.ZDiffWithScores to log execution metrics.

func (*CmdableWrapper) ZIncrBy

func (c *CmdableWrapper) ZIncrBy(ctx context.Context, key string, increment float64, value string) *redis.FloatCmd

ZIncrBy overrides redis.Cmdable.ZIncrBy to log execution metrics.

func (*CmdableWrapper) ZInter

func (c *CmdableWrapper) ZInter(ctx context.Context, store *redis.ZStore) *redis.StringSliceCmd

ZInter overrides redis.Cmdable.ZInter to log execution metrics.

func (*CmdableWrapper) ZInterStore

func (c *CmdableWrapper) ZInterStore(ctx context.Context, destKey string, store *redis.ZStore) *redis.IntCmd

ZInterStore overrides redis.Cmdable.ZInterStore to log execution metrics.

func (*CmdableWrapper) ZInterWithScores

func (c *CmdableWrapper) ZInterWithScores(ctx context.Context, store *redis.ZStore) *redis.ZSliceCmd

ZInterWithScores overrides redis.Cmdable.ZInterWithScores to log execution metrics.

func (*CmdableWrapper) ZLexCount

func (c *CmdableWrapper) ZLexCount(ctx context.Context, key, min, max string) *redis.IntCmd

ZLexCount overrides redis.Cmdable.ZLexCount to log execution metrics.

func (*CmdableWrapper) ZMScore

func (c *CmdableWrapper) ZMScore(ctx context.Context, key string, values ...string) *redis.FloatSliceCmd

ZMScore overrides redis.Cmdable.ZMScore to log execution metrics.

func (*CmdableWrapper) ZPopMax

func (c *CmdableWrapper) ZPopMax(ctx context.Context, key string, count ...int64) *redis.ZSliceCmd

ZPopMax overrides redis.Cmdable.ZPopMax to log execution metrics.

func (*CmdableWrapper) ZPopMin

func (c *CmdableWrapper) ZPopMin(ctx context.Context, key string, count ...int64) *redis.ZSliceCmd

ZPopMin overrides redis.Cmdable.ZPopMin to log execution metrics.

func (*CmdableWrapper) ZRandMember

func (c *CmdableWrapper) ZRandMember(ctx context.Context, key string, count int, withScores bool) *redis.StringSliceCmd

ZRandMember overrides redis.Cmdable.ZRandMember to log execution metrics.

func (*CmdableWrapper) ZRange

func (c *CmdableWrapper) ZRange(ctx context.Context, key string, start, stop int64) *redis.StringSliceCmd

ZRange overrides redis.Cmdable.ZRange to log execution metrics.

func (*CmdableWrapper) ZRangeArgs

func (c *CmdableWrapper) ZRangeArgs(ctx context.Context, args redis.ZRangeArgs) *redis.StringSliceCmd

ZRangeArgs overrides redis.Cmdable.ZRangeArgs to log execution metrics.

func (*CmdableWrapper) ZRangeArgsWithScores

func (c *CmdableWrapper) ZRangeArgsWithScores(ctx context.Context, args redis.ZRangeArgs) *redis.ZSliceCmd

ZRangeArgsWithScores overrides redis.Cmdable.ZRangeArgsWithScores to log execution metrics.

func (*CmdableWrapper) ZRangeByLex

func (c *CmdableWrapper) ZRangeByLex(ctx context.Context, key string, opts *redis.ZRangeBy) *redis.StringSliceCmd

ZRangeByLex overrides redis.Cmdable.ZRangeByLex to log execution metrics.

@Deprecated since Redis 6.2.0, use ZRangeArgs instead.

func (*CmdableWrapper) ZRangeByScore

func (c *CmdableWrapper) ZRangeByScore(ctx context.Context, key string, opts *redis.ZRangeBy) *redis.StringSliceCmd

ZRangeByScore overrides redis.Cmdable.ZRangeByScore to log execution metrics.

@Deprecated since Redis 6.2.0, use ZRangeArgs instead.

func (*CmdableWrapper) ZRangeByScoreWithScores

func (c *CmdableWrapper) ZRangeByScoreWithScores(ctx context.Context, key string, opts *redis.ZRangeBy) *redis.ZSliceCmd

ZRangeByScoreWithScores overrides redis.Cmdable.ZRangeByScoreWithScores to log execution metrics.

@Deprecated since Redis 6.2.0, use ZRangeArgs instead.

func (*CmdableWrapper) ZRangeStore

func (c *CmdableWrapper) ZRangeStore(ctx context.Context, destKey string, args redis.ZRangeArgs) *redis.IntCmd

ZRangeStore overrides redis.Cmdable.ZRangeStore to log execution metrics.

func (*CmdableWrapper) ZRangeWithScores

func (c *CmdableWrapper) ZRangeWithScores(ctx context.Context, key string, start, stop int64) *redis.ZSliceCmd

ZRangeWithScores overrides redis.Cmdable.ZRangeWithScores to log execution metrics.

func (*CmdableWrapper) ZRank

func (c *CmdableWrapper) ZRank(ctx context.Context, key, member string) *redis.IntCmd

ZRank overrides redis.Cmdable.ZRank to log execution metrics.

func (*CmdableWrapper) ZRem

func (c *CmdableWrapper) ZRem(ctx context.Context, key string, members ...interface{}) *redis.IntCmd

ZRem overrides redis.Cmdable.ZRem to log execution metrics.

func (*CmdableWrapper) ZRemRangeByLex

func (c *CmdableWrapper) ZRemRangeByLex(ctx context.Context, key, min, max string) *redis.IntCmd

ZRemRangeByLex overrides redis.Cmdable.ZRemRangeByLex to log execution metrics.

func (*CmdableWrapper) ZRemRangeByRank

func (c *CmdableWrapper) ZRemRangeByRank(ctx context.Context, key string, start, stop int64) *redis.IntCmd

ZRemRangeByRank overrides redis.Cmdable.ZRemRangeByRank to log execution metrics.

func (*CmdableWrapper) ZRemRangeByScore

func (c *CmdableWrapper) ZRemRangeByScore(ctx context.Context, key, min, max string) *redis.IntCmd

ZRemRangeByScore overrides redis.Cmdable.ZRemRangeByScore to log execution metrics.

func (*CmdableWrapper) ZRevRange

func (c *CmdableWrapper) ZRevRange(ctx context.Context, key string, start, stop int64) *redis.StringSliceCmd

ZRevRange overrides redis.Cmdable.ZRevRange to log execution metrics.

@Deprecated since Redis 6.2.0, use ZRangeArgs instead.

func (*CmdableWrapper) ZRevRangeByLex

func (c *CmdableWrapper) ZRevRangeByLex(ctx context.Context, key string, opts *redis.ZRangeBy) *redis.StringSliceCmd

ZRevRangeByLex overrides redis.Cmdable.ZRevRangeByLex to log execution metrics.

@Deprecated since Redis 6.2.0, use ZRangeArgs instead.

func (*CmdableWrapper) ZRevRangeByScore

func (c *CmdableWrapper) ZRevRangeByScore(ctx context.Context, key string, opts *redis.ZRangeBy) *redis.StringSliceCmd

ZRevRangeByScore overrides redis.Cmdable.ZRevRangeByScore to log execution metrics.

@Deprecated since Redis 6.2.0, use ZRangeArgs instead.

func (*CmdableWrapper) ZRevRangeByScoreWithScores

func (c *CmdableWrapper) ZRevRangeByScoreWithScores(ctx context.Context, key string, opts *redis.ZRangeBy) *redis.ZSliceCmd

ZRevRangeByScoreWithScores overrides redis.Cmdable.ZRevRangeByScoreWithScores to log execution metrics.

@Deprecated since Redis 6.2.0, use ZRangeArgs instead.

func (*CmdableWrapper) ZRevRangeWithScores

func (c *CmdableWrapper) ZRevRangeWithScores(ctx context.Context, key string, start, stop int64) *redis.ZSliceCmd

ZRevRangeWithScores overrides redis.Cmdable.ZRevRangeWithScores to log execution metrics.

@Deprecated since Redis 6.2.0, use ZRangeArgs instead.

func (*CmdableWrapper) ZRevRank

func (c *CmdableWrapper) ZRevRank(ctx context.Context, key string, member string) *redis.IntCmd

ZRevRank overrides redis.Cmdable.ZRevRank to log execution metrics.

func (*CmdableWrapper) ZScan

func (c *CmdableWrapper) ZScan(ctx context.Context, key string, cursor uint64, match string, count int64) *redis.ScanCmd

ZScan overrides redis.Cmdable.ZScan to log execution metrics.

func (*CmdableWrapper) ZScore

func (c *CmdableWrapper) ZScore(ctx context.Context, key, member string) *redis.FloatCmd

ZScore overrides redis.Cmdable.ZScore to log execution metrics.

func (*CmdableWrapper) ZUnion

func (c *CmdableWrapper) ZUnion(ctx context.Context, store redis.ZStore) *redis.StringSliceCmd

ZUnion overrides redis.Cmdable.ZUnion to log execution metrics.

func (*CmdableWrapper) ZUnionStore

func (c *CmdableWrapper) ZUnionStore(ctx context.Context, destKey string, store *redis.ZStore) *redis.IntCmd

ZUnionStore overrides redis.Cmdable.ZUnionStore to log execution metrics.

func (*CmdableWrapper) ZUnionWithScores

func (c *CmdableWrapper) ZUnionWithScores(ctx context.Context, store redis.ZStore) *redis.ZSliceCmd

ZUnionWithScores overrides redis.Cmdable.ZUnionWithScores to log execution metrics.

type GoRedisConnect

type GoRedisConnect struct {
	// contains filtered or unexported fields
}

GoRedisConnect holds a go-redis client (https://github.com/go-redis/redis) that can be shared within the application.

func NewGoRedisConnect

func NewGoRedisConnect(hostsAndPorts, password string, maxRetries int) (*GoRedisConnect, error)

NewGoRedisConnect constructs a new GoRedisConnect instance with supplied options and default Redis pool options.

Parameters: see NewGoRedisConnectWithPoolOptions

func NewGoRedisConnectWithPoolOptions

func NewGoRedisConnectWithPoolOptions(hostsAndPorts, password string, maxRetries int, poolOpts *RedisPoolOpts) (*GoRedisConnect, error)

NewGoRedisConnectWithPoolOptions constructs a new GoRedisConnect instance with supplied options and default Redis pool options.

Parameters:

  • hostsAndPorts: list of Redis servers (example: "host1:6379,host2;host3:6380")
  • password : password to authenticate against Redis server
  • maxRetries : max number of retries for failed operations
  • poolOpts : Redis connection pool settings

Available since v0.2.8

func (*GoRedisConnect) Close

func (r *GoRedisConnect) Close() error

Close closes all underlying Redis connections associated with this GoRedisConnect.

Available: since v0.2.0

func (*GoRedisConnect) GetClient

func (r *GoRedisConnect) GetClient(db int) *redis.Client

GetClient returns the redis.Client associated with the specified db number.

Note: do NOT close the returned client (e.g. call redis.Client.Close()).

This function uses the first entry of 'hostsAndPorts' as Redis server address. This function returns the existing client, if any (i.e. no new redis.Client instance will be created).

func (*GoRedisConnect) GetClientProxy

func (r *GoRedisConnect) GetClientProxy(db int) *RedisClientProxy

GetClientProxy is similar to GetClient, but returns a proxy that can be used as a replacement.

Available since v0.3.0

func (*GoRedisConnect) GetClusterClient

func (r *GoRedisConnect) GetClusterClient() *redis.ClusterClient

GetClusterClient returns the redis.ClusterClient associated with the GoRedisConnect.

Note: do NOT close the returned client (e.g. call redis.ClusterClient.Close()).

This function uses 'hostsAndPorts' config as list of Redis server addresses. This function returns the existing client, if any (i.e. no new redis.ClusterClient instance will be created).

func (*GoRedisConnect) GetClusterClientProxy

func (r *GoRedisConnect) GetClusterClientProxy() *RedisClusterClientProxy

GetClusterClientProxy is similar to GetClusterClient, but returns a proxy that can be used as a replacement.

Available since v0.3.0

func (*GoRedisConnect) GetFailoverClient

func (r *GoRedisConnect) GetFailoverClient(db int) *redis.Client

GetFailoverClient returns the failover redis.Client associated with the specified db number.

Note: do NOT close the returned client (e.g. call redis.Client.Close()).

This function uses 'hostsAndPorts' config as list of Redis Sentinel server addresses. This function returns the existing client, if any (i.e. no new redis.Client instance will be created).

func (*GoRedisConnect) GetFailoverClientProxy

func (r *GoRedisConnect) GetFailoverClientProxy(db int) *RedisFailoverClientProxy

GetFailoverClientProxy is similar to GetFailoverClient, but returns a proxy that can be used as a replacement.

Available since v0.3.0

func (*GoRedisConnect) GetRedisPoolOpts

func (r *GoRedisConnect) GetRedisPoolOpts() *RedisPoolOpts

GetRedisPoolOpts returns Redis connection pool configurations.

Available: since v0.2.8

func (*GoRedisConnect) GetSentinelMasterName

func (r *GoRedisConnect) GetSentinelMasterName() string

GetSentinelMasterName returns the current sentinel master name.

Available: since v0.2.8

func (*GoRedisConnect) GetSlaveReadOnly

func (r *GoRedisConnect) GetSlaveReadOnly() bool

GetSlaveReadOnly returns the current value of 'slaveReadOnly' setting.

Available: since v0.2.8

func (*GoRedisConnect) Init

func (r *GoRedisConnect) Init() error

Init should be called to initialize the GoRedisConnect instance before use.

Available since v0.3.0

func (*GoRedisConnect) LogMetrics

func (r *GoRedisConnect) LogMetrics(category string, cmd *prom.CmdExecInfo) error

LogMetrics is convenient function to put the CmdExecInfo to the metrics log.

This function is silently no-op of the input if nil or there is no associated metrics logger.

Available since v0.3.0

func (*GoRedisConnect) Metrics

func (r *GoRedisConnect) Metrics(category string, opts ...prom.MetricsOpts) (*prom.Metrics, error)

Metrics is convenient function to capture the snapshot of command execution metrics.

This function is silently no-op of there is no associated metrics logger.

Available since v0.3.0

func (*GoRedisConnect) MetricsLogger

func (r *GoRedisConnect) MetricsLogger() prom.IMetricsLogger

MetricsLogger returns the associated IMetricsLogger instance.

Available since v0.3.0

func (*GoRedisConnect) NewCmdExecInfo

func (r *GoRedisConnect) NewCmdExecInfo() *prom.CmdExecInfo

NewCmdExecInfo is convenient function to create a new CmdExecInfo instance.

The returned CmdExecInfo has its 'id' and 'begin-time' fields initialized.

Available since v0.3.0

func (*GoRedisConnect) RegisterMetricsLogger

func (r *GoRedisConnect) RegisterMetricsLogger(metricsLogger prom.IMetricsLogger) *GoRedisConnect

RegisterMetricsLogger associates an IMetricsLogger instance with this GoRedisConnect. If non-nil, GoRedisConnect automatically logs executing commands.

Available since v0.3.0

func (*GoRedisConnect) SetRedisPoolOpts

func (r *GoRedisConnect) SetRedisPoolOpts(opts *RedisPoolOpts) *GoRedisConnect

SetRedisPoolOpts sets Redis connection pool configurations.

The change will apply to newly created clients, existing one will NOT be effected! This function returns the current GoRedisConnect instance so that function calls can be chained.

Available: since v0.2.8

func (*GoRedisConnect) SetSentinelMasterName

func (r *GoRedisConnect) SetSentinelMasterName(masterName string) *GoRedisConnect

SetSentinelMasterName sets the sentinel master name, used by failover clients.

The change will apply to newly created clients, existing one will NOT be effected! This function returns the current GoRedisConnect instance so that function calls can be chained.

func (*GoRedisConnect) SetSlaveReadOnly

func (r *GoRedisConnect) SetSlaveReadOnly(readOnly bool) *GoRedisConnect

SetSlaveReadOnly enables/disables read-only commands on slave nodes.

The change will apply to newly created clients, existing one will NOT be effected! This function returns the current GoRedisConnect instance so that function calls can be chained.

type RedisClientProxy

type RedisClientProxy struct {
	CmdableWrapper
}

RedisClientProxy is a proxy that can be used as replacement for redis.Client.

This proxy overrides some functions from redis.Client and automatically logs the execution metrics.

Available since v0.3.0

func (*RedisClientProxy) PSubscribe

func (cp *RedisClientProxy) PSubscribe(ctx context.Context, channels ...string) *redis.PubSub

PSubscribe overrides redis.Client.PSubscribe to log execution metrics.

func (*RedisClientProxy) Subscribe

func (cp *RedisClientProxy) Subscribe(ctx context.Context, channels ...string) *redis.PubSub

Subscribe overrides redis.Client.Subscribe to log execution metrics.

func (*RedisClientProxy) Wait

func (cp *RedisClientProxy) Wait(ctx context.Context, numSlaves int, timeout time.Duration) *redis.IntCmd

Wait overrides redis.Client.Wait to log execution metrics.

type RedisClusterClientProxy

type RedisClusterClientProxy struct {
	CmdableWrapper
}

RedisClusterClientProxy is a proxy that can be used as replacement for failover redis.ClusterClient.

This proxy overrides some functions from failover redis.ClusterClient and automatically logs the execution metrics.

Available since v0.3.0

func (*RedisClusterClientProxy) PSubscribe

func (cp *RedisClusterClientProxy) PSubscribe(ctx context.Context, channels ...string) *redis.PubSub

PSubscribe overrides redis.ClusterClient.PSubscribe to log execution metrics.

func (*RedisClusterClientProxy) Subscribe

func (cp *RedisClusterClientProxy) Subscribe(ctx context.Context, channels ...string) *redis.PubSub

Subscribe overrides redis.ClusterClient.Subscribe to log execution metrics.

func (*RedisClusterClientProxy) Wait

func (cp *RedisClusterClientProxy) Wait(ctx context.Context, numSlaves int, timeout time.Duration) *redis.IntCmd

Wait overrides redis.ClusterClient.Wait to log execution metrics.

type RedisFailoverClientProxy

type RedisFailoverClientProxy struct {
	RedisClientProxy
}

RedisFailoverClientProxy is a proxy that can be used as replacement for failover redis.Client.

This proxy overrides some functions from failover redis.Client and automatically logs the execution metrics.

Available since v0.3.0

type RedisPoolOpts

type RedisPoolOpts struct {
	// Dial timeout for establishing new connections.
	// Set zero or negative value to use go-redis' default value.
	DialTimeout time.Duration
	// Timeout for socket reads.
	// Set zero or negative value to use go-redis' default value.
	ReadTimeout time.Duration
	// Timeout for socket writes.
	// Set zero or negative value to use go-redis' default value.
	WriteTimeout time.Duration

	// Maximum number of connections.
	// Set zero or negative value to use go-redis' default value.
	PoolSize int
	// Minimum number of idle connections. Default value is 1.
	MinIdleConns int
}

RedisPoolOpts holds options to configure Redis connection pool.

Available: since v0.2.8

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL