Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/phpredis/phpredis.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNasreddine Bouafif <n.bouafif@owlient.eu>2010-03-17 20:56:43 +0300
committerNasreddine Bouafif <n.bouafif@owlient.eu>2010-03-17 20:56:43 +0300
commitf2ad04deea917c6b13865a34c60939f09b61887d (patch)
tree0e349ed69428e4e4a85d7214ec149adac5f83a16 /README.markdown
parent133dce9df4d33deada9e27dbd868d866f7189437 (diff)
zUnion & zInter documentation.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown49
1 files changed, 49 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index 5f41f961..1c95f382 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1297,6 +1297,55 @@ $redis->zIncrBy('key', 2.5, 'member1'); /* key or member1 didn't exist, so membe
$redis->zIncrBy('key', 1, 'member1'); /* 3.5 */
</pre>
+## zUnion
+##### *Description*
+Creates an union of sorted sets given in second argument. The result of the union will be stored in the sorted set defined by the first argument.
+The third optionnel argument defines `weights` to apply to the sorted sets in input. In this case, the `weights` will be multiplied by the score of each element in the sorted set before applying the aggregation.
+The forth argument defines the AGGREGATE option which specify how the results of the union are aggregated.
+##### *Parameters*
+*keyOutput*
+*arrayZSetKeys*
+*arrayWeights*
+*aggregateFunction*
+
+##### *Return value*
+*LONG* The number of values in the new sorted set.
+##### *Example*
+<pre>
+$redis->zAdd('k1', 1, 'val1');
+$redis->zAdd('k1', 2, 'val2');
+$redis->zAdd('k1', 3, 'val3');
+
+$redis->zAdd('k1', 1, 'val1');
+$redis->zAdd('k1', 2, 'val2');
+
+$redis->zUnion('ko1', array('k1', 'k2')); /* 3, 'ko1' => array('val1', 'val2', 'val3') */
+</pre>
+
+## zInter
+##### *Description*
+Creates an intersection of sorted sets given in second argument. The result of the union will be stored in the sorted set defined by the first argument.
+The third optionnel argument defines `weights` to apply to the sorted sets in input. In this case, the `weights` will be multiplied by the score of each element in the sorted set before applying the aggregation.
+The forth argument defines the `AGGREGATE` option which specify how the results of the union are aggregated.
+##### *Parameters*
+*keyOutput*
+*arrayZSetKeys*
+*arrayWeights*
+*aggregateFunction*
+
+##### *Return value*
+*LONG* The number of values in the new sorted set.
+##### *Example*
+<pre>
+$redis->zAdd('k1', 1, 'val1');
+$redis->zAdd('k1', 2, 'val2');
+$redis->zAdd('k1', 3, 'val3');
+
+$redis->zAdd('k1', 1, 'val1');
+$redis->zAdd('k1', 2, 'val2');
+
+$redis->zInter('ko1', array('k1', 'k2')); /* 2, 'ko1' => array('val1', 'val2') */
+</pre>
## hSet
##### *Description*