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:
authormichael-grunder <michael.grunder@gmail.com>2019-03-20 15:32:54 +0300
committermichael-grunder <michael.grunder@gmail.com>2019-03-20 15:32:54 +0300
commit603ba48d58409b4bb4f8012b3eceb4596e064945 (patch)
tree4beabd171e8a638336fc41faf0992b9615be002d /README.markdown
parenta9fe96e2ec46cb820e1b10a3a30372a924e1c227 (diff)
Fix documentation for zRem/zDelete
Fixes #1527
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.markdown b/README.markdown
index 7b67225b..a0aea736 100644
--- a/README.markdown
+++ b/README.markdown
@@ -2835,24 +2835,24 @@ $redis->zRevRank('key', 'two'); /* 0 */
### zRem, zDelete
-----
-_**Description**_: Deletes a specified member from the ordered set.
+_**Description**_: Delete one or more members from a sorted set.
-##### *Parameters*
-*key*
-*member*
+##### *Prototype*
+~~~php
+$redis->zRem($key, $member [, $member ...]);
+~~~
##### *Return value*
-*LONG* 1 on success, 0 on failure.
+*LONG:* The number of members deleted.
##### *Example*
~~~php
-$redis->zAdd('key', 0, 'val0');
-$redis->zAdd('key', 2, 'val2');
-$redis->zAdd('key', 10, 'val10');
-$redis->zDelete('key', 'val2');
-$redis->zRange('key', 0, -1); /* ['val0', 'val10'] */
+$redis->zAdd('key', 0, 'val0', 1, 'val1', 2, 'val2');
+$redis->zRem('key', 'val0', 'val1', 'val2'); // Returns: 3
~~~
+**Note:** `zDelete` is an alias for `zRem` and may be removed in future versions of phpredis.
+
### zRemRangeByRank, zDeleteRangeByRank
-----
_**Description**_: Deletes the elements of the sorted set stored at the specified key which have rank in the range [start,end].