Overview

Sorted Sets are collections of unique members, each associated with a score. Members are automatically ordered by score, making sorted sets perfect for leaderboards, rankings, priority queues, and any scenario where you need ordered data.

Available Operations

Adding and Removing

• ZAdd - Add members with scores
• ZRemove - Remove members

Retrieving by Rank

• ZRange - Get members by rank (lowest to highest)
• ZRevRange - Get members by rank (highest to lowest)

Retrieving by Score

• ZRangeByScore - Get members by score range

Query Operations

• ZCard - Get number of members
• ZScore - Get score of a member
• ZRank - Get rank (low to high)
• ZRevRank - Get rank (high to low)
• ZCount - Count members in score range

Modification

• ZIncrBy - Increment member score
• ZRemRangeByRank - Remove by rank range
• ZRemRangeByScore - Remove by score range

Use Cases

• Leaderboards and rankings
• Priority queues
• Time-based expiry (score as timestamp)
• Skill rating systems
• Top players tracking

Quick Example

local Redix = exports.redix:GetInterface()

-- Add player to leaderboard
Redix.ZAdd('leaderboard:kills', 150, 'PlayerA')

-- Get top 10
Redix.ZRevRange('leaderboard:kills', 0, 9, 'WITHSCORES', function(err, results)
    -- Display leaderboard
end)

-- Increment player score
Redix.ZIncrBy('leaderboard:kills', 1, 'PlayerA')