Back to Redis

ZRANK

content/commands/zrank.md

latest2.0 KB
Original Source

Returns the rank of member in the sorted set stored at key, with the scores ordered from low to high. The rank (or index) is 0-based, which means that the member with the lowest score has rank 0.

The optional WITHSCORE argument supplements the command's reply with the score of the element returned.

Use [ZREVRANK]({{< relref "/commands/zrevrank" >}}) to get the rank of an element with the scores ordered from high to low.

Examples

{{% redis-cli %}} ZADD myzset 1 "one" ZADD myzset 2 "two" ZADD myzset 3 "three" ZRANK myzset "three" ZRANK myzset "four" ZRANK myzset "three" WITHSCORE ZRANK myzset "four" WITHSCORE {{% /redis-cli %}}

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Supported">✅ Standard</span> <span title="Supported"><nobr>✅ Active-Active</nobr></span> | <span title="Supported">✅ Standard</span> <span title="Supported"><nobr>✅ Active-Active</nobr></span> | |

Return information

{{< multitabs id="zrank-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

  • Nil reply: if the key does not exist or the member does not exist in the sorted set.
  • Integer reply: the rank of the member when WITHSCORE is not used.
  • Array reply: the rank and score of the member when WITHSCORE is used.

-tab-sep-

One of the following:

  • Null reply: if the key does not exist or the member does not exist in the sorted set.
  • Integer reply: the rank of the member when WITHSCORE is not used.
  • Array reply: the rank and score of the member when WITHSCORE is used.

{{< /multitabs >}}