valkey

Sep 21, 2025

Changes in this version

+ var ErrReplicaOnlyConflictWithReadNodeSelector = errors.New("ReplicaOnly conflicts with ReadNodeSelector option")

+ var ErrReplicaSelectorConflictWithReadNodeSelector = errors.New("either set ReplicaSelector or ReadNodeSelector, not both")

type ClientOption

+ ReadNodeSelector func(slot uint16, nodes []NodeInfo) int

+ type NodeInfo struct

+ AZ string

+ Addr string

Jul 15, 2025

Changes in this version

+ type Scanner struct

+ func NewScanner(next func(cursor uint64) (ScanEntry, error)) *Scanner

+ func (s *Scanner) Err() error

+ func (s *Scanner) Iter() iter.Seq[string]

+ func (s *Scanner) Iter2() iter.Seq2[string, string]

Jun 6, 2025

Changes in this version

+ func WithOnSubscriptionHook(ctx context.Context, hook func(PubSubSubscription)) context.Context

type ValkeyMessage

+ func (m *ValkeyMessage) AsXRangeSlice() (XRangeSlice, error)

+ func (m *ValkeyMessage) AsXRangeSlices() ([]XRangeSlice, error)

+ func (m *ValkeyMessage) AsXReadSlices() (map[string][]XRangeSlice, error)

type ValkeyResult

+ func (r ValkeyResult) AsXRangeSlice() (v XRangeSlice, err error)

+ func (r ValkeyResult) AsXRangeSlices() (v []XRangeSlice, err error)

+ func (r ValkeyResult) AsXReadSlices() (v map[string][]XRangeSlice, err error)

+ type XRangeFieldValue struct

+ Field string

+ Value string

+ type XRangeSlice struct

+ FieldValues []XRangeFieldValue

+ ID string

May 17, 2025

Changes in this version

type ClientOption

+ ConnLifetime time.Duration

type Lua

+ func NewLuaScriptNoSha(script string) *Lua

+ func NewLuaScriptReadOnlyNoSha(script string) *Lua

Apr 6, 2025

Changes in this version

+ var ErrNoSendToReplicas = errors.New("no SendToReplicas provided for standalone client with replicas")

type ClientOption

+ Standalone StandaloneOption

+ type StandaloneOption struct

+ ReplicaAddress []string

Mar 16, 2025

Changes in this version

+ const ClientModeCluster

+ const ClientModeSentinel

+ const ClientModeStandalone

type Client

+ Mode func() ClientMode

+ type ClientMode string

type ClientOption

+ DialCtxFn func(context.Context, string, *net.Dialer, *tls.Config) (conn net.Conn, err error)

Feb 2, 2025

Changes in this version

type ClientOption

+ EnableReplicaAZInfo bool

type ReplicaInfo

+ AZ string

Dec 24, 2024

Changes in this version

+ var ErrCacheUnmarshal = errors.New("cache unmarshal error")

+ var ErrReplicaOnlyConflictWithReplicaSelector = errors.New("ReplicaOnly conflicts with ReplicaSelector option")

+ var ErrSendToReplicasNotSet = errors.New("SendToReplicas must be set when ReplicaSelector is set")

type ClientOption

+ ReplicaSelector func(slot uint16, replicas []ReplicaInfo) int

+ type ReplicaInfo struct

+ Addr string

type ValkeyMessage

+ func (m *ValkeyMessage) CacheMarshal(buf []byte) []byte

+ func (m *ValkeyMessage) CacheSize() int

+ func (m *ValkeyMessage) CacheUnmarshalView(buf []byte) error

Dec 2, 2024

Changes in this version

type ClientOption

+ BlockingPoolCleanup time.Duration

+ BlockingPoolMinSize int

Nov 8, 2024

Changes in this version

type ValkeyError

+ func (r *ValkeyError) IsLoading() bool

Oct 21, 2024

Changes in this version

+ var ErrBlockingPubSubMixed = errors.New(...)

type ClientOption

+ DisableAutoPipelining bool

+ DisableTCPNoDelay bool

+ RetryDelay RetryDelayFn

+ type RetryDelayFn func(attempts int, cmd Completed, err error) time.Duration

Oct 1, 2024

Changes in this version

+ var ErrInvalidShardsRefreshInterval = errors.New("ShardsRefreshInterval must be greater than or equal to 0")

type ClientOption

+ ClusterOption ClusterOption

+ type ClusterOption struct

+ ShardsRefreshInterval time.Duration

Sep 17, 2024

Changes in this version

+ const DefaultBlockingPipeline

+ var DisableClientSetInfo = make([]string, 0)

type ClientOption

+ BlockingPipeline int

Jul 28, 2024

Changes in this version

+ var ErrDedicatedClientRecycled = errors.New("dedicated client should not be used after recycled")

Jun 25, 2024

Changes in this version

+ func IsParseErr(err error) bool

May 2, 2024

Changes in this version

+ const DefaultCacheBytes

+ const DefaultDialTimeout

+ const DefaultPoolSize

+ const DefaultReadBuffer

+ const DefaultRingScale

+ const DefaultTCPKeepAlive

+ const DefaultWriteBuffer

+ const LibName

+ const LibVer

+ const MaxPipelineMultiplex

+ var ErrClosing = errors.New("valkey client is closing or unable to connect valkey")

+ var ErrDoCacheAborted = errors.New(...)

+ var ErrMSetNXNotSet = errors.New("MSETNX: no key was set")

+ var ErrNoAddr = errors.New("no alive address in InitAddress")

+ var ErrNoCache = errors.New(...)

+ var ErrNoSlot = errors.New("the slot has no valkey node")

+ var ErrRESP2PubSubMixed = errors.New(...)

+ var ErrReplicaOnlyConflict = errors.New("ReplicaOnly conflicts with SendToReplicas option")

+ var ErrReplicaOnlyNotSupported = errors.New("ReplicaOnly is not supported for single client")

+ var ErrWrongPipelineMultiplex = errors.New("ClientOption.PipelineMultiplex must not be bigger than MaxPipelineMultiplex")

+ var Nil = &ValkeyError

+ func BinaryString(bs []byte) string

+ func DecodeSliceOfJSON[T any](result ValkeyResult, dest *[]T) error

+ func IsValkeyBusyGroup(err error) bool

+ func IsValkeyNil(err error) bool

+ func JSON(in any) string

+ func JsonMGet(client Client, ctx context.Context, keys []string, path string) (ret map[string]ValkeyMessage, err error)

+ func JsonMGetCache(client Client, ctx context.Context, ttl time.Duration, keys []string, ...) (ret map[string]ValkeyMessage, err error)

+ func JsonMSet(client Client, ctx context.Context, kvs map[string]string, path string) map[string]error

+ func MDel(client Client, ctx context.Context, keys []string) map[string]error

+ func MGet(client Client, ctx context.Context, keys []string) (ret map[string]ValkeyMessage, err error)

+ func MGetCache(client Client, ctx context.Context, ttl time.Duration, keys []string) (ret map[string]ValkeyMessage, err error)

+ func MSet(client Client, ctx context.Context, kvs map[string]string) map[string]error

+ func MSetNX(client Client, ctx context.Context, kvs map[string]string) map[string]error

+ func ToVector32(s string) []float32

+ func ToVector64(s string) []float64

+ func VectorString32(v []float32) string

+ func VectorString64(v []float64) string

+ type AuthCredentials struct

+ Password string

+ Username string

+ type AuthCredentialsContext struct

+ Address net.Addr

+ type Builder = cmds.Builder

+ type CacheEntry interface

+ Wait func(ctx context.Context) (ValkeyMessage, error)

+ type CacheStore interface

+ Cancel func(key, cmd string, err error)

+ Close func(err error)

+ Delete func(keys []ValkeyMessage)

+ Flight func(key, cmd string, ttl time.Duration, now time.Time) (v ValkeyMessage, e CacheEntry)

+ Update func(key, cmd string, val ValkeyMessage) (pxat int64)

+ func NewSimpleCacheAdapter(store SimpleCache) CacheStore

+ type CacheStoreOption struct

+ CacheSizeEachConn int

+ type Cacheable = cmds.Cacheable

+ type CacheableTTL struct

+ Cmd Cacheable

+ TTL time.Duration

+ func CT(cmd Cacheable, ttl time.Duration) CacheableTTL

+ type Client interface

+ Dedicate func() (client DedicatedClient, cancel func())

+ Dedicated func(fn func(DedicatedClient) error) (err error)

+ DoCache func(ctx context.Context, cmd Cacheable, ttl time.Duration) (resp ValkeyResult)

+ DoMultiCache func(ctx context.Context, multi ...CacheableTTL) (resp []ValkeyResult)

+ DoMultiStream func(ctx context.Context, multi ...Completed) MultiValkeyResultStream

+ DoStream func(ctx context.Context, cmd Completed) ValkeyResultStream

+ Nodes func() map[string]Client

+ func NewClient(option ClientOption) (client Client, err error)

+ type ClientOption struct

+ AlwaysPipelining bool

+ AlwaysRESP2 bool

+ AuthCredentialsFn func(AuthCredentialsContext) (AuthCredentials, error)

+ BlockingPoolSize int

+ CacheSizeEachConn int

+ ClientName string

+ ClientNoEvict bool

+ ClientNoTouch bool

+ ClientSetInfo []string

+ ClientTrackingOptions []string

+ ConnWriteTimeout time.Duration

+ DialFn func(string, *net.Dialer, *tls.Config) (conn net.Conn, err error)

+ Dialer net.Dialer

+ DisableCache bool

+ DisableRetry bool

+ ForceSingleClient bool

+ InitAddress []string

+ MaxFlushDelay time.Duration

+ NewCacheStoreFn NewCacheStoreFn

+ OnInvalidations func([]ValkeyMessage)

+ Password string

+ PipelineMultiplex int

+ ReadBufferEachConn int

+ ReplicaOnly bool

+ RingScaleEachConn int

+ SelectDB int

+ SendToReplicas func(cmd Completed) bool

+ Sentinel SentinelOption

+ ShuffleInit bool

+ TLSConfig *tls.Config

+ Username string

+ WriteBufferEachConn int

+ func MustParseURL(str string) ClientOption

+ func ParseURL(str string) (opt ClientOption, err error)

+ type Commands []Completed

+ type Completed = cmds.Completed

+ type CoreClient interface

+ B func() Builder

+ Close func()

+ Do func(ctx context.Context, cmd Completed) (resp ValkeyResult)

+ DoMulti func(ctx context.Context, multi ...Completed) (resp []ValkeyResult)

+ Receive func(ctx context.Context, subscribe Completed, fn func(msg PubSubMessage)) error

+ type DedicatedClient interface

+ SetPubSubHooks func(hooks PubSubHooks) <-chan error

+ type FtSearchDoc struct

+ Doc map[string]string

+ Key string

+ Score float64

+ type GeoLocation struct

+ Dist float64

+ GeoHash int64

+ Latitude float64

+ Longitude float64

+ Name string

+ type Incomplete = cmds.Incomplete

+ type KeyValues struct

+ Key string

+ Values []string

+ type KeyZScores struct

+ Key string

+ Values []ZScore

+ type Lua struct

+ func NewLuaScript(script string) *Lua

+ func NewLuaScriptReadOnly(script string) *Lua

+ func (s *Lua) Exec(ctx context.Context, c Client, keys, args []string) (resp ValkeyResult)

+ func (s *Lua) ExecMulti(ctx context.Context, c Client, multi ...LuaExec) (resp []ValkeyResult)

+ type LuaExec struct

+ Args []string

+ Keys []string

+ type MultiValkeyResultStream = ValkeyResultStream

+ type NewCacheStoreFn func(CacheStoreOption) CacheStore

+ type PubSubHooks struct

+ OnMessage func(m PubSubMessage)

+ OnSubscription func(s PubSubSubscription)

+ type PubSubMessage struct

+ Channel string

+ Message string

+ Pattern string

+ type PubSubSubscription struct

+ Channel string

+ Count int64

+ Kind string

+ type RedirectMode int

+ const RedirectAsk

+ const RedirectMove

+ const RedirectNone

+ const RedirectRetry

+ type ScanEntry struct

+ Cursor uint64

+ Elements []string

+ type SentinelOption struct

+ ClientName string

+ Dialer net.Dialer

+ MasterSet string

+ Password string

+ TLSConfig *tls.Config

+ Username string

+ type SimpleCache interface

+ Del func(key string)

+ Flush func()

+ Get func(key string) ValkeyMessage

+ Set func(key string, val ValkeyMessage)

+ type ValkeyError ValkeyMessage

+ func IsValkeyErr(err error) (ret *ValkeyError, ok bool)

+ func (r *ValkeyError) Error() string

+ func (r *ValkeyError) IsAsk() (addr string, ok bool)

+ func (r *ValkeyError) IsBusyGroup() bool

+ func (r *ValkeyError) IsClusterDown() bool

+ func (r *ValkeyError) IsMoved() (addr string, ok bool)

+ func (r *ValkeyError) IsNil() bool

+ func (r *ValkeyError) IsNoScript() bool

+ func (r *ValkeyError) IsTryAgain() bool

+ type ValkeyMessage struct

+ func (m *ValkeyMessage) AsBool() (val bool, err error)

+ func (m *ValkeyMessage) AsBoolSlice() ([]bool, error)

+ func (m *ValkeyMessage) AsBytes() (bs []byte, err error)

+ func (m *ValkeyMessage) AsFloat64() (val float64, err error)

+ func (m *ValkeyMessage) AsFloatSlice() ([]float64, error)

+ func (m *ValkeyMessage) AsFtAggregate() (total int64, docs []map[string]string, err error)

+ func (m *ValkeyMessage) AsFtAggregateCursor() (cursor, total int64, docs []map[string]string, err error)

+ func (m *ValkeyMessage) AsFtSearch() (total int64, docs []FtSearchDoc, err error)

+ func (m *ValkeyMessage) AsGeosearch() ([]GeoLocation, error)

+ func (m *ValkeyMessage) AsInt64() (val int64, err error)

+ func (m *ValkeyMessage) AsIntMap() (map[string]int64, error)

+ func (m *ValkeyMessage) AsIntSlice() ([]int64, error)

+ func (m *ValkeyMessage) AsLMPop() (kvs KeyValues, err error)

+ func (m *ValkeyMessage) AsMap() (map[string]ValkeyMessage, error)

+ func (m *ValkeyMessage) AsReader() (reader io.Reader, err error)

+ func (m *ValkeyMessage) AsScanEntry() (e ScanEntry, err error)

+ func (m *ValkeyMessage) AsStrMap() (map[string]string, error)

+ func (m *ValkeyMessage) AsStrSlice() ([]string, error)

+ func (m *ValkeyMessage) AsUint64() (val uint64, err error)

+ func (m *ValkeyMessage) AsXRange() ([]XRangeEntry, error)

+ func (m *ValkeyMessage) AsXRangeEntry() (XRangeEntry, error)

+ func (m *ValkeyMessage) AsXRead() (ret map[string][]XRangeEntry, err error)

+ func (m *ValkeyMessage) AsZMPop() (kvs KeyZScores, err error)

+ func (m *ValkeyMessage) AsZScore() (s ZScore, err error)

+ func (m *ValkeyMessage) AsZScores() ([]ZScore, error)

+ func (m *ValkeyMessage) CachePTTL() int64

+ func (m *ValkeyMessage) CachePXAT() int64

+ func (m *ValkeyMessage) CacheTTL() (ttl int64)

+ func (m *ValkeyMessage) DecodeJSON(v any) (err error)

+ func (m *ValkeyMessage) Error() error

+ func (m *ValkeyMessage) IsArray() bool

+ func (m *ValkeyMessage) IsBool() bool

+ func (m *ValkeyMessage) IsCacheHit() bool

+ func (m *ValkeyMessage) IsFloat64() bool

+ func (m *ValkeyMessage) IsInt64() bool

+ func (m *ValkeyMessage) IsMap() bool

+ func (m *ValkeyMessage) IsNil() bool

+ func (m *ValkeyMessage) IsString() bool

+ func (m *ValkeyMessage) String() string

+ func (m *ValkeyMessage) ToAny() (any, error)

+ func (m *ValkeyMessage) ToArray() ([]ValkeyMessage, error)

+ func (m *ValkeyMessage) ToBool() (val bool, err error)

+ func (m *ValkeyMessage) ToFloat64() (val float64, err error)

+ func (m *ValkeyMessage) ToInt64() (val int64, err error)

+ func (m *ValkeyMessage) ToMap() (map[string]ValkeyMessage, error)

+ func (m *ValkeyMessage) ToString() (val string, err error)

+ type ValkeyResult struct

+ func (r *ValkeyResult) String() string

+ func (r ValkeyResult) AsBool() (v bool, err error)

+ func (r ValkeyResult) AsBoolSlice() (v []bool, err error)

+ func (r ValkeyResult) AsBytes() (v []byte, err error)

+ func (r ValkeyResult) AsFloat64() (v float64, err error)

+ func (r ValkeyResult) AsFloatSlice() (v []float64, err error)

+ func (r ValkeyResult) AsFtAggregate() (total int64, docs []map[string]string, err error)

+ func (r ValkeyResult) AsFtAggregateCursor() (cursor, total int64, docs []map[string]string, err error)

+ func (r ValkeyResult) AsFtSearch() (total int64, docs []FtSearchDoc, err error)

+ func (r ValkeyResult) AsGeosearch() (locations []GeoLocation, err error)

+ func (r ValkeyResult) AsInt64() (v int64, err error)

+ func (r ValkeyResult) AsIntMap() (v map[string]int64, err error)

+ func (r ValkeyResult) AsIntSlice() (v []int64, err error)

+ func (r ValkeyResult) AsLMPop() (v KeyValues, err error)

+ func (r ValkeyResult) AsMap() (v map[string]ValkeyMessage, err error)

+ func (r ValkeyResult) AsReader() (v io.Reader, err error)

+ func (r ValkeyResult) AsScanEntry() (v ScanEntry, err error)

+ func (r ValkeyResult) AsStrMap() (v map[string]string, err error)

+ func (r ValkeyResult) AsStrSlice() (v []string, err error)

+ func (r ValkeyResult) AsUint64() (v uint64, err error)

+ func (r ValkeyResult) AsXRange() (v []XRangeEntry, err error)

+ func (r ValkeyResult) AsXRangeEntry() (v XRangeEntry, err error)

+ func (r ValkeyResult) AsXRead() (v map[string][]XRangeEntry, err error)

+ func (r ValkeyResult) AsZMPop() (v KeyZScores, err error)

+ func (r ValkeyResult) AsZScore() (v ZScore, err error)

+ func (r ValkeyResult) AsZScores() (v []ZScore, err error)

+ func (r ValkeyResult) CachePTTL() int64

+ func (r ValkeyResult) CachePXAT() int64

+ func (r ValkeyResult) CacheTTL() int64

+ func (r ValkeyResult) DecodeJSON(v any) (err error)

+ func (r ValkeyResult) Error() (err error)

+ func (r ValkeyResult) IsCacheHit() bool

+ func (r ValkeyResult) NonValkeyError() error

+ func (r ValkeyResult) ToAny() (v any, err error)

+ func (r ValkeyResult) ToArray() (v []ValkeyMessage, err error)

+ func (r ValkeyResult) ToBool() (v bool, err error)

+ func (r ValkeyResult) ToFloat64() (v float64, err error)

+ func (r ValkeyResult) ToInt64() (v int64, err error)

+ func (r ValkeyResult) ToMap() (v map[string]ValkeyMessage, err error)

+ func (r ValkeyResult) ToMessage() (v ValkeyMessage, err error)

+ func (r ValkeyResult) ToString() (v string, err error)

+ type ValkeyResultStream struct

+ func (s *ValkeyResultStream) Error() error

+ func (s *ValkeyResultStream) HasNext() bool

+ func (s *ValkeyResultStream) WriteTo(w io.Writer) (n int64, err error)

+ type XRangeEntry struct

+ FieldValues map[string]string

+ ID string

+ type ZScore struct

+ Member string

+ Score float64