summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/sintercard.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/sintercard.md')
-rw-r--r--iredis/data/commands/sintercard.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/iredis/data/commands/sintercard.md b/iredis/data/commands/sintercard.md
new file mode 100644
index 0000000..24473e5
--- /dev/null
+++ b/iredis/data/commands/sintercard.md
@@ -0,0 +1,28 @@
+This command is similar to `SINTER`, but instead of returning the result set, it returns just the cardinality of the result.
+Returns the cardinality of the set which would result from the intersection of all the given sets.
+
+Keys that do not exist are considered to be empty sets.
+With one of the keys being an empty set, the resulting set is also empty (since set intersection with an empty set always results in an empty set).
+
+By default, the command calculates the cardinality of the intersection of all given sets.
+When provided with the optional `LIMIT` argument (which defaults to 0 and means unlimited), if the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinality.
+Such implementation ensures a significant speedup for queries where the limit is lower than the actual intersection cardinality.
+
+@return
+
+@integer-reply: the number of elements in the resulting intersection.
+
+@examples
+
+```cli
+SADD key1 "a"
+SADD key1 "b"
+SADD key1 "c"
+SADD key1 "d"
+SADD key2 "c"
+SADD key2 "d"
+SADD key2 "e"
+SINTER key1 key2
+SINTERCARD 2 key1 key2
+SINTERCARD 2 key1 key2 LIMIT 1
+```