Skip to content

Commit

Permalink
Update README with missing deprecation notes
Browse files Browse the repository at this point in the history
  • Loading branch information
pdelre authored and michael-grunder committed Jan 21, 2020
1 parent a107c9f commit d07a8df
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,8 @@ $redis->connect('/tmp/redis.sock'); // unix domain socket.
$redis->connect('127.0.0.1', 6379, 1, NULL, 100); // 1 sec timeout, 100ms delay between reconnection attempts.
~~~

**Note:** `open` is an alias for `connect` and will be removed in future versions of phpredis.

### pconnect, popen
-----
_**Description**_: Connects to a Redis instance or reuse a connection already established with `pconnect`/`popen`.
Expand Down Expand Up @@ -247,6 +249,8 @@ $redis->pconnect('127.0.0.1', 6379, 2.5, 'x'); // x is sent as persistent_id and
$redis->pconnect('/tmp/redis.sock'); // unix domain socket - would be another connection than the four before.
~~~

**Note:** `popen` is an alias for `pconnect` and will be removed in future versions of phpredis.

### auth
-----
_**Description**_: Authenticate the connection using a password.
Expand Down Expand Up @@ -1171,8 +1175,6 @@ $redis->get('key'); /* 'value1value2' */
-----
_**Description**_: Return a substring of a larger string

*Note*: substr also supported but deprecated in redis.

##### *Parameters*
*key*
*start*
Expand All @@ -1188,6 +1190,8 @@ $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.
Expand Down Expand Up @@ -2430,6 +2434,8 @@ 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.
Expand Down Expand Up @@ -2729,9 +2735,11 @@ _**Description**_: Returns the cardinality of an ordered set.
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zSize('key'); /* 3 */
$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.
Expand Down

0 comments on commit d07a8df

Please sign in to comment.