diff --git a/cluster_commands.go b/cluster_commands.go index 4857b01e..a02683f2 100644 --- a/cluster_commands.go +++ b/cluster_commands.go @@ -42,6 +42,9 @@ func (c cmdable) ClusterMyID(ctx context.Context) *StringCmd { return cmd } +// ClusterSlots returns the mapping of cluster slots to nodes. +// +// Deprecated: Use ClusterShards instead as of Redis 7.0.0. func (c cmdable) ClusterSlots(ctx context.Context) *ClusterSlotsCmd { cmd := NewClusterSlotsCmd(ctx, "cluster", "slots") _ = c(ctx, cmd) @@ -153,6 +156,9 @@ func (c cmdable) ClusterSaveConfig(ctx context.Context) *StatusCmd { return cmd } +// ClusterSlaves lists the replica nodes of a master node. +// +// Deprecated: Use ClusterReplicas instead as of Redis 5.0.0. func (c cmdable) ClusterSlaves(ctx context.Context, nodeID string) *StringSliceCmd { cmd := NewStringSliceCmd(ctx, "cluster", "slaves", nodeID) _ = c(ctx, cmd) diff --git a/commands.go b/commands.go index daee5505..f5976959 100644 --- a/commands.go +++ b/commands.go @@ -443,6 +443,9 @@ func (c cmdable) Do(ctx context.Context, args ...interface{}) *Cmd { return cmd } +// Quit closes the connection. +// +// Deprecated: Just close the connection instead as of Redis 7.2.0. func (c cmdable) Quit(_ context.Context) *StatusCmd { panic("not implemented") } @@ -665,6 +668,9 @@ func (c cmdable) ShutdownNoSave(ctx context.Context) *StatusCmd { return c.shutdown(ctx, "nosave") } +// SlaveOf sets a Redis server as a replica of another, or promotes it to being a master. +// +// Deprecated: Use ReplicaOf instead as of Redis 5.0.0. func (c cmdable) SlaveOf(ctx context.Context, host, port string) *StatusCmd { cmd := NewStatusCmd(ctx, "slaveof", host, port) _ = c(ctx, cmd) diff --git a/geo_commands.go b/geo_commands.go index f047b98a..0f274289 100644 --- a/geo_commands.go +++ b/geo_commands.go @@ -33,7 +33,10 @@ func (c cmdable) GeoAdd(ctx context.Context, key string, geoLocation ...*GeoLoca return cmd } -// GeoRadius is a read-only GEORADIUS_RO command. +// GeoRadius queries a geospatial index for members within a distance from a coordinate. +// This is a read-only variant that does not support Store or StoreDist options. +// +// Deprecated: Use GeoSearch with BYRADIUS argument instead as of Redis 6.2.0. func (c cmdable) GeoRadius( ctx context.Context, key string, longitude, latitude float64, query *GeoRadiusQuery, ) *GeoLocationCmd { @@ -60,7 +63,10 @@ func (c cmdable) GeoRadiusStore( return cmd } -// GeoRadiusByMember is a read-only GEORADIUSBYMEMBER_RO command. +// GeoRadiusByMember queries a geospatial index for members within a distance from a member. +// This is a read-only variant that does not support Store or StoreDist options. +// +// Deprecated: Use GeoSearch with BYRADIUS and FROMMEMBER arguments instead as of Redis 6.2.0. func (c cmdable) GeoRadiusByMember( ctx context.Context, key, member string, query *GeoRadiusQuery, ) *GeoLocationCmd { diff --git a/list_commands.go b/list_commands.go index 24a0de08..9d9e16c6 100644 --- a/list_commands.go +++ b/list_commands.go @@ -77,6 +77,10 @@ func (c cmdable) BRPop(ctx context.Context, timeout time.Duration, keys ...strin return cmd } +// BRPopLPush pops an element from a list, pushes it to another list and returns it. +// Blocks until an element is available or timeout is reached. +// +// Deprecated: Use BLMove with RIGHT and LEFT arguments instead as of Redis 6.2.0. func (c cmdable) BRPopLPush(ctx context.Context, source, destination string, timeout time.Duration) *StringCmd { cmd := NewStringCmd( ctx, @@ -247,6 +251,10 @@ func (c cmdable) RPopCount(ctx context.Context, key string, count int) *StringSl return cmd } +// RPopLPush atomically returns and removes the last element of the source list, +// and pushes the element as the first element of the destination list. +// +// Deprecated: Use LMove with RIGHT and LEFT arguments instead as of Redis 6.2.0. func (c cmdable) RPopLPush(ctx context.Context, source, destination string) *StringCmd { cmd := NewStringCmd(ctx, "rpoplpush", source, destination) _ = c(ctx, cmd) diff --git a/sortedset_commands.go b/sortedset_commands.go index 7827babc..4a6c8f13 100644 --- a/sortedset_commands.go +++ b/sortedset_commands.go @@ -479,10 +479,16 @@ func (c cmdable) zRangeBy(ctx context.Context, zcmd, key string, opt *ZRangeBy, return cmd } +// ZRangeByScore returns members in a sorted set within a range of scores. +// +// Deprecated: Use ZRangeArgs with ByScore option instead as of Redis 6.2.0. func (c cmdable) ZRangeByScore(ctx context.Context, key string, opt *ZRangeBy) *StringSliceCmd { return c.zRangeBy(ctx, "zrangebyscore", key, opt, false) } +// ZRangeByLex returns members in a sorted set within a lexicographical range. +// +// Deprecated: Use ZRangeArgs with ByLex option instead as of Redis 6.2.0. func (c cmdable) ZRangeByLex(ctx context.Context, key string, opt *ZRangeBy) *StringSliceCmd { return c.zRangeBy(ctx, "zrangebylex", key, opt, false) } @@ -559,6 +565,9 @@ func (c cmdable) ZRemRangeByLex(ctx context.Context, key, min, max string) *IntC return cmd } +// ZRevRange returns members in a sorted set within a range of indexes in reverse order. +// +// Deprecated: Use ZRangeArgs with Rev option instead as of Redis 6.2.0. func (c cmdable) ZRevRange(ctx context.Context, key string, start, stop int64) *StringSliceCmd { cmd := NewStringSliceCmd(ctx, "zrevrange", key, start, stop) _ = c(ctx, cmd) @@ -588,10 +597,16 @@ func (c cmdable) zRevRangeBy(ctx context.Context, zcmd, key string, opt *ZRangeB return cmd } +// ZRevRangeByScore returns members in a sorted set within a range of scores in reverse order. +// +// Deprecated: Use ZRangeArgs with Rev and ByScore options instead as of Redis 6.2.0. func (c cmdable) ZRevRangeByScore(ctx context.Context, key string, opt *ZRangeBy) *StringSliceCmd { return c.zRevRangeBy(ctx, "zrevrangebyscore", key, opt) } +// ZRevRangeByLex returns members in a sorted set within a lexicographical range in reverse order. +// +// Deprecated: Use ZRangeArgs with Rev and ByLex options instead as of Redis 6.2.0. func (c cmdable) ZRevRangeByLex(ctx context.Context, key string, opt *ZRangeBy) *StringSliceCmd { return c.zRevRangeBy(ctx, "zrevrangebylex", key, opt) } diff --git a/string_commands.go b/string_commands.go index f3c33f4c..f69d3d05 100644 --- a/string_commands.go +++ b/string_commands.go @@ -143,6 +143,9 @@ func (c cmdable) GetRange(ctx context.Context, key string, start, end int64) *St return cmd } +// GetSet returns the old value stored at key and sets it to the new value. +// +// Deprecated: Use SetArgs with Get option instead as of Redis 6.2.0. func (c cmdable) GetSet(ctx context.Context, key string, value interface{}) *StringCmd { cmd := NewStringCmd(ctx, "getset", key, value) _ = c(ctx, cmd) @@ -415,14 +418,18 @@ func (c cmdable) SetArgs(ctx context.Context, key string, value interface{}, a S return cmd } -// SetEx Redis `SETEx key expiration value` command. +// SetEx sets the value and expiration of a key. +// +// Deprecated: Use Set with expiration instead as of Redis 2.6.12. func (c cmdable) SetEx(ctx context.Context, key string, value interface{}, expiration time.Duration) *StatusCmd { cmd := NewStatusCmd(ctx, "setex", key, formatSec(ctx, expiration), value) _ = c(ctx, cmd) return cmd } -// SetNX Redis `SET key value [expiration] NX` command. +// SetNX sets the value of a key only if the key does not exist. +// +// Deprecated: Use Set with NX option instead as of Redis 2.6.12. // // Zero expiration means the key has no expiration time. // KeepTTL is a Redis KEEPTTL option to keep existing TTL, it requires your redis-server version >= 6.0,