Merge pull request #1712 from DiceDB/arpitbbhayani

Z* Commands now fetch Rank in all cases

Author: arpitbbhayani

docs/src/content/docs/commands/ZPOPMAX.md

@@ -19,24 +19,24 @@ ZPOPMAX removes and returns the member with the highest score from the sorted se
 
 If the key does not exist, the command returns empty list. An optional "count" argument can be provided
 to remove and return multiple members (up to the number specified).
+
+When popped, the elements are returned in descending order of score and you get the rank of the element in the sorted set.
+The rank is 1-based, which means that the first element is at rank 1 and not rank 0.
+The 1), 2), 3), ... is the rank of the element in the sorted set.
 
 
 #### Examples
 
 ```
 
-localhost:7379> ZADD users 1 alice
-OK 1
-localhost:7379> ZADD users 2 bob
-OK 1
-localhost:7379> ZADD users 3 charlie
-OK 1
+localhost:7379> ZADD users 10 alice 20 bob 30 charlie
+OK 3
 localhost:7379> ZPOPMAX users
 OK
-0) 3, charlie
+3) 30, charlie
 localhost:7379> ZPOPMAX users 10
 OK
-0) 2, bob
-1) 1, alice
+2) 20, bob
+1) 10, alice
 	
 ```

docs/src/content/docs/commands/ZPOPMIN.md

@@ -19,24 +19,24 @@ ZPOPMIN removes and returns the member with the lowest score from the sorted set
 
 If the key does not exist, the command returns empty list. An optional "count" argument can be provided
 to remove and return multiple members (up to the number specified).
+
+When popped, the elements are returned in ascending order of score and you get the rank of the element in the sorted set.
+The rank is 1-based, which means that the first element is at rank 1 and not rank 0.
+The 1), 2), 3), ... is the rank of the element in the sorted set.
 
 
 #### Examples
 
 ```
 
-localhost:7379> ZADD users 1 alice
-OK 1
-localhost:7379> ZADD users 2 bob
-OK 1
-localhost:7379> ZADD users 3 charlie
-OK 1
+localhost:7379> ZADD users 10 alice 20 bob 30 charlie
+OK 3
 localhost:7379> ZPOPMIN users
 OK
-0) 1, alice
+1) 10, alice
 localhost:7379> ZPOPMIN users 10
 OK
-0) 2, bob
-1) 3, charlie
+1) 20, bob
+2) 30, charlie
 	
 ```

docs/src/content/docs/commands/ZRANGE.WATCH.md

@@ -11,7 +11,7 @@ description: ZRANGE.WATCH creates a query subscription over the ZRANGE command
 #### Syntax
 
 ```
-ZRANGE.WATCH key start stop
+ZRANGE.WATCH key start stop [BYSCORE | BYRANK]
 ```
 
 
@@ -26,22 +26,22 @@ You can update the key in any other client. The ZRANGE.WATCH client will receive
 
 ```
 
-client1:7379> ZADD users 1 alice 2 bob 3 charlie
+client1:7379> ZADD users 10 alice 20 bob 30 charlie
 OK 3
 client1:7379> ZRANGE.WATCH users 1 5
 entered the watch mode for ZRANGE.WATCH users
 
 
-client2:7379> ZADD users 4 daniel
+client2:7379> ZADD users 40 daniel
 OK 1
 
 
 client1:7379> ...
 entered the watch mode for ZRANGE.WATCH users
 OK [fingerprint=1007898011883907067]
-0) 1, alice
-1) 2, bob
-2) 3, charlie
-3) 4, daniel
+1) 10, alice
+2) 20, bob
+3) 30, charlie
+4) 40, daniel
 	
 ```

docs/src/content/docs/commands/ZRANGE.md

@@ -11,25 +11,43 @@ description: ZRANGE returns the range of elements from the sorted set stored at
 #### Syntax
 
 ```
-ZRANGE key start stop
+ZRANGE key start stop [BYSCORE | BYRANK]
 ```
 
 
 ZRANGE returns the range of elements from the sorted set stored at key.
 
-The elements are considered to be ordered from the lowest to the highest score. Both start and
-stop are 0-based indexes, where 0 is the first element, 1 is the next element and so on.
+The default range is by rank "BYRANK" and this can be changed to "BYSCORE" if you want to range by score spanning the start and stop values.
+The rank is 1-based, which means that the first element is at rank 1 and not rank 0.
+The 1), 2), 3), ... is the rank of the element in the sorted set.
+
+Both the start and stop values are inclusive and hence the elements having either of the values will be included. The
+elements are considered to be ordered from the lowest to the highest. If you want reverse order, consider
+storing score with flipped sign.
 
 #### Examples
 
 ```
 
-localhost:7379> ZADD s 1 a 2 b 3 c 4 d 5 e
+localhost:7379> ZADD s 10 a 20 b 30 c 40 d 50 e
 OK 5
 localhost:7379> ZRANGE s 1 3
 OK
-0) 1, a
-1) 2, b
-2) 3, c
+1) 10, a
+2) 20, b
+3) 30, c
+localhost:7379> ZRANGE s 1 4 BYRANK
+OK
+1) 10, a
+2) 20, b
+3) 30, c
+4) 40, d
+localhost:7379> ZRANGE s 1 3 BYSCORE
+OK
+localhost:7379> ZRANGE s 30 100 BYSCORE
+OK
+3) 30, c
+4) 40, d
+5) 50, e
 
 ```

docs/src/content/docs/commands/ZRANK.WATCH.md

@@ -26,18 +26,21 @@ You can update the key in any other client. The ZRANK.WATCH client will receive
 
 ```
 
-client1:7379> ZADD users 1 alice 2 bob 3 charlie
+client1:7379> ZADD users 10 alice 20 bob 30 charlie
 OK 3
 client1:7379> ZRANK.WATCH users bob
 entered the watch mode for ZRANK.WATCH users
 
 
 client2:7379> ZADD users 10 bob
 OK 0
+client2:7379> ZADD users 100 alice
+OK 0
 
 
 client1:7379> ...
 entered the watch mode for ZRANK.WATCH users
-OK [fingerprint=3262833422269415227] 3, 10, bob
+OK [fingerprint=3262833422269415227] 2) 10, bob
+OK [fingerprint=3262833422269415227] 1) 10, bob
 	
 ```

docs/src/content/docs/commands/ZRANK.md

@@ -17,8 +17,10 @@ ZRANK key member
 
 ZRANK returns the rank of a member in a sorted set, ordered from low to high scores.
 
-The rank is 1-based which means that the member with the lowest score has rank 1.
-The command returns the element (score with member) and the rank.
+The rank is 1-based which means that the member with the lowest score has rank 1, the next highest has rank 2, and so on.
+The command returns the element - rank, score, and memeber.
+
+Thus, 1), 2), 3) are the rank of the element in the sorted set, followed by the score and the member.
 
 The the member passed as the second argument is not a member of the sorted set, the command returns a
 valid response with a rank of 0 and score of 0. If the key does not exist, the command returns a
@@ -29,17 +31,13 @@ valid response with a rank of 0, score of 0, and the member as "".
 
 ```
 
-localhost:7379> ZADD users 20 bob
-OK 1
-localhost:7379> ZADD users 10 alice
-OK 1
-localhost:7379> ZADD users 30 charlie
-OK 1
+localhost:7379> ZADD users 10 alice 20 bob 30 charlie
+OK 3
 localhost:7379> ZRANK users bob
-OK 2, 20, bob
+OK 2) 20, bob
 localhost:7379> ZRANK users charlie
-OK 3, 30, charlie
+OK 3) 30, charlie
 localhost:7379> ZRANK users daniel
-OK 0, 0, daniel
+OK 0) 0, daniel
 	
 ```

docs/src/content/docs/commands/ZREM.md

@@ -24,21 +24,17 @@ Returns the number of members removed from the sorted set.
 
 ```
 
-localhost:7379> ZADD ss 1 k1
-OK 1
-localhost:7379> ZADD ss 2 k2
-OK 1
-localhost:7379> ZADD ss 3 k3
-OK 1
-localhost:7379> ZRANGE ss 0 6
+localhost:7379> ZADD users 10 alice 20 bob 30 charlie
+OK 3
+localhost:7379> ZRANGE users 0 60 BYSCORE
 OK
-0) 1, k1
-1) 2, k2
-2) 3, k3
-localhost:7379> ZREM ss k1 k2 k4
+1) 10, alice
+2) 20, bob
+3) 30, charlie
+localhost:7379> ZREM users alice bob
 OK 2
-localhost:7379> ZRANGE ss 0 6
+localhost:7379> ZRANGE users 0 60 BYSCORE
 OK
-0) 3, k3
+1) 30, charlie
 
 ```

go.mod

@@ -41,7 +41,7 @@ require (
 	github.com/bytedance/sonic v1.13.1
 	github.com/cespare/xxhash/v2 v2.3.0
 	github.com/dgryski/go-farm v0.0.0-20240924180020-3414d57e47da
-	github.com/dicedb/dicedb-go v1.0.8
+	github.com/dicedb/dicedb-go v1.0.9
 	github.com/gobwas/glob v0.2.3
 	github.com/google/btree v1.1.3
 	github.com/google/go-cmp v0.6.0

go.sum

@@ -20,8 +20,8 @@ github.com/dgryski/go-farm v0.0.0-20240924180020-3414d57e47da h1:aIftn67I1fkbMa5
 github.com/dgryski/go-farm v0.0.0-20240924180020-3414d57e47da/go.mod h1:SqUrOPUnsFjfmXRMNPybcSiG0BgUW2AuFH8PAnS2iTw=
 github.com/dgryski/go-metro v0.0.0-20211217172704-adc40b04c140 h1:y7y0Oa6UawqTFPCDw9JG6pdKt4F9pAhHv0B7FMGaGD0=
 github.com/dgryski/go-metro v0.0.0-20211217172704-adc40b04c140/go.mod h1:c9O8+fpSOX1DM8cPNSkX/qsBWdkD4yd2dpciOWQjpBw=
-github.com/dicedb/dicedb-go v1.0.8 h1:4Z1Qo9lWdOmSOKOTpV8rzinFSUgQU3ui5mx7OMBaTac=
-github.com/dicedb/dicedb-go v1.0.8/go.mod h1:V1fiCJnPfSObKWrOJ/zrhHEGlLwT9k3pKCto3sz1oW8=
+github.com/dicedb/dicedb-go v1.0.9 h1:WtXtX6Bu/KFjhnOIlnoo9Z1hbmOtL2tMrUmS6793/Pw=
+github.com/dicedb/dicedb-go v1.0.9/go.mod h1:V1fiCJnPfSObKWrOJ/zrhHEGlLwT9k3pKCto3sz1oW8=
 github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=
 github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
 github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=

internal/cmd/cmd_zpopmax.go

@@ -23,21 +23,21 @@ ZPOPMAX removes and returns the member with the highest score from the sorted se
 
 If the key does not exist, the command returns empty list. An optional "count" argument can be provided
 to remove and return multiple members (up to the number specified).
+
+When popped, the elements are returned in descending order of score and you get the rank of the element in the sorted set.
+The rank is 1-based, which means that the first element is at rank 1 and not rank 0.
+The 1), 2), 3), ... is the rank of the element in the sorted set.
 	`,
 	Examples: `
-localhost:7379> ZADD users 1 alice
-OK 1
-localhost:7379> ZADD users 2 bob
-OK 1
-localhost:7379> ZADD users 3 charlie
-OK 1
+localhost:7379> ZADD users 10 alice 20 bob 30 charlie
+OK 3
 localhost:7379> ZPOPMAX users
 OK
-0) 3, charlie
+3) 30, charlie
 localhost:7379> ZPOPMAX users 10
 OK
-0) 2, bob
-1) 1, alice
+2) 20, bob
+1) 10, alice
 	`,
 	Eval:    evalZPOPMAX,
 	Execute: executeZPOPMAX,
@@ -97,6 +97,7 @@ func evalZPOPMAX(c *Cmd, s *dstore.Store) (*CmdRes, error) {
 
 	ss = obj.Value.(*types.SortedSet)
 	elements := make([]*wire.ZElement, 0, count)
+	totalElements := ss.SortedSet.GetCount()
 
 	for i := 0; i < count; i++ {
 		n := ss.PopMax()
@@ -106,6 +107,7 @@ func evalZPOPMAX(c *Cmd, s *dstore.Store) (*CmdRes, error) {
 		elements = append(elements, &wire.ZElement{
 			Member: n.Key(),
 			Score:  int64(n.Score()),
+			Rank:   int64(totalElements) - int64(i),
 		})
 	}
 	return newZPOPMAXRes(elements), nil