ZADD - Upstash Documentation

Arguments#

keystrrequired#

The key of the sorted set.

scoresDict[str, float]required#

A dictionary of elements and their scores.

xxbool#

Only update elements that already exist. Never add elements.

nxbool#

Only add new elements. Never update elements.

gtbool#

Update scores if the new score is greater than the old score.

ltbool#

Update scores if the new score is less than the old score.

chbool#

Return the number of elements changed instead.

incrbool#

When this option is specified ZADD acts like ZINCRBY. Only one score-element pair can be specified in this mode.

Response#

# Add three elementsassert redis.zadd("myset", { "one": 1, "two": 2, "three": 3}) == 3# No element is added since "one" and "two" already existassert redis.zadd("myset", { "one": 1, "two": 2}, nx=True) == 0# New element is not added since it does not existassert redis.zadd("myset", { "new-element": 1}, xx=True) == 0# Only "three" is updated since new score was greaterassert redis.zadd("myset", { "three": 10, "two": 0}, gt=True) == 1# Only "three" is updated since new score was greaterassert redis.zadd("myset", { "three": 10, "two": 0}, gt=True) == 1