redis

func Expire ¶

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

func ExpireAt ¶

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

func HExists ¶

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

HExists HExists

func HMSet ¶

func HMSet(ctx context.Context, key string, values ...interface{}) *BoolCmd

HMSet is a deprecated version of HSet left for compatibility with Redis 3.

func HSetNX ¶

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

HSetNX HSetNX

func MSetNX ¶

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

MSetNX is like SetNX but accepts multiple values:

• MSetNX("key1", "value1", "key2", "value2")
• MSetNX([]string{"key1", "value1", "key2", "value2"})
• MSetNX(map[string]interface{}{"key1": "value1", "key2": "value2"})

func SIsMember ¶

func SIsMember(ctx context.Context, key string, member interface{}) *BoolCmd

SIsMember SIsMember

func SMove ¶

func SMove(ctx context.Context, source, destination string, member interface{}) *BoolCmd

SMove SMove

func SetNX ¶

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

SetNX Redis `SET key value [expiration] NX` command.

Zero expiration means the key has no expiration time. KeepTTL(-1) expiration is a Redis KEEPTTL option to keep existing TTL.

func SetXX ¶

func SetXX(ctx context.Context, key string, value interface{}, expiration time.Duration) *BoolCmd

SetXX Redis `SET key value [expiration] XX` command.

Zero expiration means the key has no expiration time. KeepTTL(-1) expiration is a Redis KEEPTTL option to keep existing TTL.

func ScriptExists ¶

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

ScriptExists ScriptExists

func CacheInit ¶

func CacheInit(c *Config) *CacheRides

Init connects to the database.

func Do ¶

func Do(ctx context.Context, args ...interface{}) *Cmd

Do creates a Cmd from the args and processes the cmd.

func Eval ¶

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

Eval Eval

func EvalSha ¶

func EvalSha(ctx context.Context, sha1 string, keys []string, args ...interface{}) *Cmd

EvalSha EvalSha

func Pipelined ¶

func Pipelined(ctx context.Context, fn func(Pipeliner) error) ([]Cmder, error)

func TxPipelined ¶

func TxPipelined(ctx context.Context, fn func(Pipeliner) error) ([]Cmder, error)

func GeoDist ¶

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

GeoDist GeoDist

func HIncrByFloat ¶

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

HIncrByFloat HIncrByFloat

func ZIncr ¶

func ZIncr(ctx context.Context, key string, member *Z) *FloatCmd

ZIncr Redis `ZADD key INCR score member` command.

func ZIncrBy ¶

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

ZIncrBy ZIncrBy

func ZIncrNX ¶

func ZIncrNX(ctx context.Context, key string, member *Z) *FloatCmd

ZIncrNX Redis `ZADD key NX INCR score member` command.

func ZIncrXX ¶

func ZIncrXX(ctx context.Context, key string, member *Z) *FloatCmd

ZIncrXX Redis `ZADD key XX INCR score member` command.

func ZScore ¶

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

ZScore ZScore

func GeoRadius ¶

func GeoRadius(ctx context.Context, key string, longitude, latitude float64, query *GeoRadiusQuery) *GeoLocationCmd

GeoRadius is a read-only GEORADIUS_RO command.

func GeoRadiusByMember ¶

func GeoRadiusByMember(ctx context.Context, key, member string, query *GeoRadiusQuery) *GeoLocationCmd

GeoRadiusByMember GeoRadius is a read-only GEORADIUSBYMEMBER_RO command.

func GeoPos ¶

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

GeoPos GeoPos

func Append ¶

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

func BitCount ¶

func BitCount(ctx context.Context, key string, start, end int64) *IntCmd

BitCount BitCount

func BitOpAnd ¶

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

BitOpAnd BitOpAnd

func BitOpNot ¶

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

BitOpNot BitOpNot

func BitOpOr ¶

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

BitOpOr BitOpOr

func BitOpXor ¶

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

BitOpXor BitOpXor

func BitPos ¶

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

BitPos BitPos

func Del ¶

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

Del Del

func Exists ¶

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

func GeoAdd ¶

func GeoAdd(ctx context.Context, key string, geoLocation ...*GeoLocation) *IntCmd

GeoAdd

func GeoRadiusByMemberStore ¶

func GeoRadiusByMemberStore(ctx context.Context, key, member string, query *GeoRadiusQuery) *IntCmd

GeoRadiusByMemberStore is a writing GEORADIUSBYMEMBER command.

func GeoRadiusStore ¶

func GeoRadiusStore(ctx context.Context, key string, longitude, latitude float64, query *GeoRadiusQuery) *IntCmd

GeoRadiusStore is a writing GEORADIUS command.

func GetBit ¶

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

GetBit GetBit

func HDel ¶

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

HDel HDel

func HIncrBy ¶

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

HIncrBy HIncrBy

func HLen ¶

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

HLen HLen

func HSet ¶

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

HSet accepts values in following formats:

• HSet("myhash", "key1", "value1", "key2", "value2")
• HSet("myhash", []string{"key1", "value1", "key2", "value2"})
• HSet("myhash", map[string]interface{}{"key1": "value1", "key2": "value2"})

Note that it requires Redis v4 for multiple field/value pairs support.

func Incr ¶

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

func IncrBy ¶

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

func LInsert ¶

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

LInsert LInsert

func LInsertAfter ¶

func LInsertAfter(ctx context.Context, key string, pivot, value interface{}) *IntCmd

LInsertAfter LInsertAfter

func LInsertBefore ¶

func LInsertBefore(ctx context.Context, key string, pivot, value interface{}) *IntCmd

LInsertBefore LInsertBefore

func LLen ¶

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

LLen LLen

func LPush ¶

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

LPush LPush

func LPushX ¶

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

LPushX LPushX

func LRem ¶

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

LRem LRem

func PubSubNumPat ¶

func PubSubNumPat(ctx context.Context) *IntCmd

PubSubNumPat PubSubNumPat

func Publish ¶

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

Publish posts the message to the channel.

func RPush ¶

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

RPush RPush

func RPushX ¶

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

RPushX RPushX

func SAdd ¶

func SAdd(ctx context.Context, key string, members ...interface{}) *IntCmd

SAdd SAdd

func SCard ¶

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

SCard SCard

func SDiffStore ¶

func SDiffStore(ctx context.Context, destination string, keys ...string) *IntCmd

SDiffStore SDiffStore

func SInterStore ¶

func SInterStore(ctx context.Context, destination string, keys ...string) *IntCmd

SInterStore SInterStore

func SRem ¶

func SRem(ctx context.Context, key string, members ...interface{}) *IntCmd

SRem SRem

func SUnionStore ¶

func SUnionStore(ctx context.Context, destination string, keys ...string) *IntCmd

SUnionStore SUnionStore

func SetBit ¶

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

SetBit SetBit

func SetRange ¶

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

SetRange SetRange

func StrLen ¶

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

StrLen StrLen

func ZAdd ¶

func ZAdd(ctx context.Context, key string, members ...*Z) *IntCmd

ZAdd Redis `ZADD key score member [score member ...]` command.

func ZAddCh ¶

func ZAddCh(ctx context.Context, key string, members ...*Z) *IntCmd

ZAddCh Redis `ZADD key CH score member [score member ...]` command.

func ZAddNX ¶

func ZAddNX(ctx context.Context, key string, members ...*Z) *IntCmd

ZAddNX Redis `ZADD key NX score member [score member ...]` command.

func ZAddNXCh ¶

func ZAddNXCh(ctx context.Context, key string, members ...*Z) *IntCmd

ZAddNXCh Redis `ZADD key NX CH score member [score member ...]` command.

func ZAddXX ¶

func ZAddXX(ctx context.Context, key string, members ...*Z) *IntCmd

ZAddXX Redis `ZADD key XX score member [score member ...]` command.

func ZAddXXCh ¶

func ZAddXXCh(ctx context.Context, key string, members ...*Z) *IntCmd

ZAddXXCh Redis `ZADD key XX CH score member [score member ...]` command.

func ZCard ¶

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

ZCard ZCard

func ZCount ¶

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

ZCount ZCount

func ZInterStore ¶

func ZInterStore(ctx context.Context, destination string, store *ZStore) *IntCmd

ZInterStore ZInterStore

func ZLexCount ¶

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

ZLexCount ZLexCount

func ZRank ¶

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

ZRank ZRank

func ZRem ¶

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

ZRem ZRem

func ZRemRangeByLex ¶

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

ZRemRangeByLex ZRemRangeByLex

func ZRemRangeByRank ¶

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

ZRemRangeByRank ZRemRangeByRank

func ZRemRangeByScore ¶

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

ZRemRangeByScore ZRemRangeByScore

func ZRevRank ¶

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

ZRevRank ZRevRank

func ZUnionStore ¶

func ZUnionStore(ctx context.Context, dest string, store *ZStore) *IntCmd

ZUnionStore ZUnionStore

func BitField ¶

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

BitField BitField

func GetOptions ¶

func GetOptions() *Options

Options returns read-only Options that were used to create the client.

func Pipeline ¶

func Pipeline() Pipeliner

func TxPipeline ¶

func TxPipeline() Pipeliner

TxPipeline acts like Pipeline, but wraps queued commands with MULTI/EXEC.

func PoolStats ¶

func PoolStats() *PoolState

PoolStats returns connection pool stats.

func PSubscribe ¶

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

PSubscribe subscribes the client to the given patterns. Patterns can be omitted to create empty subscription.

func Subscribe ¶

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

Subscribe subscribes the client to the specified channels. Channels can be omitted to create empty subscription. Note that this method does not wait on a response from Redis, so the subscription may not be active immediately. To force the connection to wait, you may call the Receive() method on the returned *PubSub like so:

sub := client.Subscribe(queryResp)
iface, err := sub.Receive()
if err != nil {
    // handle error
}

// Should be *Subscription, but others are possible if other actions have been
// taken on sub since it was created.
switch iface.(type) {
case *Subscription:
    // subscribe succeeded
case *Message:
    // received first message
case *Pong:
    // pong received
default:
    // handle error
}

ch := sub.Channel()

func HScan ¶

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

HScan HScan

func SScan ¶

func SScan(ctx context.Context, key string, cursor uint64, match string, count int64) *ScanCmd

SScan SScan

func Scan ¶

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

Scan Scan

func ZScan ¶

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

ZScan ZScan

func HMGet ¶

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

HMGet returns the values for the specified fields in the hash stored at key. It returns an interface{} to distinguish between empty string and nil value.

func LSet ¶

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

LSet LSet

func LTrim ¶

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

LTrim LTrim

func MSet ¶

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

MSet is like Set but accepts multiple values:

• MSet("key1", "value1", "key2", "value2")
• MSet([]string{"key1", "value1", "key2", "value2"})
• MSet(map[string]interface{}{"key1": "value1", "key2": "value2"})

func ScriptFlush ¶

func ScriptFlush(ctx context.Context) *StatusCmd

ScriptFlush ScriptFlush

func ScriptKill ¶

func ScriptKill(ctx context.Context) *StatusCmd

ScriptKill ScriptKill

func Set ¶

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

Set Redis `SET key value [expiration]` command. Use expiration for `SETEX`-like behavior.

Zero expiration means the key has no expiration time. KeepTTL(-1) expiration is a Redis KEEPTTL option to keep existing TTL.

func BRPopLPush ¶

func BRPopLPush(ctx context.Context, source, destination string, timeout time.Duration) *StringCmd

BRPopLPush BRPopLPush

func Get ¶

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

Get `GET key` command. It returns redis.Nil error when key does not exist.

func HGet ¶

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

HGet HGet

func LIndex ¶

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

LIndex LIndex

func LPop ¶

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

LPop LPop

func RPop ¶

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

RPop RPop

func RPopLPush ¶

func RPopLPush(ctx context.Context, source, destination string) *StringCmd

RPopLPush RPopLPush

func SPop ¶

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

SPop Redis `SPOP key` command.

func SRandMember ¶

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

SRandMember Redis `SRANDMEMBER key` command.

func ScriptLoad ¶

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

ScriptLoad ScriptLoad

func PubSubNumSub ¶

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

PubSubNumSub PubSubNumSub

func BLPop ¶

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

BLPop BLPop

func BRPop ¶

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

BRPop BRPop

func GeoHash ¶

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

GeoHash GeoHash

func HKeys ¶

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

HKeys HKeys

func HVals ¶

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

HVals HVals

func LRange ¶

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

LRange LRange

func PubSubChannels ¶

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

PubSubChannels PubSubChannels

func SDiff ¶

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

SDiff SDiff

func SInter ¶

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

SInter SInter

func SMembers ¶

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

SMembers Redis `SMEMBERS key` command output as a slice.

func SPopN ¶

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

SPopN Redis `SPOP key count` command.

func SRandMemberN ¶

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

SRandMemberN Redis `SRANDMEMBER key count` command.

func SUnion ¶

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

SUnion SUnion

func ZRange ¶

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

ZRange ZRange

func ZRangeByLex ¶

func ZRangeByLex(ctx context.Context, key string, opt *ZRangeBy) *StringSliceCmd

ZRangeByLex ZRangeByLex

func ZRangeByScore ¶

func ZRangeByScore(ctx context.Context, key string, opt *ZRangeBy) *StringSliceCmd

ZRangeByScore ZRangeByScore

func ZRevRange ¶

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

ZRevRange ZRevRange

func ZRevRangeByLex ¶

func ZRevRangeByLex(ctx context.Context, key string, opt *ZRangeBy) *StringSliceCmd

ZRevRangeByLex ZRevRangeByLex

func ZRevRangeByScore ¶

func ZRevRangeByScore(ctx context.Context, key string, opt *ZRangeBy) *StringSliceCmd

ZRevRangeByScore ZRevRangeByScore

func HGetAll ¶

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

HGetAll HGetAll

func SMembersMap ¶

func SMembersMap(ctx context.Context, key string) *StringStructMapCmd

SMembersMap Redis `SMEMBERS key` command output as a map.

func ZPopMax ¶

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

ZPopMax ZPopMax

func ZPopMin ¶

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

ZPopMin ZPopMin

func ZRangeByScoreWithScores ¶

func ZRangeByScoreWithScores(ctx context.Context, key string, opt *ZRangeBy) *ZSliceCmd

ZRangeByScoreWithScores ZRangeByScoreWithScores

func ZRangeWithScores ¶

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

ZRangeWithScores ZRangeWithScores

func ZRevRangeByScoreWithScores ¶

func ZRevRangeByScoreWithScores(ctx context.Context, key string, opt *ZRangeBy) *ZSliceCmd

ZRevRangeByScoreWithScores ZRevRangeByScoreWithScores

func ZRevRangeWithScores ¶

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

ZRevRangeWithScores ZRevRangeWithScores

func BZPopMax ¶

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

BZPopMax Redis `BZPOPMAX key [key ...] timeout` command.

func BZPopMin ¶

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

BZPopMin Redis `BZPOPMIN key [key ...] timeout` command.