From 06cba6ccd165ca8b224797e37fccb9e63f026d77 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 21 Mar 2020 11:28:17 +0100 Subject: Adding upstream version 1.9.1. Signed-off-by: Daniel Baumann --- iredis/data/commands/spop.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 iredis/data/commands/spop.md (limited to 'iredis/data/commands/spop.md') diff --git a/iredis/data/commands/spop.md b/iredis/data/commands/spop.md new file mode 100644 index 0000000..76b1c89 --- /dev/null +++ b/iredis/data/commands/spop.md @@ -0,0 +1,41 @@ +Removes and returns one or more random elements from the set value store at +`key`. + +This operation is similar to `SRANDMEMBER`, that returns one or more random +elements from a set but does not remove it. + +The `count` argument is available since version 3.2. + +@return + +@bulk-string-reply: the removed element, or `nil` when `key` does not exist. + +@examples + +```cli +SADD myset "one" +SADD myset "two" +SADD myset "three" +SPOP myset +SMEMBERS myset +SADD myset "four" +SADD myset "five" +SPOP myset 3 +SMEMBERS myset +``` + +## Specification of the behavior when count is passed + +If count is bigger than the number of elements inside the Set, the command will +only return the whole set without additional elements. + +## Distribution of returned elements + +Note that this command is not suitable when you need a guaranteed uniform +distribution of the returned elements. For more information about the algorithms +used for SPOP, look up both the Knuth sampling and Floyd sampling algorithms. + +## Count argument extension + +Redis 3.2 introduced an optional `count` argument that can be passed to `SPOP` +in order to retrieve multiple elements in a single call. -- cgit v1.2.3