mirror/phpredis
1
0
Fork 0
mirror of https://github.com/phpredis/phpredis.git synced 2026-06-19 07:35:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation (#2523)

Browse Source 
* Remove/update mentions of removed methods

These methods were deprecated in a previous release

* Correct documentation for zInter/zinterstore

* Correct documentation for zUnion/zunionstore

* Add documentation for zDiff/zdiffstore

* Add documentation for zMscore
This commit is contained in:
Michael Dwyer
2024-07-11 23:49:29 -05:00
committed by GitHub
parent 50529f56e4
commit eeb5109967
3 changed files with 222 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+203 -80
View File
@@ -793,7 +793,7 @@ $redis->slowLog('len');
* [getSet](#getset) - Set the string value of a key and return its old value
* [incr, incrBy](#incr-incrby) - Increment the value of a key
* [incrByFloat](#incrbyfloat) - Increment the float value of a key by the given amount
* [mGet, getMultiple](#mget-getmultiple) - Get the values of all the given keys
* [mGet](#mget) - Get the values of all the given keys
* [mSet, mSetNX](#mset-msetnx) - Set multiple keys to multiple values
* [set](#set) - Set the string value of a key
* [setBit](#setbit) - Sets or clears the bit at offset in the string value stored at key
@@ -808,16 +808,16 @@ $redis->slowLog('len');
* [del, delete, unlink](#del-delete-unlink) - Delete a key
* [dump](#dump) - Return a serialized version of the value stored at the specified key.
* [exists](#exists) - Determine if a key exists
* [expire, setTimeout, pexpire](#expire-pexpire) - Set a key's time to live in seconds
* [expire, pexpire](#expire-pexpire) - Set a key's time to live in seconds
* [expireAt, pexpireAt](#expireat-pexpireat) - Set the expiration for a key as a UNIX timestamp
* [keys, getKeys](#keys-getkeys) - Find all keys matching the given pattern
* [keys](#keys) - Find all keys matching the given pattern
* [scan](#scan) - Scan for keys in the keyspace (Redis >= 2.8.0)
* [migrate](#migrate) - Atomically transfer a key from a Redis instance to another one
* [move](#move) - Move a key to another database
* [object](#object) - Inspect the internals of Redis objects
* [persist](#persist) - Remove the expiration from a key
* [randomKey](#randomkey) - Return a random key from the keyspace
* [rename, renameKey](#rename-renamekey) - Rename a key
* [rename](#rename) - Rename a key
* [renameNx](#renamenx) - Rename a key, only if the new key does not exist
* [type](#type) - Determine the type stored at key
* [sort](#sort) - Sort the elements in a list, set or sorted set
@@ -1052,7 +1052,7 @@ $redis->decr('key1', 10); /* -13 */
$redis->decrBy('key1', 10); /* -23 */
~~~
### mGet, getMultiple
### mGet
-----
_**Description**_: Get the values of all the specified keys. If one or more keys don't exist, the array will contain `FALSE` at the position of the key.
@@ -1071,8 +1071,6 @@ $redis->mGet(['key1', 'key2', 'key3']); /* ['value1', 'value2', 'value3'];
$redis->mGet(['key0', 'key1', 'key5']); /* [`FALSE`, 'value1', `FALSE`];
~~~
**Note:** `getMultiple` is an alias for `mGet` and will be removed in future versions of phpredis.
### getSet
-----
_**Description**_: Sets a value and returns the previous entry at that key.
@@ -1126,7 +1124,7 @@ $redis->select(1); // switch to DB 1
$redis->get('x'); // will return 42
~~~
### rename, renameKey
### rename
-----
_**Description**_: Renames a key.
##### *Parameters*
@@ -1144,8 +1142,6 @@ $redis->get('y'); // → 42
$redis->get('x'); // → `FALSE`
~~~
**Note:** `renameKey` is an alias for `rename` and will be removed in future versions of phpredis.
### renameNx
-----
_**Description**_: Same as rename, but will not replace a key if the destination already exists. This is the same behaviour as setNx.
@@ -1170,8 +1166,6 @@ sleep(5); // wait 5 seconds
$redis->get('x'); // will return `FALSE`, as 'x' has expired.
~~~
**Note:** `setTimeout` is an alias for `expire` and will be removed in future versions of phpredis.
### expireAt, pexpireAt
-----
_**Description**_: Seta specific timestamp for a key to expire in seconds or milliseconds.
@@ -1193,7 +1187,7 @@ sleep(5); // wait 5 seconds
$redis->get('x'); // will return `FALSE`, as 'x' has expired.
~~~
### keys, getKeys
### keys
-----
_**Description**_: Returns the keys that match a certain pattern.
@@ -1209,8 +1203,6 @@ $allKeys = $redis->keys('*'); // all keys will match this.
$keyWithUserPrefix = $redis->keys('user*');
~~~
**Note:** `getKeys` is an alias for `keys` and will be removed in future versions of phpredis.
### scan
-----
_**Description**_: Scan the keyspace for keys
@@ -1337,8 +1329,6 @@ $redis->getRange('key', 0, 5); /* 'string' */
$redis->getRange('key', -5, -1); /* 'value' */
~~~
**Note**: `substr` is an alias for `getRange` and will be removed in future versions of phpredis.
### setRange
-----
_**Description**_: Changes a substring of a larger string.
@@ -1895,16 +1885,16 @@ _**Description**_: Get the string length of the value associated with field in t
* [blPop, brPop](#blpop-brpop) - Remove and get the first/last element in a list
* [bRPopLPush](#brpoplpush) - Pop a value from a list, push it to another list and return it
* [lIndex, lGet](#lindex-lget) - Get an element from a list by its index
* [lIndex](#lindex) - Get an element from a list by its index
* [lInsert](#linsert) - Insert an element before or after another element in a list
* [lLen, lSize](#llen-lsize) - Get the length/size of a list
* [lLen](#llen) - Get the length/size of a list
* [lPop](#lpop) - Remove and get the first element in a list
* [lPush](#lpush) - Prepend one or multiple values to a list
* [lPushx](#lpushx) - Prepend a value to a list, only if the list exists
* [lRange, lGetRange](#lrange-lgetrange) - Get a range of elements from a list
* [lRem, lRemove](#lrem-lremove) - Remove elements from a list
* [lRange](#lrange) - Get a range of elements from a list
* [lRem](#lrem) - Remove elements from a list
* [lSet](#lset) - Set the value of an element in a list by its index
* [lTrim, listTrim](#ltrim-listtrim) - Trim a list to the specified range
* [lTrim](#ltrim) - Trim a list to the specified range
* [rPop](#rpop) - Remove and get the last element in a list
* [rPopLPush](#rpoplpush) - Remove the last element in a list, append it to another list and return it (redis >= 1.1)
* [rPush](#rpush) - Append one or multiple values to a list
@@ -1969,7 +1959,7 @@ _**Description**_: A blocking version of `rPopLPush`, with an integral timeout i
##### *Return value*
*STRING* The element that was moved in case of success, `FALSE` in case of timeout.
### lIndex, lGet
### lIndex
-----
_**Description**_: Return the specified element of the list stored at the specified key.
@@ -1996,8 +1986,6 @@ $redis->lindex('key1', -1); /* 'C' */
$redis->lindex('key1', 10); /* `FALSE` */
~~~
**Note:** `lGet` is an alias for `lIndex` and will be removed in future versions of phpredis.
### lInsert
-----
_**Description**_: Insert value in the list before or after the pivot value.
@@ -2096,7 +2084,7 @@ $redis->lPushx('key1', 'C'); // returns 3
/* key1 now points to the following list: [ 'A', 'B', 'C' ] */
~~~
### lRange, lGetRange
### lRange
-----
_**Description**_: Returns the specified elements of the list stored at the specified key in the range [start, end]. start and stop are interpreted as indices:
0 the first element, 1 the second ...
@@ -2118,9 +2106,7 @@ $redis->rPush('key1', 'C');
$redis->lRange('key1', 0, -1); /* ['A', 'B', 'C'] */
~~~
**Note:** `lGetRange` is an alias for `lRange` and will be removed in future versions of phpredis.
### lRem, lRemove
### lRem
-----
_**Description**_: Removes the first `count` occurrences of the value element from the list. If count is zero, all the matching elements are removed. If count is negative, elements are removed from tail to head.
@@ -2148,8 +2134,6 @@ $redis->lRem('key1', 'A', 2); /* 2 */
$redis->lRange('key1', 0, -1); /* ['C', 'B', 'A'] */
~~~
**Note:** `lRemove` is an alias for `lRem` and will be removed in future versions of phpredis.
### lSet
-----
_**Description**_: Set the list at index with the new value.
@@ -2172,7 +2156,7 @@ $redis->lSet('key1', 0, 'X');
$redis->lindex('key1', 0); /* 'X' */
~~~
### lTrim, listTrim
### lTrim
-----
_**Description**_: Trims an existing list so that it will contain only a specified range of elements.
@@ -2195,8 +2179,6 @@ $redis->lTrim('key1', 0, 1);
$redis->lRange('key1', 0, -1); /* ['A', 'B'] */
~~~
**Note:** `listTrim` is an alias for `lTrim` and will be removed in future versions of phpredis.
### rPop
-----
_**Description**_: Returns and removes the last element of the list.
@@ -2302,7 +2284,7 @@ $redis->rPushX('key1', 'C'); // returns 3
/* key1 now points to the following list: [ 'A', 'B', 'C' ] */
~~~
### lLen, lSize
### lLen
-----
_**Description**_: Returns the size of a list identified by Key.
@@ -2325,23 +2307,21 @@ $redis->rPop('key1');
$redis->lLen('key1');/* 2 */
~~~
**Note:** `lSize` is an alias for `lLen` and will be removed in future versions of phpredis.
## Sets
* [sAdd](#sadd) - Add one or more members to a set
* [sCard, sSize](#scard-ssize) - Get the number of members in a set
* [sCard](#scard) - Get the number of members in a set
* [sDiff](#sdiff) - Subtract multiple sets
* [sDiffStore](#sdiffstore) - Subtract multiple sets and store the resulting set in a key
* [sInter](#sinter) - Intersect multiple sets
* [sInterStore](#sinterstore) - Intersect multiple sets and store the resulting set in a key
* [sIsMember, sContains](#sismember-scontains) - Determine if a given value is a member of a set
* [sMembers, sGetMembers](#smembers-sgetmembers) - Get all the members in a set
* [sIsMember](#sismember) - Determine if a given value is a member of a set
* [sMembers](#smembers) - Get all the members in a set
* [sMove](#smove) - Move a member from one set to another
* [sPop](#spop) - Remove and return one or more members of a set at random
* [sRandMember](#srandmember) - Get one or multiple random members from a set
* [sRem, sRemove](#srem-sremove) - Remove one or more members from a set
* [sRem](#srem) - Remove one or more members from a set
* [sUnion](#sunion) - Add multiple sets
* [sUnionStore](#sunionstore) - Add multiple sets and store the resulting set in a key
* [sScan](#sscan) - Scan a set for members
@@ -2362,7 +2342,7 @@ $redis->sAdd('key1' , 'member2', 'member3'); /* 2, 'key1' => {'member1', 'member
$redis->sAdd('key1' , 'member2'); /* 0, 'key1' => {'member1', 'member2', 'member3'}*/
~~~
### sCard, sSize
### sCard
-----
_**Description**_: Returns the cardinality of the set identified by key.
##### *Parameters*
@@ -2378,8 +2358,6 @@ $redis->sCard('key1'); /* 3 */
$redis->sCard('keyX'); /* 0 */
~~~
**Note:** `sSize` is an alias for `sCard` and will be removed in future versions of phpredis.
### sDiff
-----
_**Description**_: Performs the difference between N sets and returns it.
@@ -2533,7 +2511,7 @@ array(2) {
}
~~~
### sIsMember, sContains
### sIsMember
-----
_**Description**_: Checks if `value` is a member of the set stored at the key `key`.
##### *Parameters*
@@ -2552,9 +2530,7 @@ $redis->sIsMember('key1', 'member1'); /* TRUE */
$redis->sIsMember('key1', 'memberX'); /* FALSE */
~~~
**Note:** `sContains` is an alias for `sIsMember` and will be removed in future versions of phpredis.
### sMembers, sGetMembers
### sMembers
-----
_**Description**_: Returns the contents of a set.
@@ -2587,8 +2563,6 @@ array(3) {
~~~
The order is random and corresponds to redis' own internal representation of the set structure.
**Note:** `sGetMembers` is an alias for `sMembers` and will be removed in future versions of phpredis.
### sMove
-----
_**Description**_: Moves the specified member from the set at srcKey to the set at dstKey.
@@ -2664,7 +2638,7 @@ $redis->sRandMember('empty-set', 100); // Will return an empty array
$redis->sRandMember('not-a-set', 100); // Will return FALSE
~~~
### sRem, sRemove
### sRem
-----
_**Description**_: Removes the specified member from the set value stored at key.
##### *Parameters*
@@ -2680,8 +2654,6 @@ $redis->sAdd('key1' , 'member3'); /* 'key1' => {'member1', 'member2', 'member3'}
$redis->sRem('key1', 'member2', 'member3'); /*return 2. 'key1' => {'member1'} */
~~~
**Note:** `sRemove` is an alias for `sRem` and will be removed in future versions of phpredis.
### sUnion
-----
_**Description**_: Performs the union between N sets and returns it.
@@ -2807,21 +2779,26 @@ while(($arr_mems = $redis->sScan('set', $it, "*pattern*"))!==FALSE) {
* [bzPop](#bzpop) - Block until Redis can pop the highest or lowest scoring member from one or more ZSETs.
* [zAdd](#zadd) - Add one or more members to a sorted set or update its score if it already exists
* [zCard, zSize](#zcard-zsize) - Get the number of members in a sorted set
* [zCard](#zcard) - Get the number of members in a sorted set
* [zCount](#zcount) - Count the members in a sorted set with scores within the given values
* [zDiff](#zdiff) - Computes the difference between the first and all successive input sorted sets and return the resulting sorted set
* [zdiffstore](#zdiffstore) - Computes the difference between the first and all successive input sorted sets and stores the result in a new key
* [zIncrBy](#zincrby) - Increment the score of a member in a sorted set
* [zinterstore, zInter](#zinterstore-zinter) - Intersect multiple sorted sets and store the resulting sorted set in a new key
* [zInter](#zinter) - Intersect multiple sorted sets and return the resulting sorted set
* [zinterstore](#zinterstore) - Intersect multiple sorted sets and store the resulting sorted set in a new key
* [zMscore](#zmscore) - Get the scores associated with the given members in a sorted set
* [zPop](#zpop) - Redis can pop the highest or lowest scoring member from one a ZSET.
* [zRange](#zrange) - Return a range of members in a sorted set, by index
* [zRangeByScore, zRevRangeByScore](#zrangebyscore-zrevrangebyscore) - Return a range of members in a sorted set, by score
* [zRangeByLex](#zrangebylex) - Return a lexicographical range from members that share the same score
* [zRank, zRevRank](#zrank-zrevrank) - Determine the index of a member in a sorted set
* [zRem, zDelete, zRemove](#zrem-zdelete-zremove) - Remove one or more members from a sorted set
* [zRemRangeByRank, zDeleteRangeByRank](#zremrangebyrank-zdeleterangebyrank) - Remove all members in a sorted set within the given indexes
* [zRemRangeByScore, zDeleteRangeByScore, zRemoveRangeByScore](#zremrangebyscore-zdeleterangebyscore-zremoverangebyscore) - Remove all members in a sorted set within the given scores
* [zRem](#zrem) - Remove one or more members from a sorted set
* [zRemRangeByRank](#zremrangebyrank) - Remove all members in a sorted set within the given indexes
* [zRemRangeByScore](#zremrangebyscore) - Remove all members in a sorted set within the given scores
* [zRevRange](#zrevrange) - Return a range of members in a sorted set, by index, with scores ordered from high to low
* [zScore](#zscore) - Get the score associated with the given member in a sorted set
* [zunionstore, zUnion](#zunionstore-zunion) - Add multiple sorted sets and store the resulting sorted set in a new key
* [zUnion](#zunion) - Add multiple sorted sets and return the resulting sorted set
* [zunionstore](#zunionstore) - Add multiple sorted sets and store the resulting sorted set in a new key
* [zScan](#zscan) - Scan a sorted set for members
### bzPop
@@ -2885,7 +2862,7 @@ $redis->zRange('key', 0, -1); // [val0, val1, val5]
$redis->zAdd('key', ['CH'], 5, 'val5', 10, 'val10', 15, 'val15');
~~~
### zCard, zSize
### zCard
-----
_**Description**_: Returns the cardinality of an ordered set.
@@ -2903,8 +2880,6 @@ $redis->zAdd('key', 10, 'val10');
$redis->zCard('key'); /* 3 */
~~~
**Note**: `zSize` is an alias for `zCard` and will be removed in future versions of phpredis.
### zCount
-----
_**Description**_: Returns the *number* of elements of the sorted set stored at the specified key which have scores in the range [start,end]. Adding a parenthesis before `start` or `end` excludes it from the range. +inf and -inf are also valid limits.
@@ -2925,6 +2900,75 @@ $redis->zAdd('key', 10, 'val10');
$redis->zCount('key', 0, 3); /* 2, corresponding to ['val0', 'val2'] */
~~~
### zDiff
-----
_**Description**_: Computes the difference between the first and all successive input sorted sets in the first argument. The result of the difference will be returned.
The second argument is a set of options. It can define `WITHSCORES` so that the scores are returned as well.
##### *Parameters*
*arrayZSetKeys*
*arrayOptions* One option is available: `withscores => TRUE`.
##### *Return value*
*ARRAY* The result of the difference of sets.
##### *Example*
~~~php
$redis->del('k1');
$redis->del('k2');
$redis->del('k3');
$redis->zAdd('k1', 0, 'val0');
$redis->zAdd('k1', 1, 'val1');
$redis->zAdd('k1', 3, 'val3');
$redis->zAdd('k2', 5, 'val1');
$redis->zAdd('k3', 5, 'val0');
$redis->zAdd('k3', 3, 'val4');
$redis->zDiff(['k1', 'k2']); /* ['val0', 'val3'] */
$redis->zDiff(['k2', 'k1']); /* [] */
$redis->zDiff(['k1', 'k2'], ['withscores' => true]); /* ['val0' => 0.0, 'val3' => 3.0] */
$redis->zDiff(['k1', 'k2', 'k3']); /* ['val3'] */
$redis->zDiff(['k3', 'k2', 'k1']); /* ['val4'] */
~~~
### zdiffstore
-----
_**Description**_: Computes the difference between the first and all successive input sorted sets in the second argument. The result of the difference will be stored in the sorted set defined by the first argument.
##### *Parameters*
*keyOutput*
*arrayZSetKeys*
##### *Return value*
*LONG* The number of values in the new sorted set.
##### *Example*
~~~php
$redis->del('k1');
$redis->del('k2');
$redis->del('k3');
$redis->zAdd('k1', 0, 'val0');
$redis->zAdd('k1', 1, 'val1');
$redis->zAdd('k1', 3, 'val3');
$redis->zAdd('k2', 5, 'val1');
$redis->zAdd('k3', 5, 'val0');
$redis->zAdd('k3', 3, 'val4');
$redis->zdiffstore('ko1', ['k1', 'k2']); /* 2, 'ko1' => ['val0', 'val3'] */
$redis->zdiffstore('ko2', ['k2', 'k1']); /* 0, 'ko2' => [] */
$redis->zdiffstore('ko3', ['k1', 'k2', 'k3']); /* 1, 'ko3' => ['val3'] */
$redis->zdiffstore('ko4', ['k3', 'k2', 'k1']); /* 1, 'k04' => ['val4'] */
~~~
### zIncrBy
-----
_**Description**_: Increments the score of a member from a sorted set by a given amount.
@@ -2945,12 +2989,48 @@ $redis->zIncrBy('key', 2.5, 'member1'); /* key or member1 didn't exist, so membe
$redis->zIncrBy('key', 1, 'member1'); /* 3.5 */
~~~
### zinterstore, zInter
### 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.
_**Description**_: Creates an intersection of sorted sets given in first argument. The result of the intersection will be returned.
The second optional 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 third argument is a set of options. It can define the `AGGREGATE` option which specify how the results of the intersection are aggregated. It can also define `WITHSCORES` so that the scores are returned as well.
##### *Parameters*
*arrayZSetKeys*
*arrayWeights*
*arrayOptions* Two options are available: `withscores => TRUE`, and `aggregate => $behaviour`. Either "SUM", "MIN", or "MAX" defines the behaviour to use on duplicate entries during the zinter.
##### *Return value*
*ARRAY* The result of the intersection of sets.
##### *Example*
~~~php
$redis->del('k1');
$redis->del('k2');
$redis->del('k3');
$redis->zAdd('k1', 0, 'val0');
$redis->zAdd('k1', 1, 'val1');
$redis->zAdd('k1', 3, 'val3');
$redis->zAdd('k2', 5, 'val1');
$redis->zAdd('k2', 3, 'val3');
$redis->zinter(['k1', 'k2']); /* ['val1', 'val3'] */
$redis->zinter(['k1', 'k2'], [1, 1]); /* ['val1', 'val3'] */
/* Weighted zinter */
$redis->zinter(['k1', 'k2'], [1, 5], 'min'); /* ['val1', 'val3'] */
$redis->zinter(['k1', 'k2'], [1, 5], 'max'); /* ['val3', 'val1'] */
~~~
### zinterstore
-----
_**Description**_: Creates an intersection of sorted sets given in second argument. The result of the intersection will be stored in the sorted set defined by the first argument.
The third optional 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.
The forth argument defines the `AGGREGATE` option which specify how the results of the intersection are aggregated.
##### *Parameters*
*keyOutput*
@@ -2976,18 +3056,35 @@ $redis->zAdd('k1', 0, 'val0');
$redis->zAdd('k1', 1, 'val1');
$redis->zAdd('k1', 3, 'val3');
$redis->zAdd('k2', 2, 'val1');
$redis->zAdd('k2', 5, 'val1');
$redis->zAdd('k2', 3, 'val3');
$redis->zinterstore('ko1', ['k1', 'k2']); /* 2, 'ko1' => ['val1', 'val3'] */
$redis->zinterstore('ko2', ['k1', 'k2'], [1, 1]); /* 2, 'ko2' => ['val1', 'val3'] */
$redis->zinterstore('ko2', ['k1', 'k2'], [1, 1]); /* 2, 'ko2' => ['val1', 'val3'] */
/* Weighted zinterstore */
$redis->zinterstore('ko3', ['k1', 'k2'], [1, 5], 'min'); /* 2, 'ko3' => ['val1', 'val3'] */
$redis->zinterstore('ko4', ['k1', 'k2'], [1, 5], 'max'); /* 2, 'ko4' => ['val3', 'val1'] */
~~~
**Note:** `zInter` is an alias for `zinterstore` and will be removed in future versions of phpredis.
### zMscore
-----
_**Description**_: Returns the scores of the given members in the specified sorted set.
##### *Parameters*
*key*
*members*: member1, member2, ... , memberN: Any number of members in the specified sorted set.
##### *Return value*
*ARRAY* or *FALSE* when the key is not found. Array entries corresponding to members that do not exist will be `false`.
##### *Example*
~~~php
$redis->zAdd('key', 2.5, 'val2');
$redis->zAdd('key', 4.5, 'val4');
$redis->zMscore('key', 'val2', 'val3', 'val4'); /* [2.5, false, 4.5] */
~~~
### zPop
-----
@@ -3115,7 +3212,7 @@ $redis->zRevRank('key', 'one'); /* 1 */
$redis->zRevRank('key', 'two'); /* 0 */
~~~
### zRem, zDelete, zRemove
### zRem
-----
_**Description**_: Delete one or more members from a sorted set.
@@ -3133,9 +3230,7 @@ $redis->zAdd('key', 0, 'val0', 1, 'val1', 2, 'val2');
$redis->zRem('key', 'val0', 'val1', 'val2'); // Returns: 3
~~~
**Note:** `zDelete` and `zRemove` are an alias for `zRem` and will be removed in future versions of phpredis.
### zRemRangeByRank, zDeleteRangeByRank
### zRemRangeByRank
-----
_**Description**_: Deletes the elements of the sorted set stored at the specified key which have rank in the range [start,end].
@@ -3156,9 +3251,7 @@ $redis->zRemRangeByRank('key', 0, 1); /* 2 */
$redis->zRange('key', 0, -1, ['withscores' => TRUE]); /* ['three' => 3] */
~~~
**Note:** `zDeleteRangeByRank` is an alias for `zRemRangeByRank` and will be removed in future versions of phpredis.
### zRemRangeByScore, zDeleteRangeByScore, zRemoveRangeByScore
### zRemRangeByScore
-----
_**Description**_: Deletes the elements of the sorted set stored at the specified key which have scores in the range [start,end].
@@ -3178,8 +3271,6 @@ $redis->zAdd('key', 10, 'val10');
$redis->zRemRangeByScore('key', 0, 3); /* 2 */
~~~
**Note:** `zDeleteRangeByScore` and `zRemoveRangeByScore` are an alias for `zRemRangeByScore` and will be removed in future versions of phpredis.
### zRevRange
-----
_**Description**_: Returns the elements of the sorted set stored at the specified key in the range [start, end] in reverse order. start and stop are interpreted as zero-based indices:
@@ -3223,7 +3314,41 @@ $redis->zAdd('key', 2.5, 'val2');
$redis->zScore('key', 'val2'); /* 2.5 */
~~~
### zunionstore, zUnion
### zUnion
-----
_**Description**_: Creates an union of sorted sets given in first argument. The result of the union will be returned.
The second optional 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 third argument is a set of options. It can define the `AGGREGATE` option which specify how the results of the intersection are aggregated. It can also define `WITHSCORES` so that the scores are returned as well.
##### *Parameters*
*arrayZSetKeys*
*arrayWeights*
*arrayOptions* Two options are available: `withscores => TRUE`, and `aggregate => $behaviour`. Either "SUM", "MIN", or "MAX" defines the behaviour to use on duplicate entries during the zunion.
##### *Return value*
*ARRAY* The result of the union of sets.
##### *Example*
~~~php
$redis->del('k1');
$redis->del('k2');
$redis->del('k3');
$redis->zAdd('k1', 0, 'val0');
$redis->zAdd('k1', 1, 'val1');
$redis->zAdd('k2', 2, 'val2');
$redis->zAdd('k2', 3, 'val3');
$redis->zunion(['k1', 'k2']); /* ['val0', 'val1', 'val2', 'val3'] */
/* Weighted zunion */
$redis->zunion(['k1', 'k2'], [1, 1]); /* ['val0', 'val1', 'val2', 'val3'] */
$redis->zunion(['k1', 'k2'], [5, 1]); /* ['val0', 'val2', 'val3', 'val1'] */
~~~
### zunionstore
-----
_**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.
@@ -3261,8 +3386,6 @@ $redis->zunionstore('ko2', ['k1', 'k2'], [1, 1]); /* 4, 'ko2' => ['val0', 'val1'
$redis->zunionstore('ko3', ['k1', 'k2'], [5, 1]); /* 4, 'ko3' => ['val0', 'val2', 'val3', 'val1'] */
~~~
**Note:** `zUnion` is an alias for `zunionstore` and will be removed in future versions of phpredis.
### zScan
-----
_**Description**_: Scan a sorted set for members, with optional pattern and count
serialize.list
+8 -8
View File
@@ -5,9 +5,9 @@ This file lists which methods support serialization. Only indented methods have
setex
setnx
getSet
getMultiple
mGet
append
substr
getRange
strlen
lPush
lPushx
@@ -17,19 +17,19 @@ strlen
rPop
blPop
brPop
lRemove
lGet
lGetRange
lRange
lRem
lIndex
lSet
lInsert
sAdd
sRemove
sRem
sMove
sContains
sIsMember
zAdd
zDelete
zRem
zScore
zRank
zRevRank
tests/RedisTest.php
+11 -11
View File
@@ -716,7 +716,7 @@ class Redis_Test extends TestSuite {
$this->redis->mget(array_keys($kvals)));
}
public function testSetTimeout() {
public function testExpire() {
$this->redis->del('key');
$this->redis->set('key', 'value');
@@ -1289,7 +1289,7 @@ class Redis_Test extends TestSuite {
}
}
// ltrim, lsize, lpop
// ltrim, lLen, lpop
public function testltrim() {
$this->redis->del('list');
@@ -4049,13 +4049,13 @@ class Redis_Test extends TestSuite {
$this->assertFalse($ret[$i++]); // ltrim
$this->assertFalse($ret[$i++]); // lindex
$this->assertFalse($ret[$i++]); // lset
$this->assertFalse($ret[$i++]); // lremove
$this->assertFalse($ret[$i++]); // lrem
$this->assertFalse($ret[$i++]); // lpop
$this->assertFalse($ret[$i++]); // rpop
$this->assertFalse($ret[$i++]); // rpoplush
$this->assertFalse($ret[$i++]); // sadd
$this->assertFalse($ret[$i++]); // sremove
$this->assertFalse($ret[$i++]); // srem
$this->assertFalse($ret[$i++]); // spop
$this->assertFalse($ret[$i++]); // smove
$this->assertFalse($ret[$i++]); // scard
@@ -4171,7 +4171,7 @@ class Redis_Test extends TestSuite {
$this->assertFalse($ret[$i++]); // decrBy
$this->assertFalse($ret[$i++]); // sadd
$this->assertFalse($ret[$i++]); // sremove
$this->assertFalse($ret[$i++]); // srem
$this->assertFalse($ret[$i++]); // spop
$this->assertFalse($ret[$i++]); // smove
$this->assertFalse($ret[$i++]); // scard
@@ -4295,7 +4295,7 @@ class Redis_Test extends TestSuite {
$this->assertFalse($ret[$i++]); // ltrim
$this->assertFalse($ret[$i++]); // lindex
$this->assertFalse($ret[$i++]); // lset
$this->assertFalse($ret[$i++]); // lremove
$this->assertFalse($ret[$i++]); // lrem
$this->assertFalse($ret[$i++]); // lpop
$this->assertFalse($ret[$i++]); // rpop
$this->assertFalse($ret[$i++]); // rpoplush
@@ -4411,13 +4411,13 @@ class Redis_Test extends TestSuite {
$this->assertFalse($ret[$i++]); // ltrim
$this->assertFalse($ret[$i++]); // lindex
$this->assertFalse($ret[$i++]); // lset
$this->assertFalse($ret[$i++]); // lremove
$this->assertFalse($ret[$i++]); // lrem
$this->assertFalse($ret[$i++]); // lpop
$this->assertFalse($ret[$i++]); // rpop
$this->assertFalse($ret[$i++]); // rpoplush
$this->assertFalse($ret[$i++]); // sadd
$this->assertFalse($ret[$i++]); // sremove
$this->assertFalse($ret[$i++]); // srem
$this->assertFalse($ret[$i++]); // spop
$this->assertFalse($ret[$i++]); // smove
$this->assertFalse($ret[$i++]); // scard
@@ -4527,13 +4527,13 @@ class Redis_Test extends TestSuite {
$this->assertFalse($ret[$i++]); // ltrim
$this->assertFalse($ret[$i++]); // lindex
$this->assertFalse($ret[$i++]); // lset
$this->assertFalse($ret[$i++]); // lremove
$this->assertFalse($ret[$i++]); // lrem
$this->assertFalse($ret[$i++]); // lpop
$this->assertFalse($ret[$i++]); // rpop
$this->assertFalse($ret[$i++]); // rpoplush
$this->assertFalse($ret[$i++]); // sadd
$this->assertFalse($ret[$i++]); // sremove
$this->assertFalse($ret[$i++]); // srem
$this->assertFalse($ret[$i++]); // spop
$this->assertFalse($ret[$i++]); // smove
$this->assertFalse($ret[$i++]); // scard
@@ -5099,7 +5099,7 @@ class Redis_Test extends TestSuite {
$this->assertEquals($a[$k], $v);
}
// getMultiple
// mGet
$this->redis->set('a', NULL);
$this->redis->set('b', FALSE);
$this->redis->set('c', 42);