Redis | PhpRedis API

-
at line 1949
- `Redis|array|string|bool - rPop(string $key, int $count = 0) -` + +

+
at line 3797
+ `Redis|bool sMove(string $src, string $dst, mixed $value)`

Pop one or more elements from the end of a list.

Pop a member from one set and push it onto another. This command will create the +destination set if it does not currently exist.

Parameters

@@ -11414,27 +17104,33 @@

Parameters

- - + + - - - + + + + + + + +

string	$key	A redis LIST key name.	$src	The source set.
int	$count	The maximum number of elements to pop at once. -NOTE: The `count` argument requires Redis >= 6.2.0	string	$dst	The destination set.
mixed	$value	The member you wish to move.

Return Value

- +

- - + +

Redis|array|string|bool

One ore more popped elements or false if all were empty.

Redis|bool

True if the member was moved, and false if it wasn't in the set.

Examples

- https://redis.io/commands/rpop + https://redis.io/docs/latest/commands/smove/

- - - - +

$redis->rPop('mylist');

$redis->rPop('mylist', 4);

$redis->sAdd('numbers', 'zero', 'one', 'two', 'three', 'four');
+$redis->sMove('numbers', 'evens', 'zero');
+$redis->sMove('numbers', 'evens', 'two');
+$redis->sMove('numbers', 'evens', 'four');

@@ -11465,30 +17161,47 @@

Examples

-
at line 1959
- `Redis|string|false - randomKey() -` + +

+
at line 3813
+ `Redis|string|array|false sPop(string $key, int $count = 0)`

Return a random key from the current database

Remove one or more elements from a set.

- -

Return Value

Parameters

+ + + + + + + + + + +

string	$key	The set in question.
int	$count	An optional number of members to pop. This defaults to +removing one element.

+ + +

Return Value

+ +

+ - - + +

Redis|string|false

A random key name or false if no keys exist

Redis|string|array|false

Examples

+ + + + + +

$redis->del('numbers', 'evens');
+$redis->sAdd('numbers', 'zero', 'one', 'two', 'three', 'four');
+$redis->sPop('numbers');

-
at line 1973
- `mixed - rawcommand(string $command, mixed ...$args) -` + +

+
at line 3836
+ `mixed sRandMember(string $key, int $count = 0)`

Execute any arbitrary Redis command by name.

Retrieve one or more random members of a set.

Parameters

@@ -11527,40 +17249,58 @@

Parameters

- - + + - - - + + +

string

$command

The command to execute

$key

The set to query.

mixed

...$args

One or more arguments to pass to the command.

int

$count

An optional count of members to return.

If this value is positive, Redis will return up to the requested +number but with unique elements that will never repeat. This means +you may receive fewer then $count replies.

If the number is negative, Redis will return the exact number requested +but the result may contain duplicate elements.

Return Value

- +

mixed

Can return any number of things depending on command executed.

One or more random members or false on failure.

Examples

- + - + - +

$redis->rawCommand('del', 'mystring', 'mylist');

$redis->sRandMember('myset');

$redis->rawCommand('set', 'mystring', 'myvalue');

$redis->sRandMember('myset', 10);

$redis->rawCommand('rpush', 'mylist', 'one', 'two', 'three');

$redis->sRandMember('myset', -10);

@@ -11569,18 +17309,17 @@

Examples

-
at line 1985
- `Redis|bool - rename(string $old_name, string $new_name) -` + +

+
at line 3850
+ `Redis|array|false sUnion(string $key, string ...$other_keys)`

Unconditionally rename a key from $old_name to $new_name

Returns the union of one or more Redis SET keys.

Parameters

@@ -11588,26 +17327,28 @@

Parameters

- - + + - - + +

string	$old_name	The original name of the key	$key	The first SET to do a union with
string	$new_name	The new name for the key	...$other_keys	One or more subsequent keys

Return Value

- +

- - + +

Redis|bool

True if the key was renamed or false if not.

Redis|array|false

The union of the one or more input sets or false on failure.

Examples

+ + + + + +

$redis->sunion('set1', 'set2');

-
at line 2004
- `Redis|bool - renameNx(string $key_src, string $key_dst) -` + +

+
at line 3869
+ `Redis|int|false sUnionStore(string $dst, string $key, string ...$other_keys)`

Renames $key_src to $key_dst but only if newkey does not exist.

Perform a union of one or more Redis SET keys and store the result in a new set

Parameters

@@ -11646,26 +17394,34 @@

Parameters

- - + + - - + + + + + + +

string	$key_src	The source key name	$dst	The destination key
string	$key_dst	The destination key name.	$key	The first source key
string	...$other_keys	One or more additional source keys

Return Value

- +

- - + +

Redis|bool

True if the key was renamed, false if not.

Redis|int|false

The number of elements stored in the destination SET or +false on failure.

Examples

- https://redis.io/commands/renamenx + https://redis.io/docs/latest/commands/sunionstore/ +
+ \Redis::sunion()

- +

$redis->set('src', 'src_key');

-$redis->set('existing-dst', 'i_exist');

-

-$redis->renamenx('src', 'dst');

-$redis->renamenx('dst', 'existing-dst');

$redis->sUnionStore('union:set', 'set:a', 'set:b');

@@ -11697,121 +17455,146 @@

Examples

-
at line 2011
- `Redis|bool - reset() -` + +

+
at line 3884
+ `Redis|bool save()`

Reset the state of the connection.

Persist the Redis database to disk. This command will block the server until the save is +completed. For a nonblocking alternative, see Redis::bgsave().

Return Value

- +

Redis|bool

Should always return true unless there is an error.

Returns true unless an error occurs.

Examples

+ + + + + +

$redis->save();

-
at line 2049
- `Redis|bool - restore(string $key, int $ttl, string $value, array|null $options = NULL) -` + +

+
at line 3944
+ `array|false scan(null|int|string $iterator, string|null $pattern = null, int $count = 0, string|null $type = null)`

Restore a key by the binary payload generated by the DUMP command.

Incrementally scan the Redis keyspace, with optional pattern and type matching.

A note about Redis::SCAN_NORETRY and Redis::SCAN_RETRY.

For convenience, PhpRedis can retry SCAN commands itself when Redis returns an empty array of +keys with a nonzero iterator. This can happen when matching against a pattern that very few +keys match inside a key space with a great many keys. The following example demonstrates how +to use Redis::scan() with the option disabled and enabled.

Parameters

- - - + + + - - - + + + - - - + + + - - - + + +

string	$key	The name of the key you wish to create.	null\|int\|string	$iterator	The cursor returned by Redis for every subsequent call to SCAN. On +the initial invocation of the call, it should be initialized by the +caller to NULL. Each time SCAN is invoked, the iterator will be +updated to a new number, until finally Redis will set the value to +zero, indicating that the scan is complete.
int	$ttl	What Redis should set the key's TTL (in milliseconds) to once it is created. -Zero means no TTL at all.	string\|null	$pattern	An optional glob-style pattern for matching key names. If passed as +NULL, it is the equivalent of sending '*' (match every key).
string	$value	The serialized binary value of the string (generated by DUMP).	int	$count	A hint to redis that tells it how many keys to return in a single +call to SCAN. The larger the number, the longer Redis may block +clients while iterating the key space.
array\|null	$options	An array of additional options that modifies how the command operates. - $options = [ - 'ABSTTL' # If this is present, the `$ttl` provided by the user should - # be an absolute timestamp, in milliseconds() - - 'REPLACE' # This flag instructs Redis to store the key even if a key with - # that name already exists. - - 'IDLETIME' => int # Tells Redis to set the keys internal 'idletime' value to a - # specific number (see the Redis command OBJECT for more info). - 'FREQ' => int # Tells Redis to set the keys internal 'FREQ' value to a specific - # number (this relates to Redis' LFU eviction algorithm). -];	string\|null	$type	An optional argument to specify which key types to scan (e.g. +'STRING', 'LIST', 'SET')

Return Value

- +

- - + +

Redis|bool

True if the key was stored, false if not.

array|false

An array of keys, or false if no keys were returned for this +invocation of scan. Note that it is possible for Redis to return +zero keys before having scanned the entire key space, so the caller +should instead continue to SCAN until the iterator reference is +returned to zero.

Examples

- https://redis.io/commands/dump + https://redis.io/docs/latest/commands/scan/
- -Redis::dump + +Redis::setOption

- +

$redis->sAdd('captains', 'Janeway', 'Picard', 'Sisko', 'Kirk', 'Archer');

-$serialized = $redis->dump('captains');

-

-$redis->restore('captains-backup', 0, $serialized);

$redis = new Redis(['host' => 'localhost']);
+
+$redis->setOption(Redis::OPT_SCAN, Redis::SCAN_NORETRY);
+
+$it = null;
+
+do {
+    $keys = $redis->scan($it, '*zorg*');
+    foreach ($keys as $key) {
+        echo "KEY: $key\n";
+    }
+} while ($it != 0);
+
+$redis->setOption(Redis::OPT_SCAN, Redis::SCAN_RETRY);
+
+$it = null;
+
+// When Redis::SCAN_RETRY is enabled, we can use simpler logic, as we will never receive an
+// empty array of keys when the iterator is nonzero.
+while ($keys = $redis->scan($it, '*zorg*')) {
+    foreach ($keys as $key) {
+        echo "KEY: $key\n";
+    }
+}

@@ -11834,52 +17637,79 @@

Examples

-
at line 2057
- `mixed - role() -` + +

+
at line 3957
+ `Redis|int|false scard(string $key)`

Query whether the connected instance is a primary or replica

Retrieve the number of members in a Redis set.

- -

Return Value

Parameters

+ + + + + +

string

$key

The set to get the cardinality of.

+ + +

Return Value

+ +

+ - - + +

mixed

Will return an array with the role of the connected instance unless there is -an error.

Redis|int|false

The cardinality of the set or false on failure.

Examples

+ + + + + +

$redis->scard('set');

-
at line 2079
- `Redis|string|false - rpoplpush(string $srckey, string $dstkey) -` + +

+
at line 3972
+ `mixed script(string $command, mixed ...$args)`

Atomically pop an element off the end of a Redis LIST and push it to the beginning of -another.

An administrative command used to interact with LUA scripts stored on the server.

Parameters

@@ -11887,26 +17717,28 @@

Parameters

- - + + - - - + + +

string	$srckey	The source key to pop from.	$command	The script suboperation to execute.
string	$dstkey	The destination key to push to.	mixed	...$args	One or more additional argument

Return Value

- +

- - + +

Redis|string|false

The popped element or false if the source key was empty.

mixed

This command returns various things depending on the specific operation executed.

Examples

- https://redis.io/commands/rpoplpush + https://redis.io/docs/latest/commands/script/

- + + + +

$redis->pipeline()

-      ->del('list1', 'list2')

-      ->rpush('list1', 'list1-1', 'list1-2')

-      ->rpush('list2', 'list2-1', 'list2-2')

-      ->exec();

-

-$redis->rpoplpush('list2', 'list1');

$redis->script('load', 'return 1');

$redis->script('exists', sha1('return 1'));

@@ -11940,50 +17769,41 @@

Examples

-
at line 2098
- `Redis|int|false - sAdd(string $key, mixed $value, mixed ...$other_values) -` + +

+
at line 3985
+ `Redis|bool select(int $db)`

Add one or more values to a Redis SET key.

Select a specific Redis database.

Parameters

- - - - - - - - - - - - - + + +

string	$key	The key name
mixed	$value
mixed	...$other_values		int	$db	The database to select. Note that by default Redis has 16 databases (0-15).

Return Value

- +

- - + +

Redis|int|false

The number of values added to the set.

Redis|bool

true on success and false on failure

Examples

- https://redis.io/commands/sadd + https://redis.io/docs/latest/commands/select/

- +

$redis->del('myset');

-

-$redis->sadd('myset', 'foo', 'bar', 'baz');

-$redis->sadd('myset', 'foo', 'new');

$redis->select(1);

@@ -12014,19 +17831,17 @@

Examples

-
at line 2117
- `int - sAddArray(string $key, array $values) -` + +

+
at line 4016
+ `Redis|string|bool set(string $key, mixed $value, mixed $options = null)`

Add one ore more values to a Redis SET key. This is an alternative to Redis::sadd() but -instead of being variadic, takes a single array of values.

Create or set a Redis STRING key to a value.

Parameters

@@ -12035,25 +17850,45 @@

Parameters

string $key -

The set to add values to.

The key name to set.

- array - $values -

One or more members to add to the set.

+ mixed + $value +

The value to set the key to.

+ + + mixed + $options +

Either an array with options for how to perform the set or an +integer with an expiration. If an expiration is set PhpRedis +will actually send the SETEX command.

OPTION DESCRIPTION

['EX' => 60] expire 60 seconds. +['PX' => 6000] expire in 6000 milliseconds. +['EXAT' => time() + 10] expire in 10 seconds. +['PXAT' => time()*1000 + 1000] expire in 1 second. +['KEEPTTL' => true] Redis will not update the key's current TTL. +['XX'] Only set the key if it already exists. +['NX'] Only set the key if it doesn't exist. +['GET'] Instead of returning +OK return the previous value of the +key or NULL if the key didn't exist.

Return Value

- +

- - + +

int

The number of members added to the set.

Redis|string|bool

True if the key was set or false on failure.

Examples

- https://redis.io/commands/sadd + https://redis.io/docs/latest/commands/set/
- \Redis::sadd() + https://redis.io/docs/latest/commands/setex/

- + + + +

$redis->del('myset'); - -$redis->sAddArray('myset', ['foo', 'bar', 'baz']); -$redis->sAddArray('myset', ['foo', 'new']);	$redis->set('key', 'value');
$redis->set('key', 'expires_in_60_seconds', 60);

@@ -12090,19 +17925,17 @@

Examples

-
at line 2141
- `Redis|array|false - sDiff(string $key, string ...$other_keys) -` + +

+
at line 4032
+ `Redis|int|false setBit(string $key, int $idx, bool $value)`

Given one or more Redis SETS, this command returns all of the members from the first -set that are not in any subsequent set.

Set a specific bit in a Redis string to zero or one

Parameters

@@ -12111,26 +17944,32 @@

Parameters

string $key -

The first set

The Redis STRING key to modify

- string - ...$other_keys -

One or more additional sets

+ int + $idx + + + + bool + $value +

Whether to set the bit to zero or one.

Return Value

- +

- - + +

Redis|array|false

Returns the elements from keys 2..N that don't exist in the -first sorted set, or false on failure.

Redis|int|false

The original value of the bit or false on failure.

Examples

- https://redis.io/commands/sdiff + https://redis.io/docs/latest/commands/setbit/

- +

$redis->pipeline()

-      ->del('set1', 'set2', 'set3')

-      ->sadd('set1', 'apple', 'banana', 'carrot', 'date')

-      ->sadd('set2', 'carrot')

-      ->sadd('set3', 'apple', 'carrot', 'eggplant')

-      ->exec();

-

-$redis->sdiff('set1', 'set2', 'set3');

$redis->set('foo', 'bar');
+$redis->setbit('foo', 7, 1);

@@ -12165,19 +17998,17 @@

Examples

-
at line 2156
- `Redis|int|false - sDiffStore(string $dst, string $key, string ...$other_keys) -` + +

+
at line 4049
+ `Redis|int|false setRange(string $key, int $index, string $value)`

This method performs the same operation as SDIFF except it stores the resulting diff -values in a specified destination key.

Update or append to a Redis string at a specific starting index

Parameters

@@ -12185,31 +18016,33 @@

Parameters

- - + + - - - + + + - - + +

string	$dst	The key where to store the result	$key	The key to update
string	$key	The first key to perform the DIFF on	int	$index	Where to insert the provided value
string	...$other_keys	One or more additional keys.	$value	The value to copy into the string.

Return Value

- +

Redis|int|false

The number of values stored in the destination set or false on failure.

The new length of the string or false on failure

Examples

+ + - - +

- \Redis::sdiff() -

$redis->set('message', 'Hello World');
+$redis->setRange('message', 6, 'Redis');

-
at line 2178
- `Redis|array|false - sInter(array|string $key, string ...$other_keys) -` + +

+
at line 4084
+ `bool setOption(int $option, mixed $value)`

Given one or more Redis SET keys, this command will return all of the elements that are -in every one.

Set a configurable option on the Redis object.

Following are a list of options you can set:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

OPTION	TYPE	DESCRIPTION
OPT_MAX_RETRIES	int	The maximum number of times Redis will attempt to reconnect if it gets disconnected, before throwing an exception.
OPT_SCAN	enum	Redis::OPT_SCAN_RETRY, or Redis::OPT_SCAN_NORETRY. Whether PhpRedis should automatically SCAN again when zero keys but a nonzero iterator are returned.
OPT_SERIALIZER	enum	Set the automatic data serializer. `Redis::SERIALIZER_NONE` `Redis::SERIALIZER_PHP` `Redis::SERIALIZER_IGBINARY` `Redis::SERIALIZER_MSGPACK`, `Redis::SERIALIZER_JSON`
OPT_PREFIX	string	A string PhpRedis will use to prefix every key we read or write.
OPT_READ_TIMEOUT	float	How long PhpRedis will block for a response from Redis before throwing a 'read error on connection' exception.
OPT_TCP_KEEPALIVE	bool	Set or disable TCP_KEEPALIVE on the connection.
OPT_COMPRESSION	enum	Set the compression algorithm `Redis::COMPRESSION_NONE` `Redis::COMPRESSION_LZF` `Redis::COMPRESSION_LZ4` `Redis::COMPRESSION_ZSTD`
OPT_REPLY_LITERAL	bool	If set to true, PhpRedis will return the literal string Redis returns for LINE replies (e.g. '+OK'), rather than `true`.
OPT_COMPRESSION_LEVEL	int	Set a specific compression level if Redis is compressing data.
OPT_NULL_MULTIBULK_AS_NULL	bool	Causes PhpRedis to return `NULL` rather than `false` for NULL MULTIBULK replies
OPT_BACKOFF_ALGORITHM	enum	The exponential backoff strategy to use.
OPT_BACKOFF_BASE	int	The minimum delay between retries when backing off.
OPT_BACKOFF_CAP	int	The maximum delay between replies when backing off.

Parameters

- - - + + + - - - + + +

array\|string	$key	The first SET key to intersect.	int	$option	The option constant.
string	...$other_keys	One or more Redis SET keys.	mixed	$value	The option value.

Return Value

- +

- - + +

Redis|array|false

bool

true if the setting was updated, false if not.

Examples

- +

$redis->pipeline()

-      ->del('alice_likes', 'bob_likes', 'bill_likes')

-      ->sadd('alice_likes', 'asparagus', 'broccoli', 'carrot', 'potato')

-      ->sadd('bob_likes', 'asparagus', 'carrot', 'potato')

-      ->sadd('bill_likes', 'broccoli', 'potato')

-      ->exec();

-

-var_dump($redis->sinter('alice_likes', 'bob_likes', 'bill_likes'));

-</code>

$redis->setOption(Redis::OPT_PREFIX, 'app:');

@@ -12310,46 +18222,51 @@

Examples

-
at line 2200
- `Redis|int|false - sintercard(array $keys, int $limit = -1) -` + +

+
at line 4099
+ `Redis|bool setex(string $key, int $expire, mixed $value)`

Compute the intersection of one or more sets and return the cardinality of the result.

Set a Redis STRING key with a specific expiration in seconds.

Parameters

- - - + + + - - + + + + + + +

array	$keys	One or more set key names.	string	$key	The name of the key to set.
int	$limit	A maximum cardinality to return. This is useful to put an upper bound -on the amount of work Redis will do.	$expire	The key's expiration in seconds.
mixed	$value	The value to set the key.

Return Value

- +

- - + +

Redis|int|false

The

Redis|bool

True on success or false on failure.

Examples

- https://redis.io/commands/sintercard + https://redis.io/docs/latest/commands/setex/

- +

$redis->sAdd('set1', 'apple', 'pear', 'banana', 'carrot');

-$redis->sAdd('set2', 'apple',         'banana');

-$redis->sAdd('set3',          'pear', 'banana');

-

-$redis->sInterCard(['set1', 'set2', 'set3']);

-?>

-</code>

$redis->setex('60s-ttl', 60, 'some-value');

@@ -12383,47 +18294,46 @@

Examples

-
at line 2222
- `Redis|int|false - sInterStore(array|string $key, string ...$other_keys) -` + +

+
at line 4114
+ `Redis|bool setnx(string $key, mixed $value)`

Perform the intersection of one or more Redis SETs, storing the result in a destination -key, rather than returning them.

Set a key to a value, but only if that key does not already exist.

Parameters

- + - + - - - + + +

array\|string	string	$key		The key name to set.
string	...$other_keys	If the first argument was a string, subsequent arguments should -be source key names.	mixed	$value	What to set the key to.

Return Value

- +

- - + +

Redis|int|false

The number of values stored in the destination key or false on failure.

Redis|bool

Returns true if the key was set and false otherwise.

Examples

- https://redis.io/commands/sinterstore -
- \Redis::sinter() + https://redis.io/docs/latest/commands/setnx/

- + - +

$redis->sInterStore(['dst', 'src1', 'src2', 'src3']);

$redis->setnx('existing-key', 'existing-value');

$redis->sInterStore('dst', 'src1', 'src'2', 'src3');

-?>

-</code>

$redis->setnx('new-key', 'new-value');

@@ -12462,18 +18364,17 @@

Examples

-
at line 2237
- `Redis|array|false - sMembers(string $key) -` + +

+
at line 4128
+ `Redis|bool sismember(string $key, mixed $value)`

Retrieve every member from a set key.

Check whether a given value is the member of a Redis SET.

Parameters

@@ -12482,20 +18383,27 @@

Parameters

string $key -

The set name.

The redis set to check.

+ + + mixed + $value +

The value to test.

Return Value

- +

- - + +

Redis|array|false

Every element in the set or false on failure.

Redis|bool

True if the member exists and false if not.

Examples

- https://redis.io/commands/smembers + https://redis.io/docs/latest/commands/sismember/

- +

$redis->sAdd('tng-crew', ...['Picard', 'Riker', 'Data', 'Worf', 'La Forge', 'Troi', 'Crusher', 'Broccoli']);

-$redis->sMembers('tng-crew');

$redis->sismember('myset', 'mem1', 'mem2');

@@ -12524,51 +18431,58 @@

Examples

-
at line 2257
- `Redis|array|false - sMisMember(string $key, string $member, string ...$other_members) -` + +

+
at line 4148
+ `Redis|bool slaveof(string|null $host = null, int $port = 6379) deprecated`

+ deprecated + + + + +

Check if one or more values are members of a set.

Turn a redis instance into a replica of another or promote a replica +to a primary.

This method and the corresponding command in Redis has been marked deprecated +and users should instead use Redis::replicaof() if connecting to redis-server

+
= 5.0.0.
+

Parameters

- - - - - - - - + + + - - - + + +

string	$key	The set to query.
string	$member	The first value to test if exists in the set.	string\|null	$host
string	...$other_members	Any number of additional values to check.	int	$port

Return Value

- +

- - + +

Redis|array|false

An array of integers representing whether each passed value -was a member of the set.

Redis|bool

Examples

- https://redis.io/commands/smismember + https://redis.io/docs/latest/commands/slaveof/
- https://redis.io/commands/smember + https://redis.io/docs/latest/commands/replicaof/
- \Redis::smember() + +Redis::replicaof

- +

$redis->sAdd('ds9-crew', ...["Sisko", "Kira", "Dax", "Worf", "Bashir", "O'Brien"]);

-$members = $redis->sMIsMember('ds9-crew', ...['Sisko', 'Picard', 'Data', 'Worf']);

$redis->slaveof('10.0.0.5', 6380);

@@ -12609,51 +18523,48 @@

Examples

-
at line 2277
- `Redis|bool - sMove(string $src, string $dst, mixed $value) -` + +

+
at line 4174
+ `Redis|bool replicaof(string|null $host = null, int $port = 6379)`

Pop a member from one set and push it onto another. This command will create the -destination set if it does not currently exist.

Used to turn a Redis instance into a replica of another, or to remove +replica status promoting the instance to a primary.

Parameters

- - - - - - - - + + + - - - + + +

string	$src	The source set.
string	$dst	The destination set.	string\|null	$host	The host of the primary to start replicating.
mixed	$value	The member you wish to move.	int	$port	The port of the primary to start replicating.

Return Value

- +

Redis|bool

True if the member was moved, and false if it wasn't in the set.

Success if we were successfully able to start replicating a primary or +were able to promote the replicat to a primary.

Examples

- https://redis.io/commands/smove + https://redis.io/docs/latest/commands/replicaof/ +
+ https://redis.io/docs/latest/commands/slaveof/ +
+ +Redis::slaveof

- +

$redis->sAdd('numbers', 'zero', 'one', 'two', 'three', 'four');

-$redis->sMove('numbers', 'evens', 'zero');

-$redis->sMove('numbers', 'evens', 'two');

-$redis->sMove('numbers', 'evens', 'four');

$redis = new Redis(['host' => 'localhost']);
+
+// Attempt to become a replica of a Redis instance at 127.0.0.1:9999
+$redis->replicaof('127.0.0.1', 9999);
+
+// When passed no arguments, PhpRedis will deliver the command `REPLICAOF NO ONE`
+// attempting to promote the instance to a primary.
+$redis->replicaof();

@@ -12684,46 +18612,48 @@

Examples

-
at line 2293
- `Redis|string|array|false - sPop(string $key, int $count = 0) -` + +

+
at line 4192
+ `Redis|int|false touch(array|string $key_or_array, string ...$more_keys)`

Remove one or more elements from a set.

Update one or more keys last modified metadata.

Parameters

- - - + + + - - - + + +

string	$key	The set in question.	array\|string	$key_or_array	Either the first key or if passed as the only argument +an array of keys.
int	$count	An optional number of members to pop. This defaults to -removing one element.	string	...$more_keys	One or more keys to send to the command.

Return Value

- +

- - + +

Redis|string|array|false

Redis|int|false

This command returns the number of keys that exist and +had their last modified time reset

Examples

- https://redis.io/commands/spop + https://redis.io/docs/latest/commands/touch/

- +

$redis->del('numbers', 'evens');

-$redis->sAdd('numbers', 'zero', 'one', 'two', 'three', 'four');

-$redis->sPop('numbers');

$redis->touch('cache:1', 'cache:2');

@@ -12753,18 +18681,18 @@

Examples

-
at line 2316
- `Redis|string|array|false - sRandMember(string $key, int $count = 0) -` + +

+
at line 4220
+ `mixed slowlog(string $operation, int $length = 0)`

Retrieve one or more random members of a set.

Interact with Redis' slowlog functionality in various ways, depending +on the value of 'operation'.

Parameters

@@ -12772,31 +18700,36 @@

Parameters

- - + + - - + +

string

$key

The set to query.

$operation

The operation you wish to perform. This can +be one of the following values: +'GET' - Retrieve the Redis slowlog as an array. +'LEN' - Retrieve the length of the slowlog. +'RESET' - Remove all slowlog entries.

int

$count

An optional count of members to return.

If this value is positive, Redis will return up to the requested -number but with unique elements that will never repeat. This means -you may recieve fewer then $count replies.

If the number is negative, Redis will return the exact number requested -but the result may contain duplicate elements.

$length

This optional argument can be passed when operation +is 'get' and will specify how many elements to retrieve. +If omitted Redis will send up to a default number of +entries, which is configurable.

Note: With Redis >= 7.0.0 you can send -1 to mean "all".

Return Value

- +

- - + +

Redis|string|array|false

One or more random members or false on failure.

mixed

Examples

- https://redis.io/commands/srandmember + https://redis.io/docs/latest/commands/slowlog/

- + - + - +

$redis->sRandMember('myset');

$redis->slowlog('get', -1);   // Retrieve all slowlog entries.

$redis->sRandMember('myset', 10);

$redis->slowlog('len');       // Retrieve slowlog length.

$redis->sRandMember('myset', -10);

$redis->slowlog('reset');     // Reset the slowlog.

@@ -12830,18 +18763,17 @@

Examples

-
at line 2330
- `Redis|array|false - sUnion(string $key, string ...$other_keys) -` + +

+
at line 4249
+ `mixed sort(string $key, array|null $options = null)`

Returns the union of one or more Redis SET keys.

Sort the contents of a Redis key in various ways.

Parameters

@@ -12850,25 +18782,31 @@

Parameters

string $key -

The first SET to do a union with

The key you wish to sort

- string - ...$other_keys -

One or more subsequent keys

+ array|null + $options +

Various options controlling how you would like the +data sorted. See blow for a detailed description +of this options array.

Return Value

- +

- - + +

Redis|array|false

The union of the one or more input sets or false on failure.

mixed

This command can either return an array with the sorted data +or the number of elements placed in a destination set when +using the STORE option.

Examples

- https://redis.io/commands/sunion + https://redis.io/docs/latest/commands/sort/

- +

$redis->sunion('set1', 'set2');

$options = [
+    'SORT'  => 'ASC'|| 'DESC' // Sort in descending or descending order.
+    'ALPHA' => true || false  // Whether to sort alphanumerically.
+    'LIMIT' => [0, 10]        // Return a subset of the data at offset, count
+    'BY'    => 'weight_*'     // For each element in the key, read data from the
+                                 external key weight_* and sort based on that value.
+    'GET'   => 'weight_*'     // For each element in the source key, retrieve the
+                                 data from key weight_* and return that in the result
+                                 rather than the source keys' element.  This can
+                                 be used in combination with 'BY'
+];

@@ -12896,18 +18844,17 @@

Examples

-
at line 2345
- `Redis|int|false - sUnionStore(string $dst, string $key, string ...$other_keys) -` + +

+
at line 4261
+ `mixed sort_ro(string $key, array|null $options = null)`

Perform a union of one or more Redis SET keys and store the result in a new set

This is simply a read-only variant of the sort command

Parameters

@@ -12915,32 +18862,28 @@

Parameters

- - - - - - + - - - + + +

string	$dst	The destination key
string	$key	The first source key
string	...$other_keys	One or more additional source keys	array\|null	$options

Return Value

- +

- - + +

Redis|int|false

The number of elements stored in the destination SET or -false on failure.

mixed

Examples

+ + + + + +

$redis->sort_ro('numbers', ['LIMIT' => [0, 5]]);

-
at line 2356
- `Redis|bool - save() -` + +

+
at line 4272
+ `array sortAsc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) deprecated`

+ deprecated + + + + +

Persist the Redis database to disk. This command will block the server until the save is -completed. For a nonblocking alternative, see Redis::bgsave().

No description

- -

Return Value

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

string	$key
string\|null	$pattern
mixed	$get
int	$offset
int	$count
string\|null	$store

+ + +

Return Value

+ +

+ - - + +

Redis|bool

Returns true unless an error occurs.

array

Examples

+ + - - +

- \Redis::bgsave() -

$redis->sortAsc('numbers');

-
at line 2419
- `array|false - scan(int|null $iterator, string|null $pattern = null, int $count = 0, string $type = NULL) -` + +

+
at line 4283
+ `array sortAscAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) deprecated`

+ deprecated + + + + +

Incrementally scan the Redis keyspace, with optional pattern and type matching.

A note about Redis::SCAN_NORETRY and Redis::SCAN_RETRY.

For convenience, PhpRedis can retry SCAN commands itself when Redis returns an empty array of -keys with a nonzero iterator. This can happen when matching against a pattern that very few -keys match inside a key space with a great many keys. The following example demonstrates how -to use Redis::scan() with the option disabled and enabled.

No description

Parameters

- - - + + + - + + + + + + + + + + + - + - - - + + +

int\|null	$iterator	The cursor returned by Redis for every subsequent call to SCAN. On -the initial invocation of the call, it should be initialized by the -caller to NULL. Each time SCAN is invoked, the iterator will be -updated to a new number, until finally Redis will set the value to -zero, indicating that the scan is complete.	string	$key
string\|null	$pattern	An optional glob-style pattern for matching key names. If passed as -NULL, it is the equivalent of sending '*' (match every key).
mixed	$get
int	$offset
int	$count	A hint to redis that tells it how many keys to return in a single -call to SCAN. The larger the number, the longer Redis may block -clients while iterating the key space.
string	$type	An optional argument to specify which key types to scan (e.g. -'STRING', 'LIST', 'SET')	string\|null	$store

Return Value

- +

- - + +

array|false

An array of keys, or false if no keys were returned for this -invocation of scan. Note that it is possible for Redis to return -zero keys before having scanned the entire key space, so the caller -should instead continue to SCAN until the iterator reference is -returned to zero.

array

Examples

- https://redis.io/commands/scan -
- -Redis::setOption + https://redis.io/docs/latest/commands/sort/

- +

$redis = new Redis(['host' => 'localhost']);

-

-$redis->setOption(Redis::OPT_SCAN, Redis::SCAN_NORETRY);

-

-$it = NULL;

-

-do {

-    $keys = $redis->scan($it, '*zorg*');

-    foreach ($keys as $key) {

-        echo "KEY: $key\n";

-    }

-} while ($it != 0);

-

-$redis->setOption(Redis::OPT_SCAN, Redis::SCAN_RETRY);

-

-$it = NULL;

-

-// When Redis::SCAN_RETRY is enabled, we can use simpler logic, as we will never receive an

-// empty array of keys when the iterator is nonzero.

-while ($keys = $redis->scan($it, '*zorg*')) {

-    foreach ($keys as $key) {

-        echo "KEY: $key\n";

-    }

-}

$redis->sortAscAlpha('tags');

@@ -13138,18 +19108,25 @@

Examples

-
at line 2433
- `Redis|int|false - scard(string $key) -` + +

+
at line 4294
+ `array sortDesc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) deprecated`

+ deprecated + + + + +

Retrieve the number of members in a Redis set.

No description

Parameters

@@ -13158,20 +19135,47 @@

Parameters

string $key -

The set to get the cardinality of.

+ + + + string|null + $pattern + + + + mixed + $get + + + + int + $offset + + + + int + $count + + + + string|null + $store + -

Return Value

- +

- - + +

Redis|int|false

The cardinality of the set or false on failure.

array

Examples

- https://redis.io/commands/scard + https://redis.io/docs/latest/commands/sort/

- +

$redis->scard('set');

-</code>

$redis->sortDesc('numbers');

@@ -13200,45 +19203,74 @@

Examples

-
at line 2448
- `mixed - script(string $command, mixed ...$args) -` + +

+
at line 4305
+ `array sortDescAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) deprecated`

+ deprecated + + + + +

An administrative command used to interact with LUA scripts stored on the server.

No description

Parameters

- - - + + + + + + + + + + + + + + + + + + + + + + + - - - + + +

string	$command	The script suboperation to execute.	string	$key
string\|null	$pattern
mixed	$get
int	$offset
int	$count
mixed	...$args	One ore more additional argument	string\|null	$store

Return Value

- +

- - + +

mixed

This command returns various things depending on the specific operation executed.

array

Examples

- https://redis.io/commands/script + https://redis.io/docs/latest/commands/sort/

- - - - +

$redis->script('load', 'return 1');
$redis->script('exists', sha1('return 1'));	$redis->sortDescAlpha('tags');

@@ -13269,40 +19298,51 @@

Examples

-
at line 2461
- `Redis|bool - select(int $db) -` + +

+
at line 4320
+ `Redis|int|false srem(string $key, mixed $value, mixed ...$other_values)`

Select a specific Redis database.

Remove one or more values from a Redis SET key.

Parameters

- - - + + + + + + + + + + + + +

int	$db	The database to select. Note that by default Redis has 16 databases (0-15).	string	$key	The Redis SET key in question.
mixed	$value	The first value to remove.
mixed	...$other_values	One or more additional values to remove.

Return Value

- +

- - + +

Redis|bool

true on success and false on failure

Redis|int|false

The number of values removed from the set or false on failure.

Examples

- https://redis.io/commands/select + https://redis.io/docs/latest/commands/srem/

- +

$redis->select(1);

$redis->sRem('set1', 'mem1', 'mem2', 'not-in-set');

@@ -13330,18 +19370,17 @@

Examples

-
at line 2492
- `Redis|string|bool - set(string $key, mixed $value, mixed $options = NULL) -` + +

+
at line 4377
+ `array|false sscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)`

Create or set a Redis STRING key to a value.

Scan the members of a redis SET key.

Parameters

@@ -13350,43 +19389,42 @@

Parameters

string $key -

The key name to set.

The Redis SET key in question.

- mixed - $value -

The value to set the key to.

+ null|int|string + $iterator +

A reference to an iterator which should be initialized to NULL that +PhpRedis will update with the value returned from Redis after each +subsequent call to SSCAN. Once this cursor is zero you know all +members have been traversed.

- mixed - $options -

Either an array with options for how to perform the set or an -integer with an expiration. If an expiration is set PhpRedis -will actually send the SETEX command.

OPTION DESCRIPTION

['EX' => 60] expire 60 seconds. -['PX' => 6000] expire in 6000 milliseconds. -['EXAT' => time() + 10] expire in 10 seconds. -['PXAT' => time()*1000 + 1000] expire in 1 second. -['KEEPTTL' => true] Redis will not update the key's current TTL. -['XX'] Only set the key if it already exists. -['NX'] Only set the key if it doesn't exist. -['GET'] Instead of returning +OK return the previous value of the -key or NULL if the key didn't exist.

+ string|null + $pattern +

An optional glob style pattern to match against, so Redis only +returns the subset of members matching this pattern.

+ + + int + $count +

A hint to Redis as to how many members it should scan in one command +before returning members for that iteration.

Return Value

- +

- - + +

Redis|string|bool

True if the key was set or false on failure.

array|false

Examples

- https://redis.io/commands/set + https://redis.io/docs/latest/commands/sscan/ +
+ https://redis.io/docs/latest/commands/scan/
- https://redis.io/commands/setex + +Redis::setOption

- - - - +

$redis->set('key', 'value');

$redis->set('key', 'expires_in_60_seconds', 60);

$redis->del('myset');
+for ($i = 0; $i < 10000; $i++) {
+    $redis->sAdd('myset', "member:$i");
+}
+$redis->sadd('myset', 'foofoo');
+
+$redis->setOption(Redis::OPT_SCAN, Redis::SCAN_NORETRY);
+
+$scanned = 0;
+$it = null;
+
+// Without Redis::SCAN_RETRY we may receive empty results and
+// a nonzero iterator.
+do {
+    // Scan members containing '5'
+    $members = $redis->sscan('myset', $it, '*5*');
+    foreach ($members as $member) {
+         echo "NORETRY: $member\n";
+         $scanned++;
+    }
+} while ($it != 0);
+echo "TOTAL: $scanned\n";
+
+$redis->setOption(Redis::OPT_SCAN, Redis::SCAN_RETRY);
+
+$scanned = 0;
+$it = null;
+
+// With Redis::SCAN_RETRY PhpRedis will never return an empty array
+// when the cursor is non-zero
+while (($members = $redis->sscan('myset', $it, '*5*'))) {
+    foreach ($members as $member) {
+        echo "RETRY: $member\n";
+        $scanned++;
+    }
+}

@@ -13423,50 +19500,48 @@

Examples

-
at line 2508
- `Redis|int|false - setBit(string $key, int $idx, bool $value) -` + +

+
at line 4408
+ `bool ssubscribe(array $channels, callable $cb)`

Set a specific bit in a Redis string to zero or one

Subscribes the client to the specified shard channels.

Parameters

- - - - - - - - + + + - - - + + +

string	$key	The Redis STRING key to modify
int	$idx		array	$channels	One or more channel names.
bool	$value	Whether to set the bit to zero or one.	callable	$cb	The callback PhpRedis will invoke when we receive a message +from one of the subscribed channels.

Return Value

- +

- - + +

Redis|int|false

The original value of the bit or false on failure.

bool

True on success, false on faiilure. Note that this command will block the +client in a subscribe loop, waiting for messages to arrive.

Examples

- https://redis.io/commands/setbit + https://redis.io/docs/latest/commands/ssubscribe/

- +

$redis->set('foo', 'bar');

-$redis->setbit('foo', 7, 1);

$redis = new Redis(['host' => 'localhost']);
+
+$redis->ssubscribe(['channel-1', 'channel-2'], function ($redis, $channel, $message) {
+    echo "[$channel]: $message\n";
+
+    // Unsubscribe from the message channel when we read 'quit'
+    if ($message == 'quit') {
+        echo "Unsubscribing from '$channel'\n";
+        $redis->sunsubscribe([$channel]);
+    }
+});
+
+// Once we read 'quit' from both channel-1 and channel-2 the subscribe loop will be
+// broken and this command will execute.
+echo "Subscribe loop ended\n";

@@ -13495,18 +19583,17 @@

Examples

-
at line 2525
- `Redis|int|false - setRange(string $key, int $index, string $value) -` + +

+
at line 4422
+ `Redis|int|false strlen(string $key)`

Update or append to a Redis string at a specific starting index

Retrieve the length of a Redis STRING key.

Parameters

@@ -13515,30 +19602,23 @@

Parameters

string $key -

The key to update

- - - int - $index -

Where to insert the provided value

- - - string - $value -

The value to copy into the string.

The key we want the length of.

Return Value

- +

Redis|int|false

The new length of the string or false on failure

The length of the string key if it exists, zero if it does not, and +false on failure.

Examples

- https://redis.io/commands/setrange + https://redis.io/docs/latest/commands/strlen/

- +

$redis->set('message', 'Hello World');

-$redis->setRange('message', 6, 'Redis');

$redis->strlen('mykey');

@@ -13567,121 +19646,48 @@

Examples

-
at line 2557
- `bool - setOption(int $option, mixed $value) -` + +

+
at line 4453
+ `bool subscribe(array $channels, callable $cb)`

Set a configurable option on the Redis object.

Following are a list of options you can set:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

OPTION	TYPE	DESCRIPTION
OPT_MAX_RETRIES	int	The maximum number of times Redis will attempt to reconnect if it gets disconnected, before throwing an exception.
OPT_SCAN	enum	Redis::OPT_SCAN_RETRY, or Redis::OPT_SCAN_NORETRY. Whether PhpRedis should automatically SCAN again when zero keys but a nonzero iterator are returned.
OPT_SERIALIZER	enum	Set the automatic data serializer. `Redis::SERIALIZER_NONE` `Redis::SERIALIZER_PHP` `Redis::SERIALIZER_IGBINARY` `Redis::SERIALIZER_MSGPACK`, `Redis::SERIALIZER_JSON`
OPT_PREFIX	string	A string PhpRedis will use to prefix every key we read or write.
OPT_READ_TIMEOUT	float	How long PhpRedis will block for a response from Redis before throwing a 'read error on connection' exception.
OPT_TCP_KEEPALIVE	bool	Set or disable TCP_KEEPALIVE on the connection.
OPT_COMPRESSION	enum	Set the compression algorithm `Redis::COMPRESSION_NONE` `Redis::COMPRESSION_LZF` `Redis::COMPRESSION_LZ4` `Redis::COMPRESSION_ZSTD`
OPT_REPLY_LITERAL	bool	If set to true, PhpRedis will return the literal string Redis returns for LINE replies (e.g. '+OK'), rather than `true`.
OPT_COMPRESSION_LEVEL	int	Set a specific compression level if Redis is compressing data.
OPT_NULL_MULTIBULK_AS_NULL	bool	Causes PhpRedis to return `NULL` rather than `false` for NULL MULTIBULK replies
OPT_BACKOFF_ALGORITHM	enum	The exponential backoff strategy to use.
OPT_BACKOFF_BASE	int	The minimum delay between retries when backing off.
OPT_BACKOFF_CAP	int	The maximum delay between replies when backing off.

Subscribe to one or more Redis pubsub channels.

Parameters

- - - + + + - - - + + +

int	$option	The option constant.	array	$channels	One or more channel names.
mixed	$value	The option value.	callable	$cb	The callback PhpRedis will invoke when we receive a message +from one of the subscribed channels.

Return Value

- +

bool

true if the setting was updated, false if not.

True on success, false on faiilure. Note that this command will block the +client in a subscribe loop, waiting for messages to arrive.

Examples

+ + - - +

- -Redis::__construct -

for details about backoff strategies.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->subscribe(['channel-1', 'channel-2'], function ($redis, $channel, $message) {
+    echo "[$channel]: $message\n";
+
+    // Unsubscribe from the message channel when we read 'quit'
+    if ($message == 'quit') {
+        echo "Unsubscribing from '$channel'\n";
+        $redis->unsubscribe([$channel]);
+    }
+});
+
+// Once we read 'quit' from both channel-1 and channel-2 the subscribe loop will be
+// broken and this command will execute.
+echo "Subscribe loop ended\n";

-
at line 2570
- `Redis|bool - setex(string $key, int $expire, mixed $value) -` + +

+
at line 4477
+ `Redis|array|bool sunsubscribe(array $channels)`

Set a Redis STRING key with a specific expiration in seconds.

Unsubscribes the client from the given shard channels, +or from all of them if none is given.

Parameters

- - - - - - - - - - - - - + + +

string	$key	The name of the key to set.
int	$expire	The key's expiration in seconds.
mixed	$value	The value to set the key.	array	$channels	One or more channels to unsubscribe from.

Return Value

- +

- - + +

Redis|bool

True on success or false on failure.

Redis|array|bool

The array of unsubscribed channels.

Examples

- +

$redis->setex('60s-ttl', 60, 'some-value');

$redis->ssubscribe(['channel-1', 'channel-2'], function ($redis, $channel, $message) {
+    if ($message == 'quit') {
+        echo "$channel => 'quit' detected, unsubscribing!\n";
+        $redis->sunsubscribe([$channel]);
+    } else {
+        echo "$channel => $message\n";
+    }
+});
+
+echo "We've unsubscribed from both channels, exiting\n";

@@ -13769,45 +19808,48 @@

Examples

-
at line 2585
- `Redis|bool - setnx(string $key, mixed $value) -` + +

+
at line 4500
+ `Redis|bool swapdb(int $src, int $dst)`

Set a key to a value, but only if that key does not already exist.

Atomically swap two Redis databases so that all of the keys in the source database will +now be in the destination database and vice-versa.

Note: This command simply swaps Redis' internal pointer to the database and is therefore +very fast, regardless of the size of the underlying databases.

Parameters

- - - + + + - - - + + +

string	$key	The key name to set.	int	$src	The source database number
mixed	$value	What to set the key to.	int	$dst	The destination database number

Return Value

- +

Redis|bool

Returns true if the key was set and false otherwise.

Success if the databases could be swapped and false on failure.

Examples

- https://redis.io/commands/setnx + https://redis.io/docs/latest/commands/swapdb/ +
+ +Redis::del

- - - - +

$redis->setnx('existing-key', 'existing-value');
$redis->setnx('new-key', 'new-value');	$redis->select(0); +$redis->set('db0-key', 'db0-value'); +$redis->swapdb(0, 1); +$redis->get('db0-key');

@@ -13838,53 +19887,51 @@

Examples

-
at line 2597
- `Redis|bool - sismember(string $key, mixed $value) -` + +

+
at line 4512
+ `Redis|array time()`

Check whether a given value is the member of a Redis SET.

Retrieve the server time from the connected Redis instance.

Parameters

- - - - - - - - - - - - -

string	$key	The redis set to check.
mixed	$value	The value to test.

- -

Return Value

- +

- - + +

Redis|bool

True if the member exists and false if not.

Redis|array

A two element array consisting of a Unix Timestamp and the number of microseconds +elapsed since the second.

Examples

- +

$redis->sismember('myset', 'mem1', 'mem2');

$redis->time();

@@ -13893,30 +19940,17 @@

Examples

-
at line 2613
- `Redis|bool - slaveof(string $host = NULL, int $port = 6379) - deprecated` + +

+
at line 4526
+ `Redis|int|false ttl(string $key)`

- deprecated - - - - -

Turn a redis instance into a replica of another or promote a replica -to a primary.

This method and the corresponding command in Redis has been marked deprecated -and users should instead use Redis::replicaof() if connecting to redis-server

-
= 5.0.0.
-

Get the amount of time a Redis key has before it will expire, in seconds.

Parameters

@@ -13924,26 +19958,25 @@

Parameters

- - - - - - - + +

string	$host
int	$port		$key	The Key we want the TTL for.

Return Value

- +

- - + +

Redis|bool

Redis|int|false

(a) The number of seconds until the key expires, or -1 if the key has +no expiration, and -2 if the key does not exist. In the event of an +error, this command will return false.

Examples

+ + - - +

- -Redis::replicaof -

$redis->ttl('mykey');

-
at line 2639
- `Redis|bool - replicaof(string $host = NULL, int $port = 6379) -` + +

+
at line 4552
+ `Redis|int|false type(string $key)`

Used to turn a Redis instance into a replica of another, or to remove -replica status promoting the instance to a primary.

Get the type of a given Redis key.

Parameters

@@ -13996,27 +20022,32 @@

Parameters

- - - - - - - + +

string	$host	The host of the primary to start replicating.
int	$port	The port of the primary to start replicating.	$key	The key to check

Return Value

- +

- - + +

Redis|bool

Success if we were successfully able to start replicating a primary or -were able to promote teh replicat to a primary.

Redis|int|false

The Redis type constant or false on failure.

The Redis class defines several type constants that correspond with Redis key types.

Redis::REDIS_NOT_FOUND
+Redis::REDIS_STRING
+Redis::REDIS_SET
+Redis::REDIS_LIST
+Redis::REDIS_ZSET
+Redis::REDIS_HASH
+Redis::REDIS_STREAM
+Redis::REDIS_VECTORSET

Examples

- https://redis.io/commands/replicaof -
- https://redis.io/commands/slaveof -
- -Redis::slaveof + https://redis.io/docs/latest/commands/type/

- +

$redis = new Redis(['host' => 'localhost']);

-

-// Attempt to become a replica of a Redis instance at 127.0.0.1:9999

-$redis->replicaof('127.0.0.1', 9999);

-

-// When passed no arguments, PhpRedis will deliver the command `REPLICAOF NO ONE`

-// attempting to promote the instance to a primary.

-$redis->replicaof();

foreach ($redis->keys('*') as $key) {
+    echo "$key => " . $redis->type($key) . "\n";
+}

@@ -14064,18 +20077,19 @@

Examples

-
at line 2653
- `Redis|int|false - touch(array|string $key_or_array, string ...$more_keys) -` + +

+
at line 4573
+ `Redis|int|false unlink(array|string $key, string ...$other_keys)`

Update one or more keys last modified metadata.

Delete one or more keys from the Redis database. Unlike this operation, the actual +deletion is asynchronous, meaning it is safe to delete large keys without fear of +Redis blocking for a long period of time.

Parameters

@@ -14083,94 +20097,108 @@

Parameters

- - + + - - + +

array\|string	$key_or_array		$key	Either an array with one or more keys or a string with +the first key to delete.
string	...$more_keys	One or more keys to send to the command.	...$other_keys	If the first argument passed to this method was a string +you may pass any number of additional key names.

Return Value

- +

Redis|int|false

This command returns the number of keys that exist and -had their last modified time reset

The number of keys deleted or false on failure.

Examples

+ + + + + + +

$redis->unlink('key1', 'key2', 'key3');

$redis->unlink(['key1', 'key2', 'key3']);

-
at line 2681
- `mixed - slowlog(string $operation, int $length = 0) -` + +

+
at line 4596
+ `Redis|array|bool unsubscribe(array $channels)`

Interact with Redis' slowlog functionality in various ways, depending -on the value of 'operation'.

Unsubscribe from one or more subscribed channels.

Parameters

- - - - - - - - + + +

string

$operation

The operation you wish to perform. This can -be one of the following values: -'GET' - Retrieve the Redis slowlog as an array. -'LEN' - Retrieve the length of the slowlog. -'RESET' - Remove all slowlog entries.

int

$length

This optional argument can be passed when operation -is 'get' and will specify how many elements to retrieve. -If omitted Redis will send up to a default number of -entries, which is configurable.

Note: With Redis >= 7.0.0 you can send -1 to mean "all".

array

$channels

One or more channels to unsubscribe from.

Return Value

- +

- - + +

mixed

Redis|array|bool

The array of unsubscribed channels.

Examples

- https://redis.io/commands/slowlog/ + https://redis.io/docs/latest/commands/unsubscribe/ +
+ +Redis::subscribe

- - - - - - - +

$redis->slowlog('get', -1);   // Retrieve all slowlog entries.

$redis->slowlog('len');       // Retrieve slowlog length.

$redis->slowlog('reset');     // Reset the slowlog.

$redis->subscribe(['channel-1', 'channel-2'], function ($redis, $channel, $message) {
+    if ($message == 'quit') {
+        echo "$channel => 'quit' detected, unsubscribing!\n";
+        $redis->unsubscribe([$channel]);
+    } else {
+        echo "$channel => $message\n";
+    }
+});
+
+echo "We've unsubscribed from both channels, exiting\n";

@@ -14204,49 +20242,31 @@

Examples

-
at line 2710
- `mixed - sort(string $key, array|null $options = null) -` + +

+
at line 4611
+ `Redis|bool unwatch()`

Sort the contents of a Redis key in various ways.

Remove any previously WATCH'ed keys in a transaction.

Parameters

- - - - - - - - - - - - -

string	$key	The key you wish to sort
array\|null	$options	Various options controlling how you would like the -data sorted. See blow for a detailed description -of this options array.

- -

Return Value

- +

- - + +

mixed

This command can either return an array with the sorted data -or the number of elements placed in a destination set when -using the STORE option.

Redis|bool

True on success and false on failure.

Examples

- https://redis.io/commands/sort/ + https://redis.io/docs/latest/commands/unwatch/ +
+ https://redis.io/docs/latest/commands/unwatch/ +
+ +Redis::watch

- +

$options = [

-    'SORT'  => 'ASC'|| 'DESC' // Sort in descending or descending order.

-    'ALPHA' => true || false  // Whether to sort alphanumerically.

-    'LIMIT' => [0, 10]        // Return a subset of the data at offset, count

-    'BY'    => 'weight_*'     // For each element in the key, read data from the

-                                 external key weight_* and sort based on that value.

-    'GET'   => 'weight_*'     // For each element in the source key, retrieve the

-                                 data from key weight_* and return that in the result

-                                 rather than the source keys' element.  This can

-                                 be used in combination with 'BY'

-];

$redis->unwatch();

@@ -14284,45 +20307,47 @@

Examples

-
at line 2717
- `mixed - sort_ro(string $key, array|null $options = null) -` + +

+
at line 4651
+ `Redis|bool watch(array|string $key, string ...$other_keys)`

This is simply a read-only variant of the sort command

Watch one or more keys for conditional execution of a transaction.

Parameters

- + - + - - - + + +

string	array\|string	$key		Either an array with one or more key names, or a string key name
array\|null	$options		string	...$other_keys	If the first argument was passed as a string, any number of additional +string key names may be passed variadically.

Return Value

- +

mixed

Redis|bool

Examples

+ + + + + +

$redis1 = new Redis(['host' => 'localhost']);
+$redis2 = new Redis(['host' => 'localhost']);
+
+// Start watching 'incr-key'
+$redis1->watch('incr-key');
+
+// Retrieve its value.
+$val = $redis1->get('incr-key');
+
+// A second client modifies 'incr-key' after we read it.
+$redis2->set('incr-key', 0);
+
+// Because another client changed the value of 'incr-key' after we read it, this
+// is no longer a proper increment operation, but because we are `WATCH`ing the
+// key, this transaction will fail and we can try again.
+//
+// If were to comment out the above `$redis2->set('incr-key', 0)` line the
+// transaction would succeed.
+$redis1->multi();
+$redis1->set('incr-key', $val + 1);
+$res = $redis1->exec();
+
+// bool(false)
+var_dump($res);

-
at line 2722
- `array - sortAsc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) - deprecated` + +

+
at line 4668
+ `int|false wait(int $numreplicas, int $timeout)`

- deprecated - - - - -

No description

- +

Block the client up to the provided timeout until a certain number of replicas have confirmed +receiving them.

Parameters

- - - - - - - - - - - - - - - - - + + - - - - - - - + +

string	$key
string\|null	$pattern
mixed	$get
int	$offset	$numreplicas	The number of replicas we want to confirm write operations
int	$count
string\|null	$store	$timeout	How long to wait (zero meaning forever).

Return Value

- +

- - + +

array

int|false

The number of replicas that have confirmed or false on failure.

Examples

+ + + + + +

$redis->wait(1, 1000);

-
at line 2727
- `array - sortAscAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) - deprecated` + +

+
at line 4709
+ `int|false xack(string $key, string $group, array $ids)`

- deprecated - - - - -

No description

- +

Acknowledge one or more messages that are pending (have been consumed using XREADGROUP but +not yet acknowledged by XACK.)

Parameters

@@ -14446,148 +20492,105 @@

Parameters

string $key - - - - string|null - $pattern - - - - mixed - $get - - - - int - $offset - +

The stream to query.

- int - $count - + string + $group +

The consumer group to use.

- string|null - $store - + array + $ids +

An array of stream entry IDs.

Return Value

- +

- - + +

array

int|false

The number of acknowledged messages

- -

-
at line 2732
- `array - sortDesc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) - deprecated` -

- deprecated - - - - -

- - - -

No description

- -

Parameters

Return Value

Examples

- - - - -

array

+ +

$redis->xAdd('ships', '*', ['name' => 'Enterprise']);
+$redis->xAdd('ships', '*', ['name' => 'Defiant']);
+
+$redis->xGroup('CREATE', 'ships', 'Federation', '0-0');
+
+// Consume a single message with the consumer group 'Federation'
+$ship = $redis->xReadGroup('Federation', 'Picard', ['ships' => '>'], 1);
+
+/* Retrieve the ID of the message we read.
+assert(isset($ship['ships']));
+$id = key($ship['ships']);
+
+// The message we just read is now pending.
+$res = $redis->xPending('ships', 'Federation'));
+var_dump($res);
+
+// We can tell Redis we were able to process the message by using XACK
+$res = $redis->xAck('ships', 'Federation', [$id]);
+assert($res === 1);
+
+// The message should no longer be pending.
+$res = $redis->xPending('ships', 'Federation');
+var_dump($res);

+ + - - -

-
at line 2737
- `array - sortDescAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) - deprecated` + +

+
at line 4732
+ `Redis|string|false xadd(string $key, string $id, array $values, int $maxlen = 0, bool $approx = false, bool $nomkstream = false)`

- deprecated - - - - -

No description

- +

Append a message to a stream.

Parameters

@@ -14596,65 +20599,95 @@

Parameters

string $key - +

The stream name.

- string|null - $pattern - + string + $id +

The ID for the message we want to add. This can be the special value '' +which means Redis will generate the ID that appends the message to the +end of the stream. It can also be a value in the form - which will +generate an ID that appends to the end of entries with the same value +(if any exist).

- mixed - $get + array + $values int - $offset - + $maxlen +

If specified Redis will append the new message but trim any number of the +oldest messages in the stream until the length is <= $maxlen.

- int - $count - + bool + $approx +

Used in conjunction with $maxlen, this flag tells Redis to trim the stream +but in a more efficient way, meaning the trimming may not be exactly to +$maxlen values.

- string|null - $store - + bool + $nomkstream +

If passed as TRUE, the stream must exist for Redis to append the message.

Return Value

- +

array

Redis|string|false

Examples

+ + + + + + + + +

$redis->xAdd('ds9-season-1', '1-1', ['title' => 'Emissary Part 1']);

$redis->xAdd('ds9-season-1', '1-2', ['title' => 'A Man Alone']);

-
at line 2752
- `Redis|int|false - srem(string $key, mixed $value, mixed ...$other_values) -` + +

+
at line 4771
+ `Redis|bool|array xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = -1, bool $justid = false)`

Remove one or more values from a Redis SET key.

This command allows a consumer to claim pending messages that have been idle for a specified period of time.

Its purpose is to provide a mechanism for picking up messages that may have had a failed consumer.

Parameters

@@ -14663,30 +20696,52 @@

Parameters

string $key -

The Redis SET key in question.

The stream to check.

- mixed - $value -

The first value to remove.

+ string + $group +

The consumer group to query.

- mixed - ...$other_values - + string + $consumer +

Which consumer to check.

+ + + int + $min_idle +

The minimum time in milliseconds for the message to have been pending.

+ + + string + $start +

The minimum message id to check.

+ + + int + $count +

An optional limit on how many messages are returned.

+ + + bool + $justid +

If the client only wants message IDs and not all of their data.

Return Value

- +

- - + +

Redis|int|false

The number of values removed from the set or false on failure.

Redis|bool|array

An array of pending IDs or false if there are none, or on failure.

Examples

- https://redis.io/commands/srem + https://redis.io/docs/latest/commands/xautoclaim/ +
+ https://redis.io/docs/latest/commands/xclaim/ +
+ https://redis.io/docs/data-types/streams-tutorial/

- +

$redis->sRem('set1', 'mem1', 'mem2', 'not-in-set');

$redis->xGroup('CREATE', 'ships', 'combatants', '0-0', true);
+
+$redis->xAdd('ships', '1424-74205', ['name' => 'Defiant']);
+
+// Consume the ['name' => 'Defiant'] message
+$msgs = $redis->xReadGroup('combatants', "Jem'Hadar", ['ships' => '>'], 1);
+
+// The "Jem'Hadar" consumer has the message presently
+$pending = $redis->xPending('ships', 'combatants');
+var_dump($pending);
+
+// Assume control of the pending message with a different consumer.
+$res = $redis->xAutoClaim('ships', 'combatants', 'Sisko', 0, '0-0');
+
+// Now the 'Sisko' consumer owns the message
+$pending = $redis->xPending('ships', 'combatants');
+var_dump($pending);

@@ -14714,18 +20797,18 @@

Examples

-
at line 2809
- `array|false - sscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) -` + +

+
at line 4828
+ `Redis|array|bool xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options)`

Scan the members of a redis SET key.

This method allows a consumer to take ownership of pending stream entries, by ID. Another +command that does much the same thing but does not require passing specific IDs is Redis::xAutoClaim.

Parameters

@@ -14734,40 +20817,62 @@

Parameters

string $key -

The Redis SET key in question.

The stream we wish to claim messages for.

- int|null - $iterator -

A reference to an iterator which should be initialized to NULL that -PhpRedis will update with the value returned from Redis after each -subsequent call to SSCAN. Once this cursor is zero you know all -members have been traversed.

+ string + $group +

Our consumer group.

- string|null - $pattern -

An optional glob style pattern to match against, so Redis only -returns the subset of members matching this pattern.

+ string + $consumer +

Our consumer.

int - $count -

A hint to Redis as to how many members it should scan in one command -before returning members for that iteration.

+ $min_idle +

The minimum idle-time in milliseconds a message must have for ownership to be transferred.

+ + + array + $ids + + + + array + $options +

An options array that modifies how the command operates.

# Following is an options array describing every option you can pass.  Note that
+# 'IDLE', and 'TIME' are mutually exclusive.
+$options = [
+    'IDLE'       => 3           # Set the idle time of the message to a 3.  By default
+                                # the idle time is set to zero.
+    'TIME'       => 1000*time() # Same as IDLE except it takes a unix timestamp in
+                                # milliseconds.
+    'RETRYCOUNT' => 0           # Set the retry counter to zero.  By default XCLAIM
+                                # doesn't modify the counter.
+    'FORCE'                     # Creates the pending message entry even if IDs are
+                                # not already
+                                # in the PEL with another client.
+    'JUSTID'                    # Return only an array of IDs rather than the messages
+                                # themselves.
+];

Return Value

- +

- - + +

array|false

Redis|array|bool

An array of claimed messages or false on failure.

Examples

- https://redis.io/commands/sscan -
- https://redis.io/commands/scan + https://redis.io/docs/latest/commands/xclaim/
- -Redis::setOption + https://redis.io/docs/latest/commands/xautoclaim./

- +

$redis->del('myset');

-for ($i = 0; $i < 10000; $i++) {

-    $redis->sAdd('myset', "member:$i");

-}

-$redis->sadd('myset', 'foofoo');

-

-$redis->setOption(Redis::OPT_SCAN, Redis::SCAN_NORETRY);

-

-$scanned = 0;

-$it = NULL;

-

-// Without Redis::SCAN_RETRY we may receive empty results and

-// a nonzero iterator.

-do {

-    // Scan members containing '5'

-    $members = $redis->sscan('myset', $it, '*5*');

-    foreach ($members as $member) {

-         echo "NORETRY: $member\n";

-         $scanned++;

-    }

-} while ($it != 0);

-echo "TOTAL: $scanned\n";

-

-$redis->setOption(Redis::OPT_SCAN, Redis::SCAN_RETRY);

-

-$scanned = 0;

-$it = NULL;

-

-// With Redis::SCAN_RETRY PhpRedis will never return an empty array

-// when the cursor is non-zero

-while (($members = $redis->sscan('myset', $it, '*5*'))) {

-    foreach ($members as $member) {

-        echo "RETRY: $member\n";

-        $scanned++;

-    }

-}

$redis->xGroup('CREATE', 'ships', 'combatants', '0-0', true);
+
+$redis->xAdd('ships', '1424-74205', ['name' => 'Defiant']);
+
+// Consume the ['name' => 'Defiant'] message
+$msgs = $redis->xReadGroup('combatants', "Jem'Hadar", ['ships' => '>'], 1);
+
+// The "Jem'Hadar" consumer has the message presently
+$pending = $redis->xPending('ships', 'combatants');
+var_dump($pending);
+
+assert($pending && isset($pending[1]));
+
+// Claim the message by ID.
+$claimed = $redis->xClaim('ships', 'combatants', 'Sisko', 0, [$pending[1]], ['JUSTID']);
+var_dump($claimed);
+
+// Now the 'Sisko' consumer owns the message
+$pending = $redis->xPending('ships', 'combatants');
+var_dump($pending);

@@ -14843,18 +20925,17 @@

Examples

-
at line 2823
- `Redis|int|false - strlen(string $key) -` + +

+
at line 4842
+ `Redis|int|false xdel(string $key, array $ids)`

Retrieve the length of a Redis STRING key.

Remove one or more specific IDs from a stream.

Parameters

@@ -14863,21 +20944,27 @@

Parameters

string $key -

The key we want the length of.

The stream to modify.

+ + + array + $ids +

One or more message IDs to remove.

Return Value

- +

Redis|int|false

The length of the string key if it exists, zero if it does not, and -false on failure.

The number of messages removed or false on failure.

Examples

- https://redis.io/commands/strlen + https://redis.io/docs/latest/commands/xdel/

- +

$redis->strlen('mykey');

$redis->xDel('stream', ['1-1', '2-1', '3-1']);

@@ -14905,47 +20992,53 @@

Examples

-
at line 2854
- `bool - subscribe(array $channels, callable $cb) -` + +

+
at line 4861
+ `Redis|array|false xdelex(string $key, array $ids, string|null $mode = null)`

Subscribe to one or more Redis pubsub channels.

Remove one or more IDs from a stream with extended options.

Parameters

+ + + + + - - + + - - - + + +

string	$key	The stream to modify.
array	$channels	One or more channel names.	$ids	One or more message IDs to remove.
callable	$cb	The callback PhpRedis will invoke when we receive a message -from one of the subscribed channels.	string\|null	$mode	An optional mode argument. Valid modes +are as follows: KEEPREF \| DELREF \| ACKED

Return Value

- +

- - + +

bool

True on success, false on faiilure. Note that this command will block the -client in a subscribe loop, waiting for messages to arrive.

Redis|array|false

An array corresponding to IDs. 1 if the id was +deleted and 0 if not.

Examples

- https://redis.io/commands/subscribe + https://redis.io/docs/latest/commands/xdelex/

- +

$redis = new Redis(['host' => 'localhost']);

-

-$redis->subscribe(['channel-1', 'channel-2'], function ($redis, $channel, $message) {

-    echo "[$channel]: $message\n";

-

-    // Unsubscribe from the message channel when we read 'quit'

-    if ($message == 'quit') {

-        echo "Unsubscribing from '$channel'\n";

-        $redis->unsubscribe([$channel]);

-    }

-});

-

-// Once we read 'quit' from both channel-1 and channel-2 the subscribe loop will be

-// broken and this command will execute.

-echo "Subscribe loop ended\n";

$redis->xadd('s', '*', ['field' => 'value1']);
+$redis->xdelex('s', ['1-0'], 'KEEPREF');

@@ -14987,47 +21067,85 @@

Examples

-
at line 2877
- `Redis|bool - swapdb(int $src, int $dst) -` + +

+
at line 4902
+ `mixed xgroup(string $operation, string|null $key = null, string|null $group = null, string|null $id_or_consumer = null, bool $mkstream = false, int $entries_read = -2)`

Atomically swap two Redis databases so that all of the keys in the source database will -now be in the destination database and vice-versa.

Note: This command simply swaps Redis' internal pointer to the database and is therefore -very fast, regardless of the size of the underlying databases.

XGROUP

Perform various operation on consumer groups for a particular Redis STREAM. What the command does +is primarily based on which operation is passed.

Parameters

- - - + + + + + + + + + + + + + + + + + + + + + + + - - + +

int	$src	The source database number	string	$operation	The subcommand you intend to execute. Valid options are as follows +'HELP' - Redis will return information about the command +Requires: none +'CREATE' - Create a consumer group. +Requires: Key, group, consumer. +'SETID' - Set the ID of an existing consumer group for the stream. +Requires: Key, group, id. +'CREATECONSUMER' - Create a new consumer group for the stream. You must +also pass key, group, and the consumer name you wish to +create. +Requires: Key, group, consumer. +'DELCONSUMER' - Delete a consumer from group attached to the stream. +Requires: Key, group, consumer. +'DESTROY' - Delete a consumer group from a stream. +Requires: Key, group.
string\|null	$key	The STREAM we're operating on.
string\|null	$group	The consumer group we want to create/modify/delete.
string\|null	$id_or_consumer	The STREAM id (e.g. '$') or consumer group. See the operation section +for information about which to send.
bool	$mkstream	This flag may be sent in combination with the 'CREATE' operation, and +cause Redis to also create the STREAM if it doesn't currently exist.
int	$dst	The destination database number	$entries_read	Allows you to set Redis' 'entries-read' STREAM value. This argument is +only relevant to the 'CREATE' and 'SETID' operations. +Note: Requires Redis >= 7.0.0.

Return Value

- +

- - + +

Redis|bool

Success if the databases could be swapped and false on failure.

mixed

This command return various results depending on the operation performed.

Examples

- https://redis.io/commands/swapdb -
- -Redis::del + https://redis.io/docs/latest/commands/xgroup/

- +

$redis->select(0);

-$redis->set('db0-key', 'db0-value');

-$redis->swapdb(0, 1);

-$redis->get('db0-key');

$redis->xgroup('CREATE', 'mystream', 'workers', '$');

@@ -15065,31 +21173,56 @@

Examples

-
at line 2889
- `Redis|array - time() -` + +

+
at line 4921
+ `mixed xinfo(string $operation, string|null $arg1 = null, string|null $arg2 = null, int $count = -1)`

Retrieve the server time from the connected Redis instance.

Retrieve information about a stream key.

- -

Return Value

Parameters

+ + + + + + + + + + + + + + + + + + + + +

string	$operation	The specific info operation to perform.
string\|null	$arg1	The first argument (depends on operation)
string\|null	$arg2	The second argument
int	$count	The COUNT argument to `XINFO STREAM`

+ + +

Return Value

+ +

+ - - + +

Redis|array

two element array consisting of a Unix Timestamp and the number of microseconds -elapsed since the second.

mixed

This command can return different things depending on the operation being called.

Examples

- https://redis.io/commands/time + https://redis.io/docs/latest/commands/xinfo/

- + + + + + + +

$redis->time();	$redis->xInfo('CONSUMERS', 'stream');
$redis->xInfo('GROUPS', 'stream');
$redis->xInfo('STREAM', 'stream');

@@ -15117,18 +21256,17 @@

Examples

-
at line 2903
- `Redis|int|false - ttl(string $key) -` + +

+
at line 4935
+ `Redis|int|false xlen(string $key)`

Get the amount of time a Redis key has before it will expire, in seconds.

Get the number of messages in a Redis STREAM key.

Parameters

@@ -15137,22 +21275,22 @@

Parameters

string $key -

The Key we want the TTL for.

The Stream to check.

Return Value

- +

Redis|int|false

(a) The number of seconds until the key expires, or -1 if the key has -no expiration, and -2 if the key does not exist. In the event of an -error, this command will return false.

The number of messages or false on failure.

Examples

- https://redis.io/commands/ttl + https://redis.io/docs/latest/commands/xlen/

- +

$redis->ttl('mykey');

$redis->xLen('stream');

@@ -15180,18 +21318,18 @@

Examples

-
at line 2928
- `Redis|int|false - type(string $key) -` + +

+
at line 4957
+ `Redis|array|false xpending(string $key, string $group, string|null $start = null, string|null $end = null, int $count = -1, string|null $consumer = null)`

Get the type of a given Redis key.

Interact with stream messages that have been consumed by a consumer group but not yet +acknowledged with XACK.

Parameters

@@ -15200,28 +21338,47 @@

Parameters

string $key -

The key to check

The stream to inspect.

+ + + string + $group +

The user group we want to see pending messages from.

+ + + string|null + $start +

The minimum ID to consider.

+ + + string|null + $end +

The maximum ID to consider.

+ + + int + $count +

Optional maximum number of messages to return.

+ + + string|null + $consumer +

If provided, limit the returned messages to a specific consumer.

Return Value

- +

- - + +

Redis|int|false

The Redis type constant or false on failure.

The Redis class defines several type constants that correspond with Redis key types.

Redis::REDIS_NOT_FOUND
-Redis::REDIS_STRING
-Redis::REDIS_SET
-Redis::REDIS_LIST
-Redis::REDIS_ZSET
-Redis::REDIS_HASH
-Redis::REDIS_STREAM

Redis|array|false

The pending messages belonging to the stream or false on failure.

Examples

- https://redis.io/commands/type + https://redis.io/docs/latest/commands/xpending/ +
+ https://redis.io/docs/latest/commands/xreadgroup/

- +

foreach ($redis->keys('*') as $key) {

-    echo "$key => " . $redis->type($key) . "\n";

-}

$redis->xpending('mystream', 'workers', '-', '+', 10);

@@ -15251,48 +21412,56 @@

Examples

-
at line 2949
- `Redis|int|false - unlink(array|string $key, string ...$other_keys) -` + +

+
at line 4974
+ `Redis|array|bool xrange(string $key, string $start, string $end, int $count = -1)`

Delete one or more keys from the Redis database. Unlike this operation, the actual -deletion is asynchronous, meaning it is safe to delete large keys without fear of -Redis blocking for a long period of time.

Get a range of entries from a STREAM key.

Parameters

- + - + - - + + + + + + + + + + + +

array\|string	string	$key		The stream key name to list.
string	...$other_keys	If the first argument passed to this method was a string -you may pass any number of additional key names.	$start	The minimum ID to return.
string	$end	The maximum ID to return.
int	$count	An optional maximum number of entries to return.

Return Value

- +

- - + +

Redis|int|false

The number of keys deleted or false on failure.

Redis|array|bool

The entries in the stream within the requested range or false on failure.

Examples

- https://redis.io/commands/unlink -
- https://redis.io/commands/del -
- -Redis::del + https://redis.io/docs/latest/commands/xrange/

- + - +

$redis->unlink('key1', 'key2', 'key3');	$redis->xRange('stream', '0-1', '0-2');
$redis->unlink(['key1', 'key2', 'key3']);	$redis->xRange('stream', '-', '+');

@@ -15336,18 +21492,17 @@

Examples

-
at line 2972
- `Redis|array|bool - unsubscribe(array $channels) -` + +

+
at line 4998
+ `Redis|array|bool xread(array $streams, int $count = -1, int $block = -1)`

Unsubscribe from one or more subscribed channels.

Consume one or more unconsumed elements in one or more streams.

Parameters

@@ -15355,21 +21510,34 @@

Parameters

- - + + + + + + + + + + + +

array	$channels	One or more channels to unsubscribe from.	$streams	An associative array with stream name keys and minimum id values.
int	$count	An optional limit to how many entries are returned per stream
int	$block	An optional maximum number of milliseconds to block the caller if no +data is available on any of the provided streams.

Return Value

- +

Redis|array|bool

The array of unsubscribed channels.

An array of read elements or false if there aren't any.

Examples

- https://redis.io/commands/unsubscribe -
- -Redis::subscribe + https://redis.io/docs/latest/commands/xread/

- +

$redis->subscribe(['channel-1', 'channel-2'], function ($redis, $channel, $message) {

-    if ($message == 'quit') {

-        echo "$channel => 'quit' detected, unsubscribing!\n";

-        $redis->unsubscribe([$channel]);

-    } else {

-        echo "$channel => $message\n";

-    }

-});

-

-echo "We've unsubscribed from both channels, exiting\n";

$redis->xAdd('s03', '3-1', ['title' => 'The Search, Part I']);
+$redis->xAdd('s03', '3-2', ['title' => 'The Search, Part II']);
+$redis->xAdd('s03', '3-3', ['title' => 'The House Of Quark']);
+$redis->xAdd('s04', '4-1', ['title' => 'The Way of the Warrior']);
+$redis->xAdd('s04', '4-3', ['title' => 'The Visitor']);
+$redis->xAdd('s04', '4-4', ['title' => 'Hippocratic Oath']);
+
+$redis->xRead(['s03' => '3-2', 's04' => '4-1']);

@@ -15413,30 +21572,61 @@

Examples

-
at line 2983
- `Redis|bool - unwatch() -` + +

+
at line 5033
+ `Redis|array|bool xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1)`

Remove any previously WATCH'ed keys in a transaction.

Read one or more messages using a consumer group.

- -

Return Value

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +

string	$group	The consumer group to use.
string	$consumer	The consumer to use.
array	$streams	An array of stream names and message IDs
int	$count	Optional maximum number of messages to return
int	$block	How long to block if there are no messages available.

+ + +

Return Value

+ +

+ - - + +

Redis|bool

on success and false on failure.

Redis|array|bool

Zero or more unread messages or false on failure.

Examples

+ + - - +

- -Redis::watch -

$redis->xGroup('CREATE', 'episodes', 'ds9', '0-0', true);
+
+$redis->xAdd('episodes', '1-1', ['title' => 'Emissary: Part 1']);
+$redis->xAdd('episodes', '1-2', ['title' => 'A Man Alone']);
+
+$messages = $redis->xReadGroup('ds9', 'sisko', ['episodes' => '>']);
+
+// After having read the two messages, add another
+$redis->xAdd('episodes', '1-3', ['title' => 'Emissary: Part 2']);
+
+// Acknowledge the first two read messages
+foreach ($messages as $stream => $stream_messages) {
+    $ids = array_keys($stream_messages);
+    $redis->xAck('stream', 'ds9', $ids);
+}
+
+// We can now pick up where we left off, and will only get the final message
+$msgs = $redis->xReadGroup('ds9', 'sisko', ['episodes' => '>']);

-
at line 3023
- `Redis|bool - watch(array|string $key, string ...$other_keys) -` + +

+
at line 5051
+ `Redis|array|bool xrevrange(string $key, string $end, string $start, int $count = -1)`

Watch one or more keys for conditional execution of a transaction.

Get a range of entries from a STREAM key in reverse chronological order.

Parameters

- + - + - - + + + + + + + + + + + +

array\|string	string	$key		The stream key to query.
string	...$other_keys	If the first argument was passed as a string, any number of additional -string key names may be passed variadically.	$end	The maximum message ID to include.
string	$start	The minimum message ID to include.
int	$count	An optional maximum number of messages to include.

Return Value

- +

- - + +

Redis|bool

Redis|array|bool

The entries within the requested range, from newest to oldest.

Examples

- https://redis.io/commands/watch + https://redis.io/docs/latest/commands/xrevrange/
- https://redis.io/commands/unwatch + https://redis.io/docs/latest/commands/xrange/

- + + + +

$redis1 = new Redis(['host' => 'localhost']);

-$redis2 = new Redis(['host' => 'localhost']);

-

-// Start watching 'incr-key'

-$redis1->watch('incr-key');

-

-// Retrieve its value.

-$val = $redis1->get('incr-key');

-

-// A second client modifies 'incr-key' after we read it.

-$redis2->set('incr-key', 0);

-

-// Because another client changed the value of 'incr-key' after we read it, this

-// is no longer a proper increment operation, but because we are `WATCH`ing the

-// key, this transaction will fail and we can try again.

-//

-// If were to comment out the above `$redis2->set('incr-key', 0)` line the

-// transaction would succeed.

-$redis1->multi();

-$redis1->set('incr-key', $val + 1);

-$res = $redis1->exec();

-

-// bool(false)

-var_dump($res);

$redis->xRevRange('stream', '0-2', '0-1');

$redis->xRevRange('stream', '+', '-');

@@ -15565,46 +21757,56 @@

Examples

-
at line 3037
- `int|false - wait(int $numreplicas, int $timeout) -` + +

+
at line 5069
+ `Redis|int|false vadd(string $key, array $values, mixed $element, array|null $options = null)`

Block the client up to the provided timeout until a certain number of replicas have confirmed -recieving them.

Add to a vector set

Parameters

- - - + + + - - - + + + + + + + + + + + + +

int	$numreplicas	The number of replicas we want to confirm write operaions	string	$key	The vector set to add to.
int	$timeout	How long to wait (zero meaning forever).	array	$values	A non-empty array of floating point values
mixed	$element	The element to add to the vector set.
array\|null	$options	An optional options array

Return Value

- +

- - + +

int|false

The number of replicas that have confirmed or false on failure.

Redis|int|false

One if the key was added zero if not.

Examples

+ + + + + +

$redis->vadd('embeddings', [0.12, 0.04, 0.88], 'doc:1');

-
at line 3078
- `int|false - xack(string $key, string $group, array $ids) -` + +

+
at line 5091
+ `Redis|array|false vsim(string $key, mixed $member, array|null $options = null)`

Acknowledge one ore more messages that are pending (have been consumed using XREADGROUP but -not yet acknowledged by XACK.)

Query similarity of a vector by element or scores

Parameters

@@ -15645,30 +21853,37 @@

Parameters

string $key -

The stream to query.

The vector set to query.

- string - $group -

The consumer group to use.

+ mixed + $member +

Either an element or array of scores. PhpRedis +will attempt to infer which it is, but since +there can be some ambiguity here due to +serialization you can also explicitly specify +ELE, VALUES, or FP32 in the options +array.

- array - $ids -

An array of stream entry IDs.

+ array|null + $options +

An optional options array

Return Value

- +

- - + +

int|false

The number of acknowledged messages

Redis|array|false

An array of elements and their similarity scores, or false on failure.

Examples

- https://redis.io/commands/xack -
- https://redis.io/commands/xreadgroup -
- -Redis::xack + https://redis.io/docs/latest/commands/vsim/

- +

$redis->xAdd('ships', '*', ['name' => 'Enterprise']);

-$redis->xAdd('ships', '*', ['name' => 'Defiant']);

-

-$redis->xGroup('CREATE', 'ships', 'Federation', '0-0');

-

-// Consume a single message with the consumer group 'Federation'

-$ship = $redis->xReadGroup('Federation', 'Picard', ['ships' => '>'], 1);

-

-/* Retrieve the ID of the message we read.

-assert(isset($ship['ships']));

-$id = key($ship['ships']);

-

-// The message we just read is now pending.

-$res = $redis->xPending('ships', 'Federation'));

-var_dump($res);

-

-// We can tell Redis we were able to process the message by using XACK

-$res = $redis->xAck('ships', 'Federation', [$id]);

-assert($res === 1);

-

-// The message should no longer be pending.

-$res = $redis->xPending('ships', 'Federation');

-var_dump($res);

$redis->vsim('embeddings', 'doc:1', ['COUNT' => 3]);

@@ -15731,18 +21911,17 @@

Examples

-
at line 3101
- `Redis|string|false - xadd(string $key, string $id, array $values, int $maxlen = 0, bool $approx = false, bool $nomkstream = false) -` + +

+
at line 5106
+ `Redis|int|false vcard(string $key)`

Append a message to a stream.

Get the length of a vector set

Parameters

@@ -15751,52 +21930,22 @@

Parameters

string $key -

The stream name.

- - - string - $id -

The ID for the message we want to add. This can be the special value '' -which means Redis will generate the ID that appends the message to the -end of the stream. It can also be a value in the form - which will -generate an ID that appends to the end ot entries with the same value -(if any exist).

- - - array - $values - - - - int - $maxlen -

If specified Redis will append the new message but trim any number of the -oldest messages in the stream until the length is <= $maxlen.

- - - bool - $approx -

Used in conjunction with $maxlen, this flag tells Redis to trim the stream -but in a more efficient way, meaning the trimming may not be exactly to -$maxlen values.

- - - bool - $nomkstream -

If passed as TRUE, the stream must exist for Redis to append the message.

The vector set to query.

Return Value

- +

- - + +

Redis|string|false

Redis|int|false

The number of elements in the vector set or false on failure.

Examples

- https://redis.io/commands/xadd + https://redis.io/docs/latest/commands/vcard/

- - - - +

$redis->xAdd('ds9-season-1', '1-1', ['title' => 'Emissary Part 1']);
$redis->xAdd('ds9-season-1', '1-2', ['title' => 'A Man Alone']);	$redis->vcard('embeddings');

@@ -15827,18 +21973,17 @@

Examples

-
at line 3140
- `Redis|bool|array - xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = -1, bool $justid = false) -` + +

+
at line 5121
+ `Redis|int|false vdim(string $key)`

This command allows a consumer to claim pending messages that have been idle for a specified period of time.

Its purpose is to provide a mechanism for picking up messages that may have had a failed consumer.

Get the dimensions of a vector set

Parameters

@@ -15847,50 +21992,22 @@

Parameters

string $key -

The stream to check.

- - - string - $group -

The consumer group to query.

- - - string - $consumer -

Which consumer to check.

- - - int - $min_idle -

The minimum time in milliseconds for the message to have been pending.

- - - string - $start -

The minimum message id to check.

- - - int - $count -

An optional limit on how many messages are returned.

- - - bool - $justid -

If the client only wants message IDs and not all of their data.

The vector set to query.

Return Value

- +

- - + +

Redis|bool|array

An array of pending IDs or false if there are none, or on failure.

Redis|int|false

The number of dimensions in the vector set or false on failure.

Examples

- https://redis.io/commands/xautoclaim -
- https://redis.io/commands/xclaim -
- https://redis.io/docs/data-types/streams-tutorial/ + https://redis.io/docs/latest/commands/vdim/

- +

$redis->xGroup('CREATE', 'ships', 'combatants', '0-0', true);

-

-$redis->xAdd('ships', '1424-74205', ['name' => 'Defiant']);

-

-// Consume the ['name' => 'Defiant'] message

-$msgs = $redis->xReadGroup('combatants', "Jem'Hadar", ['ships' => '>'], 1);

-

-// The "Jem'Hadar" consumer has the message presently

-$pending = $redis->xPending('ships', 'combatants');

-var_dump($pending);

-

-// Asssume control of the pending message with a different consumer.

-$res = $redis->xAutoClaim('ships', 'combatants', 'Sisko', 0, '0-0');

-

-// Now the 'Sisko' consumer owns the message

-$pending = $redis->xPending('ships', 'combatants');

-var_dump($pending);

$redis->vdim('embeddings');

@@ -15946,81 +22035,41 @@

Examples

-
at line 3197
- `Redis|array|bool - xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options) -` + +

+
at line 5136
+ `Redis|array|false vinfo(string $key)`

This method allows a consumer to take ownership of pending stream entries, by ID. Another -command that does much the same thing but does not require passing specific IDs is Redis::xAutoClaim.

Get various bits of information about a vector set

Parameters

- - - - - - - - - - - +

string	$key	The stream we wish to claim messages for.
string	$group	Our consumer group.

- - - - - - - - - - - - - - - - - + +

string	$consumer	Our consumer.
int	$min_idle
array	$ids
array	$options	An options array that modifies how the command operates. - # Following is an options array describing every option you can pass. Note that -# 'IDLE', and 'TIME' are mutually exclusive. -$options = [ - 'IDLE' => 3 # Set the idle time of the message to a 3. By default - # the idle time is set to zero. - 'TIME' => 1000*time() # Same as IDLE except it takes a unix timestamp in - # milliseconds. - 'RETRYCOUNT' => 0 # Set the retry counter to zero. By default XCLAIM - # doesn't modify the counter. - 'FORCE' # Creates the pending message entry even if IDs are - # not already - # in the PEL with another client. - 'JUSTID' # Return only an array of IDs rather than the messages - # themselves. -];	$key	The vector set to query.

Return Value

- +

- - + +

Redis|array|bool

An array of claimed messags or false on failure.

Redis|array|false

An array of information about the vector set or false on failure.

Examples

- https://redis.io/commands/xclaim -
- https://redis.io/commands/xautoclaim. + https://redis.io/docs/latest/commands/vinfo/

- +

$redis->xGroup('CREATE', 'ships', 'combatants', '0-0', true);

-

-$redis->xAdd('ships', '1424-74205', ['name' => 'Defiant']);

-

-// Consume the ['name' => 'Defiant'] message

-$msgs = $redis->xReadGroup('combatants', "Jem'Hadar", ['ships' => '>'], 1);

-

-// The "Jem'Hadar" consumer has the message presently

-$pending = $redis->xPending('ships', 'combatants');

-var_dump($pending);

-

-assert($pending && isset($pending[1]));

-

-// Claim the message by ID.

-$claimed = $redis->xClaim('ships', 'combatants', 'Sisko', 0, [$pending[1]], ['JUSTID']);

-var_dump($claimed);

-

-// Now the 'Sisko' consumer owns the message

-$pending = $redis->xPending('ships', 'combatants');

-var_dump($pending);

$redis->vinfo('embeddings');

@@ -16073,18 +22097,17 @@

Examples

-
at line 3209
- `Redis|int|false - xdel(string $key, array $ids) -` + +

+
at line 5152
+ `Redis|bool vismember(string $key, mixed $member)`

Remove one or more specific IDs from a stream.

Check if an element is a member of a vectorset

Parameters

@@ -16093,33 +22116,46 @@

Parameters

string $key -

The stream to modify.

The vector set to query.

- array - $ids -

One or more message IDs to remove.

+ mixed + $member +

The member to check for.

Return Value

- +

- - + +

Redis|int|false

The number of messages removed or false on failure.

Redis|bool

true if the member exists, false if it does not.

Examples

- +

$redis->xDel('stream', ['1-1', '2-1', '3-1']);

$redis->vismember('embeddings', 'doc:1');

@@ -16128,19 +22164,17 @@

Examples

-
at line 3247
- `mixed - xgroup(string $operation, string $key = null, string $group = null, string $id_or_consumer = null, bool $mkstream = false, int $entries_read = -2) -` + +

+
at line 5169
+ `Redis|array|false vemb(string $key, mixed $member, bool $raw = false)`

XGROUP

Perform various operation on consumer groups for a particular Redis STREAM. What the command does -is primarily based on which operation is passed.

Get the embeddings for a specific member

Parameters

@@ -16148,62 +22182,33 @@

Parameters

- - - - - - - - - - - + - - - + + + - - - - - - - + +

string	$operation	The subcommand you intend to execute. Valid options are as follows -'HELP' - Redis will return information about the command -Requires: none -'CREATE' - Create a consumer group. -Requires: Key, group, consumer. -'SETID' - Set the ID of an existing consumer group for the stream. -Requires: Key, group, id. -'CREATECONSUMER' - Create a new consumer group for the stream. You must -also pass key, group, and the consumer name you wish to -create. -Requires: Key, group, consumer. -'DELCONSUMER' - Delete a consumer from group attached to the stream. -Requires: Key, group, consumer. -'DESTROY' - Delete a consumer group from a stream. -Requires: Key, group.
string	$key	The STREAM we're operating on.
string	$group	The consumer group we want to create/modify/delete.	The vector set to query.
string	$id_or_consumer	The STREAM id (e.g. '$') or consumer group. See the operation section -for information about which to send.	mixed	$member	The member to query.
bool	$mkstream	This flag may be sent in combination with the 'CREATE' operation, and -cause Redis to also create the STREAM if it doesn't currently exist.
int	$entries_read		$raw	If set to `true`, the raw embeddings will be returned

Return Value

- +

- - + +

mixed

This command return various results depending on the operation performed.

Redis|array|false

An array of embeddings for the member or false on failure.

Examples

+ + + + + +

$redis->vemb('embeddings', 'doc:1');

-
at line 3266
- `mixed - xinfo(string $operation, string|null $arg1 = null, string|null $arg2 = null, int $count = -1) -` + +

+
at line 5183
+ `Redis|array|string|false vrandmember(string $key, int $count = 0)`

Retrieve information about a stream key.

Get one or more random members from a vector set

Parameters

@@ -16242,36 +22254,28 @@

Parameters

- - - - - - - - - - - - + + - +

string	$operation	The specific info operation to perform.
string\|null	$arg1	The first argument (depends on operation)
string\|null	$arg2	The second argument	$key	The vector set to query.
int	$count	The COUNT argument to `XINFO STREAM`	The number of random members to return.

Return Value

- +

- - + +

mixed

This command can return different things depending on the operation being called.

Redis|array|string|false

Examples

- https://redis.io/commands/xinfo + https://redis.io/docs/latest/commands/vrandmember/

- - - - - - - +

$redis->xInfo('CONSUMERS', 'stream');
$redis->xInfo('GROUPS', 'stream');
$redis->xInfo('STREAM', 'stream');	$redis->vrandmember('embeddings', 2);

@@ -16305,18 +22303,17 @@

Examples

-
at line 3280
- `Redis|int|false - xlen(string $key) -` + +

+
at line 5201
+ `Redis|array|false vrange(string $key, string $min, string $max, int $count = -1)`

Get the number of messages in a Redis STREAM key.

Retreive a lexographical range of elements from a vector set

Parameters

@@ -16325,20 +22322,37 @@

Parameters

string $key -

The Stream to check.

The vector set to query.

+ + + string + $min +

The minimum element to return.

+ + + string + $max +

The maximum element to return.

+ + + int + $count +

An optional maximum number of elements to return.

Return Value

- +

- - + +

Redis|int|false

The number of messages or false on failure.

Redis|array|false

An array of elements in the requested range or false on failure.

Examples

- https://redis.io/commands/xlen + https://redis.io/docs/latest/commands/vrange/

- +

$redis->xLen('stream');

$redis->vrange('embeddings', '-', '+', 5);

@@ -16366,19 +22380,17 @@

Examples

-
at line 3299
- `Redis|array|false - xpending(string $key, string $group, string|null $start = null, string|null $end = null, int $count = -1, string|null $consumer = null) -` + +

+
at line 5217
+ `Redis|int|false vrem(string $key, mixed $member)`

Interact with stream messages that have been consumed by a consumer group but not yet -acknowledged with XACK.

Remove an element from a vector set

Parameters

@@ -16387,45 +22399,27 @@

Parameters

string $key -

The stream to inspect.

- - - string - $group -

The user group we want to see pending messages from.

- - - string|null - $start -

The minimum ID to consider.

- - - string|null - $end - - - - int - $count -

Optional maximum number of messages to return.

The vector set to remove from.

- string|null - $consumer -

If provided, limit the returned messages to a specific consumer.

+ mixed + $member +

The member to remove.

Return Value

- +

- - + +

Redis|array|false

The pending messages belonging to the stream or false on failure.

Redis|int|false

1 if the member was removed, 0 if it was not.

Examples

+ + - - +

- https://redis.io/commands/xreadgroup -

$redis->vrem('embeddings', 'doc:1');

-
at line 3316
- `Redis|array|bool - xrange(string $key, string $start, string $end, int $count = -1) -` + +

+
at line 5236
+ `Redis|int|false vsetattr(string $key, mixed $member, array|string $attributes)`

Get a range of entries from a STREAM key.

Set the attributes of a vector set element

Parameters

@@ -16471,35 +22466,34 @@

Parameters

string $key -

The stream key name to list.

The vector set to modify.

- string - $start -

The minimum ID to return.

- - - string - $end -

The maximum ID to return.

+ mixed + $member +

The member to modify.

- int - $count -

An optional maximum number of entries to return.

+ array|string + $attributes +

The attributes to set. This should either +be a json encoded string or an array which +will be json encoded.

Return Value

- +

- - + +

Redis|array|bool

The entries in the stream within the requested range or false on failure.

Redis|int|false

1 if the attributes were set, 0 if they were not.

Examples

- https://redis.io/commands/xrange + https://redis.io/docs/latest/commands/vsetattr/

- - - - +

$redis->xRange('stream', '0-1', '0-2');
$redis->xRange('stream', '-', '+');	$redis->vsetattr('embeddings', 'doc:1', ['topic' => 'tech']);

@@ -16530,51 +22521,51 @@

Examples

-
at line 3340
- `Redis|array|bool - xread(array $streams, int $count = -1, int $block = -1) -` + +

+
at line 5253
+ `Redis|array|string|false vgetattr(string $key, mixed $member, bool $decode = true)`

Consume one or more unconsumed elements in one or more streams.

Get the attributes of a vector set element

Parameters

- - - + + + - - - + + + - - - + + +

array	$streams	An associative array with stream name keys and minimum id values.	string	$key	The vector set to query.
int	$count	An optional limit to how many entries are returnd per stream	mixed	$member	The member to query.
int	$block	An optional maximum number of milliseconds to block the caller if no -data is available on any of the provided streams.	bool	$decode	Whether to automatically deserialize any returned json.

Return Value

- +

- - + +

Redis|array|bool

An array of read elements or false if there aren't any.

Redis|array|string|false

An array of attributes for the member or false on failure.

Examples

- https://redis.io/commands/xread + https://redis.io/docs/latest/commands/vgetattr/

- +

$redis->xAdd('s03', '3-1', ['title' => 'The Search, Part I']);

-$redis->xAdd('s03', '3-2', ['title' => 'The Search, Part II']);

-$redis->xAdd('s03', '3-3', ['title' => 'The House Of Quark']);

-$redis->xAdd('s04', '4-1', ['title' => 'The Way of the Warrior']);

-$redis->xAdd('s04', '4-3', ['title' => 'The Visitor']);

-$redis->xAdd('s04', '4-4', ['title' => 'Hippocratic Oath']);

-

-$redis->xRead(['s03' => '3-2', 's04' => '4-1']);

$redis->vgetattr('embeddings', 'doc:1');

@@ -16609,18 +22593,17 @@

Examples

-
at line 3375
- `Redis|array|bool - xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1) -` + +

+
at line 5270
+ `Redis|array|false vlinks(string $key, mixed $member, bool $withscores = false)`

Read one or more messages using a consumer group.

Get any adajcent values for a member of a vector set.

Parameters

@@ -16628,41 +22611,33 @@

Parameters

- - - - - - - - - - - - + + - - - + + + - - - + + +

string	$group	The consumer group to use.
string	$consumer	The consumer to use.
array	$streams	An array of stream names and message IDs	$key	The vector set to query.
int	$count	Optional maximum number of messages to return	mixed	$member	The member to query.
int	$block	How long to block if there are no messages available.	bool	$withscores	If set to `true`, the scores of the adjacent values will be returned.

Return Value

- +

- - + +

Redis|array|bool

Zero or more unread messages or false on failure.

Redis|array|false

An array of adjacent values and their scores, or false on failure.

Examples

- https://redis.io/commands/xreadgroup + https://redis.io/docs/latest/commands/vlinks/

- +

$redis->xGroup('CREATE', 'episodes', 'ds9', '0-0', true);

-

-$redis->xAdd('episodes', '1-1', ['title' => 'Emissary: Part 1']);

-$redis->xAdd('episodes', '1-2', ['title' => 'A Man Alone']);

-

-$messages = $redis->xReadGroup('ds9', 'sisko', ['episodes' => '>']);

-

-// After having read the two messages, add another

-$redis->xAdd('episodes', '1-3', ['title' => 'Emissary: Part 2']);

-

-// Acknowledge the first two read messages

-foreach ($messages as $stream => $stream_messages) {

-    $ids = array_keys($stream_messages);

-    $redis->xAck('stream', 'ds9', $ids);

-}

-

-// We can now pick up where we left off, and will only get the final message

-$msgs = $redis->xReadGroup('ds9', 'sisko', ['episodes' => '>']);

$redis->vlinks('embeddings', 'doc:1', true);

@@ -16707,18 +22665,17 @@

Examples

-
at line 3393
- `Redis|array|bool - xrevrange(string $key, string $end, string $start, int $count = -1) -` + +

+
at line 5287
+ `Redis|array|false gcra(string $key, int $maxBurst, int $requestsPerPeriod, int $period, int $tokens = 0)`

Get a range of entries from a STREAM ke in reverse cronological order.

Get rate limiting information

Parameters

@@ -16727,35 +22684,42 @@

Parameters

string $key -

The stream key to query.

+ - string - $end -

The maximum message ID to include.

+ int + $maxBurst + - string - $start -

The minimum message ID to include.

+ int + $requestsPerPeriod + int - $count -

An optional maximum number of messages to include.

+ $period + + + + int + $tokens +

= 0

Return Value

- +

- - + +

Redis|array|bool

The entries within the requested range, from newest to oldest.

Redis|array|false

Examples

- https://redis.io/commands/xrevrange -
- https://redis.io/commands/xrange + https://redis.io/docs/latest/commands/gcra/

- - - - +

$redis->xRevRange('stream', '0-2', '0-1');
$redis->xRevRange('stream', '+', '-');	$redis->gcra('user:123', 10, 100, 3600);

@@ -16792,11 +22747,10 @@

Examples

-
at line 3415
- `Redis|int|false - xtrim(string $key, string $threshold, bool $approx = false, bool $minid = false, int $limit = -1) -` + +

+
at line 5311
+ `Redis|int|false xtrim(string $key, string $threshold, bool $approx = false, bool $minid = false, int $limit = -1)`

@@ -16841,15 +22795,17 @@

Parameters

Return Value

- +

Redis|int|false

The number of entries deleted from the stream.

Examples

-
at line 3456
- `Redis|int|false - zAdd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems) -` + +

+
at line 5352
+ `Redis|int|float|false zAdd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)`

@@ -16906,8 +22861,7 @@

Parameters

+ ]; +

Note: 'GX', 'LT', and 'NX' cannot be passed together, and PhpRedis +will send whichever one is last in the options array.

@@ -16937,16 +22890,18 @@

Parameters

- https://redis.io/commands/xtrim + https://redis.io/docs/latest/commands/xtrim/

array|float

$score_or_options

Either the score for the first element, or an array of options.


- $options = [
+ $options = [
      'NX',       # Only update elements that already exist
      'NX',       # Only add new elements but don't update existing ones.
 
@@ -16924,10 +22878,9 @@ Parameters
                  # increment the element by the
                  # provided score, much like ZINCRBY.  When this option
                  # is passed, you may only send a single score and member.
- ];
-
- Note:  'GX', 'LT', and 'NX' cannot be passed together, and PhpRedis
-        will send whichever one is last in the options array.

mixed

Return Value

- +

Redis|int|false

Redis|int|float|false

The return value varies depending on the options passed.

Following is information about the options that may be passed as the second argument:

Examples

- https://redis.io/commands/zadd + https://redis.io/docs/latest/commands/zadd/

- - - - +

$redis->zadd('zs', 1, 'first', 2, 'second', 3, 'third');

$redis->zAdd('zs', ['XX'], 8, 'second', 99, 'new-element');

$redis->zadd('zs', 1, 'first', 2, 'second', 3, 'third');
+$redis->zAdd('zs', ['XX'], 8, 'second', 99, 'new-element');

@@ -16977,11 +22930,10 @@

Examples

-
at line 3469
- `Redis|int|false - zCard(string $key) -` + +

+
at line 5365
+ `Redis|int|false zCard(string $key)`

@@ -16997,20 +22949,22 @@

Parameters

string $key -

The sorted set to retreive cardinality from.

The sorted set to retrieve cardinality from.

Return Value

- +

Redis|int|false

The number of elements in the set or false on failure

Examples

-
at line 3487
- `Redis|int|false - zCount(string $key, string $start, string $end) -` + +

+
at line 5384
+ `Redis|int|false zCount(string $key, int|string $start, int|string $end)`

@@ -17061,27 +23014,31 @@

Parameters

- + - + - + - +

- https://redis.io/commands/zcard + https://redis.io/docs/latest/commands/zcard/
The sorted set to check.
string	int\|string	$start	The minimum score to include in the count
string	int\|string	$end	The maximum score to include in the count + NOTE: In addition to a floating point score you may pass the special values of '-inf' and +'+inf' meaning negative and positive infinity, respectively.

Return Value

- +

Redis|int|false

Examples

- https://redis.io/commands/zcount + https://redis.io/docs/latest/commands/zcount/

- - - - - - - +

$redis->zCount('fruit-rankings', '0', '+inf');

$redis->zCount('fruit-rankings', 50, 60);

$redis->zCount('fruit-rankings', '-inf', 0);

$redis->zCount('fruit-rankings', '0', '+inf');
+$redis->zCount('fruit-rankings', 50, 60);
+$redis->zCount('fruit-rankings', '-inf', 0);

@@ -17115,11 +23068,10 @@

Examples

-
at line 3502
- `Redis|float|false - zIncrBy(string $key, float $value, mixed $member) -` + +

+
at line 5400
+ `Redis|float|false zIncrBy(string $key, float $value, mixed $member)`

@@ -17150,15 +23102,17 @@

Parameters

Return Value

- +

Redis|float|false

The new score of the member or false on failure.

Examples

- https://redis.io/commands/zincrby + https://redis.io/docs/latest/commands/zincrby/

- - - - +

$redis->zIncrBy('zs', 5.0, 'bananas');
$redis->zIncrBy('zs', 2.0, 'eggplants');	$redis->zIncrBy('zs', 5.0, 'bananas'); +$redis->zIncrBy('zs', 2.0, 'eggplants');

@@ -17189,18 +23141,17 @@

Examples

-
at line 3520
- `Redis|int|false - zLexCount(string $key, string $min, string $max) -` + +

+
at line 5418
+ `Redis|int|false zLexCount(string $key, string $min, string $max)`

Count the number of elements in a sorted set whos members fall within the provided +

Count the number of elements in a sorted set whose members fall within the provided lexographical range.

@@ -17225,15 +23176,17 @@

Parameters

Return Value

- +

Redis|int|false

The number of members that fall within the range or false on failure.

Examples

- https://redis.io/commands/zlexcount + https://redis.io/docs/latest/commands/zlexcount/

$redis->zAdd('captains', 0, 'Janeway', 0, 'Kirk', 0, 'Picard', 0, 'Sisko', 0, 'Archer');

+

$redis->zAdd('captains', 0, 'Janeway', 0, 'Kirk', 0, 'Picard', 0, 'Sisko', 0, 'Archer');
 $redis->zLexCount('captains', '[A', '[S');

@@ -17262,11 +23215,10 @@

Examples

-
at line 3539
- `Redis|array|false - zMscore(string $key, mixed $member, mixed ...$other_members) -` + +

+
at line 5437
+ `Redis|array|false zMscore(string $key, mixed $member, mixed ...$other_members)`

@@ -17297,15 +23249,17 @@

Parameters

Return Value

- +

Redis|array|false

An array of the scores of the requested elements.

Examples

- https://redis.io/commands/zmscore + https://redis.io/docs/latest/commands/zmscore/

$redis->zAdd('zs', 0, 'zero', 1, 'one', 2, 'two', 3, 'three');

-

-$redis->zMScore('zs', 'zero', 'two');

+

$redis->zAdd('zs', 0, 'zero', 1, 'one', 2, 'two', 3, 'three');
+
+$redis->zMScore('zs', 'zero', 'two');
 $redis->zMScore('zs', 'one', 'not-a-member');

@@ -17336,11 +23290,10 @@

Examples

-
at line 3557
- `Redis|array|false - zPopMax(string $key, int $count = null) -` + +

+
at line 5455
+ `Redis|array|false zPopMax(string $key, int|null $count = null)`

@@ -17359,22 +23312,24 @@

Parameters

The sorted set to pop elements from.

- int + int|null $count

An optional count of elements to pop.

Return Value

- +

Redis|array|false

All of the popped elements with scores or false on fialure.

All of the popped elements with scores or false on failure

Examples

- https://redis.io/commands/zpopmax + https://redis.io/docs/latest/commands/zpopmax/

$redis->zAdd('zs', 0, 'zero', 1, 'one', 2, 'two', 3, 'three');

-

-$redis->zPopMax('zs');

+

$redis->zAdd('zs', 0, 'zero', 1, 'one', 2, 'two', 3, 'three');
+
+$redis->zPopMax('zs');
 $redis->zPopMax('zs', 2);.

@@ -17405,11 +23360,10 @@

Examples

-
at line 3575
- `Redis|array|false - zPopMin(string $key, int $count = null) -` + +

+
at line 5473
+ `Redis|array|false zPopMin(string $key, int|null $count = null)`

@@ -17428,22 +23382,24 @@

Parameters

The sorted set to pop elements from.

- int + int|null $count

An optional count of elements to pop.

Return Value

- +

Redis|array|false

The popped elements with their scores or false on failure.

Examples

- https://redis.io/commands/zpopmin + https://redis.io/docs/latest/commands/zpopmin/

$redis->zAdd('zs', 0, 'zero', 1, 'one', 2, 'two', 3, 'three');

-

-$redis->zPopMin('zs');

+

$redis->zAdd('zs', 0, 'zero', 1, 'one', 2, 'two', 3, 'three');
+
+$redis->zPopMin('zs');
 $redis->zPopMin('zs', 2);

@@ -17474,11 +23430,10 @@

Examples

-
at line 3610
- `Redis|array|false - zRange(string $key, mixed $start, mixed $end, array|bool|null $options = null) -` + +

+
at line 5509
+ `Redis|array|false zRange(string $key, string|int $start, string|int $end, array|bool|null $options = null)`

@@ -17498,12 +23453,12 @@

Parameters

The sorted set in question.

- mixed + string|int $start

The starting index we want to return.

- mixed + string|int $end

The final index we want to return.

@@ -17513,27 +23468,29 @@

Parameters

This value may either be an array of options to pass to the command, or for historical purposes a boolean which controls just the 'WITHSCORES' option.

$options = [
+$options = [
     'WITHSCORES' => true,     # Return both scores and members.
     'LIMIT'      => [10, 10], # Start at offset 10 and return 10 elements.
     'REV'                     # Return the elements in reverse order
     'BYSCORE',                # Treat `start` and `end` as scores instead
     'BYLEX'                   # Treat `start` and `end` as lexicographical values.
 ];
-Note:  'BYLEX' and 'BYSCORE' are mutually exclusive.
+Note:  BYLEX and BYSCORE are mutually exclusive.
             
             
 
             
-                            Return Value
+                            Return Value
 
-                    
+                
+                        

         
             Redis|array|false
             An array with matching elements or false on failure.
         
     
 
+

See also @@ -17541,7 +23498,7 @@ See also @@ -17552,10 +23509,8 @@ Examples - https://redis.io/commands/zrange/ + https://redis.io/docs/latest/commands/zrange/ - - - - + $redis->zRange('zset', 0, -1); $redis->zRange('zset', '-inf', 'inf', ['byscore' => true]); $redis->zRange('zset', 0, -1); +$redis->zRange('zset', '-inf', 'inf', ['byscore']); @@ -17564,11 +23519,10 @@ Examples

- - at line 3632 - Redis|array|false - zRangeByLex(string $key, string $min, string $max, int $offset = -1, int $count = -1) - + + + at line 5531 + Redis|array|false zRangeByLex(string $key, string $min, string $max, int $offset = -1, int $count = -1) @@ -17584,7 +23538,7 @@ Parameters string $key - The sorted set to retreive elements from + The sorted set to retrieve elements from string @@ -17609,15 +23563,17 @@ Parameters - Return Value + Return Value - + + Redis|array|false An array of matching elements or false on failure. + See also @@ -17625,7 +23581,7 @@ See also @@ -17636,10 +23592,10 @@ Examples - https://redis.io/commands/zrangebylex + https://redis.io/docs/latest/commands/zrangebylex/ - $redis = new Redis(['host' => 'localhost']); -$redis->zAdd('captains', 0, 'Janeway', 0, 'Kirk', 0, 'Picard', 0, 'Sisko', 0, 'Archer'); - -$redis->zRangeByLex('captains', '[A', '[S'); + $redis = new Redis(['host' => 'localhost']); +$redis->zAdd('captains', 0, 'Janeway', 0, 'Kirk', 0, 'Picard', 0, 'Sisko', 0, 'Archer'); + +$redis->zRangeByLex('captains', '[A', '[S'); $redis->zRangeByLex('captains', '[A', '[S', 2, 2); @@ -17649,11 +23605,10 @@ Examples - - at line 3653 - Redis|array|false - zRangeByScore(string $key, string $start, string $end, array $options = []) - + + + at line 5553 + Redis|array|false zRangeByScore(string $key, string $start, string $end, array $options = []) @@ -17692,15 +23647,17 @@ Parameters - Return Value + Return Value - + + Redis|array|false The number of matching elements or false on failure. + See also @@ -17708,7 +23665,7 @@ See also @@ -17719,10 +23676,8 @@ Examples - https://redis.io/commands/zrangebyscore + https://redis.io/docs/latest/commands/zrangebyscore/ - - - - + $redis->zRangeByScore('zs', 20, 30, ['WITHSCORES' => true]); $redis->zRangeByScore('zs', 20, 30, ['WITHSCORES' => true, 'LIMIT' => [5, 5]]); $redis->zRangeByScore('zs', 20, 30, ['WITHSCORES' => true]); +$redis->zRangeByScore('zs', 20, 30, ['WITHSCORES' => true, 'LIMIT' => [5, 5]]); @@ -17731,11 +23686,10 @@ Examples - - at line 3673 - Redis|int|false - zrangestore(string $dstkey, string $srckey, string $start, string $end, array|bool|null $options = NULL) - + + + at line 5577 + Redis|int|false zrangestore(string $dstkey, string $srckey, string $start, string $end, array|bool|null $options = null) @@ -17777,15 +23731,17 @@ Parameters - Return Value + Return Value - + + Redis|int|false The number of elements stored in $dstkey or false on failure. + See also @@ -17793,7 +23749,7 @@ See also @@ -17806,16 +23762,23 @@ See also - https://redis.io/commands/zrange/ + https://redis.io/docs/latest/commands/zrange/ + Examples + + + + + + $redis->zrangestore('recent:leaders', 'leaders', '0', '9'); +

- - at line 3692 - Redis|string|array - zRandMember(string $key, array $options = null) - + + + at line 5596 + Redis|string|array zRandMember(string $key, array|null $options = null) @@ -17834,25 +23797,27 @@ Parameters The sorted set to pull random members from. - array + array|null $options - One or more options that determine exactly how the command operates. -OPTION TYPE MEANING -'COUNT' int The number of random members to return. -'WITHSCORES' bool Whether to return scores and members instead of + One or more options that determine exactly how the command operates. +OPTION TYPE MEANING +'COUNT' int The number of random members to return. +'WITHSCORES' bool Whether to return scores and members instead of - Return Value + Return Value - + + - + Redis|string|array One ore more random elements. One or more random elements. + See also @@ -17860,7 +23825,7 @@ See also @@ -17880,11 +23845,10 @@ Examples - - at line 3706 - Redis|int|false - zRank(string $key, mixed $member) - + + + at line 5611 + Redis|int|false zRank(string $key, mixed $member) @@ -17905,20 +23869,22 @@ Parameters - + - https://redis.io/commands/zrandmember + https://redis.io/docs/latest/commands/zrandmember/ mixed $member The member to test. - Return Value + Return Value - + + Redis|int|false The rank of the requested member. + See also @@ -17926,7 +23892,7 @@ See also @@ -17937,10 +23903,8 @@ Examples - https://redis.io/commands/zrank + https://redis.io/docs/latest/commands/zrank/ - - - - + $redis->zRank('zs', 'zero'); $redis->zRank('zs', 'three'); $redis->zRank('zs', 'zero'); +$redis->zRank('zs', 'three'); @@ -17949,11 +23913,10 @@ Examples

- - at line 3721 - Redis|int|false - zRem(mixed $key, mixed $member, mixed ...$other_members) - + + + at line 5627 + Redis|int|false zRem(mixed $key, mixed $member, mixed ...$other_members) @@ -17984,15 +23947,17 @@ Parameters - Return Value + Return Value - + + Redis|int|false The number of members that were actually removed or false on failure. + See also @@ -18000,7 +23965,7 @@ See also @@ -18020,11 +23985,10 @@ Examples - - at line 3738 - Redis|int|false - zRemRangeByLex(string $key, string $min, string $max) - + + + at line 5645 + Redis|int|false zRemRangeByLex(string $key, string $min, string $max) @@ -18055,15 +24019,17 @@ Parameters - https://redis.io/commands/zrem + https://redis.io/docs/latest/commands/zrem/ - Return Value + Return Value - + + Redis|int|false The number of elements removed from the set or false on failure. + See also @@ -18071,7 +24037,7 @@ See also @@ -18088,10 +24054,8 @@ Examples - https://redis.io/commands/zremrangebylex + https://redis.io/docs/latest/commands/zremrangebylex/ - - - - + $redis->zRemRangeByLex('zs', '[a', '(b'); $redis->zRemRangeByLex('zs', '(banana', '(eggplant'); $redis->zRemRangeByLex('zs', '[a', '(b'); +$redis->zRemRangeByLex('zs', '(banana', '(eggplant'); @@ -18100,11 +24064,10 @@ Examples

- - at line 3753 - Redis|int|false - zRemRangeByRank(string $key, int $start, int $end) - + + + at line 5661 + Redis|int|false zRemRangeByRank(string $key, int $start, int $end) @@ -18120,7 +24083,7 @@ Parameters string $key - The sorted set where we wnat to remove members. + The sorted set where we want to remove members. int @@ -18135,15 +24098,17 @@ Parameters - Return Value + Return Value - + + Redis|int|false The number of members removed from the set or false on failure. + See also @@ -18151,7 +24116,7 @@ See also @@ -18171,11 +24136,10 @@ Examples - - at line 3770 - Redis|int|false - zRemRangeByScore(string $key, string $start, string $end) - + + + at line 5678 + Redis|int|false zRemRangeByScore(string $key, string $start, string $end) @@ -18191,7 +24155,7 @@ Parameters - + @@ -18206,15 +24170,17 @@ Parameters - https://redis.io/commands/zremrangebyrank + https://redis.io/docs/latest/commands/zremrangebyrank/ string $key The sorted set where we wnat to remove members. The sorted set where we want to remove members. string - Return Value + Return Value - + + Redis|int|false The number of members removed from the set or false on failure. + See also @@ -18222,7 +24188,7 @@ See also @@ -18233,7 +24199,7 @@ Examples - https://redis.io/commands/zremrangebyrank + https://redis.io/docs/latest/commands/zremrangebyrank/ - $redis->zAdd('zs', 2, 'two', 4, 'four', 6, 'six'); + $redis->zAdd('zs', 2, 'two', 4, 'four', 6, 'six'); $redis->zRemRangeByScore('zs', 2, 4); @@ -18243,11 +24209,10 @@ Examples

- - at line 3791 - Redis|array|false - zRevRange(string $key, int $start, int $end, mixed $scores = null) - + + + at line 5700 + Redis|array|false zRevRange(string $key, int $start, int $end, mixed $scores = null) @@ -18278,14 +24243,16 @@ Parameters mixed $scores - + Whether or not Redis should also return each members score. See +the example below demonstrating how it may be used. - Return Value + Return Value - + + Redis|array|false The members (and possibly scores) of the matching elements or false @@ -18293,6 +24260,7 @@ Return Value + See also @@ -18300,7 +24268,7 @@ See also @@ -18311,16 +24279,10 @@ Examples - https://redis.io/commands/zrevrange + https://redis.io/docs/latest/commands/zrevrange/ - - - - - - - - - - + $redis->zRevRange('zs', 0, -1); $redis->zRevRange('zs', 2, 3); $redis->zRevRange('zs', 0, -1, true); $redis->zRevRange('zs', 0, -1, ['withscores' => true]); $redis->zRevRange('zs', 0, -1); +$redis->zRevRange('zs', 2, 3); +$redis->zRevRange('zs', 0, -1, true); +$redis->zRevRange('zs', 0, -1, ['withscores' => true]); @@ -18329,11 +24291,10 @@ Examples - - at line 3810 - Redis|array|false - zRevRangeByLex(string $key, string $max, string $min, int $offset = -1, int $count = -1) - + + + at line 5720 + Redis|array|false zRevRangeByLex(string $key, string $max, string $min, int $offset = -1, int $count = -1) @@ -18354,12 +24315,12 @@ Parameters string $max - + The maximum legographical element to include in the result. string $min - The maximum legographical element to include in the result. + The minimum lexographical element to include in the result. int @@ -18374,15 +24335,17 @@ Parameters - Return Value + Return Value - + + Redis|array|false The matching members or false on failure. + See also @@ -18390,7 +24353,7 @@ See also @@ -18407,10 +24370,8 @@ Examples - https://redis.io/commands/zrevrangebylex + https://redis.io/docs/latest/commands/zrevrangebylex/ - - - - + $redis->zRevRangeByLex('captains', '[Q', '[J'); $redis->zRevRangeByLex('captains', '[Q', '[J', 1, 2); $redis->zRevRangeByLex('captains', '[Q', '[J'); +$redis->zRevRangeByLex('captains', '[Q', '[J', 1, 2); @@ -18419,11 +24380,10 @@ Examples - - at line 3845 - Redis|array|false - zRevRangeByScore(string $key, string $max, string $min, array|bool $options = []) - + + + at line 5755 + Redis|array|false zRevRangeByScore(string $key, string $max, string $min, array|bool $options = []) @@ -18455,25 +24415,27 @@ Parameters array|bool $options An options array that modifies how the command executes. -$options = [ +$options = [ 'WITHSCORES' => true|false # Whether or not to return scores 'LIMIT' => [offset, count] # Return a subset of the matching members ]; -NOTE: For legacy reason, you may also simply pass true for the + NOTE: For legacy reason, you may also simply pass true for the options argument, to mean WITHSCORES. - Return Value + Return Value - + + Redis|array|false The matching members in reverse order of score or false on failure. + See also @@ -18481,7 +24443,7 @@ See also @@ -18492,14 +24454,14 @@ Examples - https://redis.io/commands/zrevrangebyscore + https://redis.io/docs/latest/commands/zrevrangebyscore/ - $redis->zadd('oldest-people', 122.4493, 'Jeanne Calment', 119.2932, 'Kane Tanaka', - 119.2658, 'Sarah Knauss', 118.7205, 'Lucile Randon', - 117.7123, 'Nabi Tajima', 117.6301, 'Marie-Louise Meilleur', - 117.5178, 'Violet Brown', 117.3753, 'Emma Morano', - 117.2219, 'Chiyo Miyako', 117.0740, 'Misao Okawa'); - -$redis->zRevRangeByScore('oldest-people', 122, 119); -$redis->zRevRangeByScore('oldest-people', 'inf', 118); + $redis->zadd('oldest-people', 122.4493, 'Jeanne Calment', 119.2932, 'Kane Tanaka', + 119.2658, 'Sarah Knauss', 118.7205, 'Lucile Randon', + 117.7123, 'Nabi Tajima', 117.6301, 'Marie-Louise Meilleur', + 117.5178, 'Violet Brown', 117.3753, 'Emma Morano', + 117.2219, 'Chiyo Miyako', 117.0740, 'Misao Okawa'); + +$redis->zRevRangeByScore('oldest-people', 122, 119); +$redis->zRevRangeByScore('oldest-people', 'inf', 118); $redis->zRevRangeByScore('oldest-people', '117.5', '-inf', ['LIMIT' => [0, 1]]); @@ -18509,11 +24471,10 @@ Examples - - at line 3863 - Redis|int|false - zRevRank(string $key, mixed $member) - + + + at line 5773 + Redis|int|false zRevRank(string $key, mixed $member) @@ -18539,9 +24500,10 @@ Parameters - Return Value + Return Value - + + Redis|int|false The reverse rank (the rank if counted high to low) of the member or @@ -18549,6 +24511,7 @@ Return Value + See also @@ -18556,7 +24519,7 @@ See also @@ -18567,9 +24530,9 @@ Examples - https://redis.io/commands/zrevrank + https://redis.io/docs/latest/commands/zrevrank/ - $redis->zAdd('ds9-characters', 10, 'Sisko', 9, 'Garak', 8, 'Dax', 7, 'Odo'); - -$redis->zrevrank('ds9-characters', 'Sisko'); + $redis->zAdd('ds9-characters', 10, 'Sisko', 9, 'Garak', 8, 'Dax', 7, 'Odo'); + +$redis->zrevrank('ds9-characters', 'Sisko'); $redis->zrevrank('ds9-characters', 'Garak'); @@ -18579,11 +24542,10 @@ Examples - - at line 3879 - Redis|float|false - zScore(string $key, mixed $member) - + + + at line 5789 + Redis|float|false zScore(string $key, mixed $member) @@ -18609,15 +24571,17 @@ Parameters - Return Value + Return Value - + + - + Redis|float|false score of the requested element or false if it is not found. The score of the requested element or false if it is not found. + See also @@ -18625,7 +24589,7 @@ See also @@ -18636,7 +24600,7 @@ Examples - https://redis.io/commands/zscore + https://redis.io/docs/latest/commands/zscore/ - $redis->zAdd('telescopes', 11.9, 'LBT', 10.4, 'GTC', 10, 'HET'); + $redis->zAdd('telescopes', 11.9, 'LBT', 10.4, 'GTC', 10, 'HET'); $redis->zScore('telescopes', 'LBT'); @@ -18646,11 +24610,10 @@ Examples - - at line 3900 - Redis|array|false - zdiff(array $keys, array $options = null) - + + + at line 5810 + Redis|array|false zdiff(array $keys, array|null $options = null) @@ -18667,10 +24630,10 @@ Parameters array $keys - One ore more sorted sets. + One or more sorted sets. - array + array|null $options An array which can contain ['WITHSCORES' => true] if you want Redis to return members and scores. @@ -18678,15 +24641,17 @@ Parameters - Return Value + Return Value - + + Redis|array|false An array of members or false on failure. + See also @@ -18694,7 +24659,7 @@ See also @@ -18705,10 +24670,10 @@ Examples - https://redis.io/commands/zdiff + https://redis.io/docs/latest/commands/zdiff/ - $redis->zAdd('primes', 1, 'one', 3, 'three', 5, 'five'); -$redis->zAdd('evens', 2, 'two', 4, 'four'); -$redis->zAdd('mod3', 3, 'three', 6, 'six'); - + $redis->zAdd('primes', 1, 'one', 3, 'three', 5, 'five'); +$redis->zAdd('evens', 2, 'two', 4, 'four'); +$redis->zAdd('mod3', 3, 'three', 6, 'six'); + $redis->zDiff(['primes', 'evens', 'mod3']); @@ -18718,11 +24683,10 @@ Examples - - at line 3916 - Redis|int|false - zdiffstore(string $dst, array $keys) - + + + at line 5830 + Redis|int|false zdiffstore(string $dst, array $keys) @@ -18738,7 +24702,7 @@ Parameters string $dst - + The destination set name. array @@ -18748,9 +24712,10 @@ Parameters - Return Value + Return Value - + + Redis|int|false The number of elements stored in the destination set or false on @@ -18758,6 +24723,7 @@ Return Value + See also @@ -18765,7 +24731,7 @@ See also @@ -18779,16 +24745,23 @@ See also - https://redis.io/commands/zdiff + https://redis.io/docs/latest/commands/zdiff/ + Examples + + + + + + $redis->zdiffstore('only:new', ['all:users', 'inactive:users']); +

- - at line 3939 - Redis|array|false - zinter(array $keys, array|null $weights = null, array|null $options = null) - + + + at line 5853 + Redis|array|false zinter(array $keys, array|null $weights = null, array|null $options = null) @@ -18804,7 +24777,7 @@ Parameters array $keys - One ore more sorted sets. + One or more sorted sets. array|null @@ -18821,15 +24794,17 @@ Parameters - Return Value + Return Value - + + Redis|array|false All of the members that exist in every set. + See also @@ -18837,7 +24812,7 @@ See also @@ -18848,11 +24823,11 @@ Examples - https://redis.io/commands/zinter + https://redis.io/docs/latest/commands/zinter/ - $redis->zAdd('TNG', 2, 'Worf', 2.5, 'Data', 4.0, 'Picard'); -$redis->zAdd('DS9', 2.5, 'Worf', 3.0, 'Kira', 4.0, 'Sisko'); - -$redis->zInter(['TNG', 'DS9']); -$redis->zInter(['TNG', 'DS9'], NULL, ['withscores' => true]); + $redis->zAdd('TNG', 2, 'Worf', 2.5, 'Data', 4.0, 'Picard'); +$redis->zAdd('DS9', 2.5, 'Worf', 3.0, 'Kira', 4.0, 'Sisko'); + +$redis->zInter(['TNG', 'DS9']); +$redis->zInter(['TNG', 'DS9'], NULL, ['withscores' => true]); $redis->zInter(['TNG', 'DS9'], NULL, ['withscores' => true, 'aggregate' => 'max']); @@ -18862,11 +24837,10 @@ Examples - - at line 3962 - Redis|int|false - zintercard(array $keys, int $limit = -1) - + + + at line 5876 + Redis|int|false zintercard(array $keys, int $limit = -1) @@ -18883,7 +24857,7 @@ Parameters array $keys - One ore more sorted set key names. + One or more sorted set key names. int @@ -18895,15 +24869,17 @@ Parameters - Return Value + Return Value - + + Redis|int|false The cardinality of the intersection or false on failure. + See also @@ -18911,13 +24887,13 @@ See also @@ -18935,9 +24911,9 @@ Examples - https://redis.io/commands/zintercard + https://redis.io/docs/latest/commands/zintercard/ - https://redis.io/commands/zinter + https://redis.io/docs/latest/commands/zinter/ - $redis->zAdd('zs1', 1, 'one', 2, 'two', 3, 'three', 4, 'four'); -$redis->zAdd('zs2', 2, 'two', 4, 'four'); - + $redis->zAdd('zs1', 1, 'one', 2, 'two', 3, 'three', 4, 'four'); +$redis->zAdd('zs2', 2, 'two', 4, 'four'); + $redis->zInterCard(['zs1', 'zs2']); @@ -18947,18 +24923,17 @@ Examples - - at line 3989 - Redis|int|false - zinterstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null) - + + + at line 5902 + Redis|int|false zinterstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null) - Compute the intersection of one ore more sorted sets storing the result in a new sorted set. + Compute the intersection of one or more sorted sets storing the result in a new sorted set. Parameters @@ -18972,7 +24947,7 @@ Parameters array $keys - One ore more sorted set key names. + One or more sorted set key names. array|null @@ -18982,23 +24957,25 @@ Parameters string|null $aggregate - An optional aggregation method to use. -'SUM' - Store sum of all intersected members (this is the default). + An optional aggregation method to use. +'SUM' - Store sum of all intersected members (this is the default). 'MIN' - Store minimum value for each intersected member. 'MAX' - Store maximum value for each intersected member. - Return Value + Return Value - + + Redis|int|false The total number of members writtern to the destination set or false on failure. + See also @@ -19006,13 +24983,13 @@ See also @@ -19023,11 +25000,11 @@ Examples - https://redis.io/commands/zinterstore + https://redis.io/docs/latest/commands/zinterstore/ - https://redis.io/commands/zinter + https://redis.io/docs/latest/commands/zinter/ - $redis->zAdd('zs1', 3, 'apples', 2, 'pears'); -$redis->zAdd('zs2', 4, 'pears', 3, 'bananas'); -$redis->zAdd('zs3', 2, 'figs', 3, 'pears'); - -$redis->zInterStore('fruit-sum', ['zs1', 'zs2', 'zs3']); + $redis->zAdd('zs1', 3, 'apples', 2, 'pears'); +$redis->zAdd('zs2', 4, 'pears', 3, 'bananas'); +$redis->zAdd('zs3', 2, 'figs', 3, 'pears'); + +$redis->zInterStore('fruit-sum', ['zs1', 'zs2', 'zs3']); $redis->zInterStore('fruit-max', ['zs1', 'zs2', 'zs3'], NULL, 'MAX'); @@ -19037,11 +25014,10 @@ Examples - - at line 4013 - Redis|array|false - zscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) - + + + at line 5934 + Redis|array|false zscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0) @@ -19060,7 +25036,7 @@ Parameters The sorted set to scan. - int|null + null|int|string $iterator A reference to an iterator that should be initialized to NULL initially, that will be updated after each subsequent call to ZSCAN. Once the iterator @@ -19082,15 +25058,17 @@ Parameters - Return Value + Return Value - + + Redis|array|false An array of elements or false on failure. + See also @@ -19098,13 +25076,13 @@ See also @@ -19118,16 +25096,28 @@ See also - https://redis.io/commands/zscan + https://redis.io/docs/latest/commands/zscan/ - https://redis.io/commands/scan + https://redis.io/docs/latest/commands/scan/ + Examples + + + + + + $it = null; +while ($members = $redis->zscan('leaders', $it)) { + foreach ($members as $member => $score) { + printf('%s => %s' . PHP_EOL, $member, $score); + } +} +

- - at line 4048 - Redis|array|false - zunion(array $keys, array|null $weights = null, array|null $options = null) - + + + at line 5971 + Redis|array|false zunion(array $keys, array|null $weights = null, array|null $options = null) @@ -19143,7 +25133,7 @@ Parameters array $keys - One ore more sorted set key names + One or more sorted set key names array|null @@ -19156,7 +25146,7 @@ Parameters array|null $options An array that modifies how this command functions. -$options = [ +$options = [ # By default when members exist in more than one set Redis will SUM # total score for each match. Instead, it can return the AVG, MIN, # or MAX value based on this option. @@ -19169,29 +25159,42 @@ Parameters - Return Value + Return Value - + + Redis|array|false The union of each sorted set or false on failure + + See also + + + + + + + + https://redis.io/docs/latest/commands/zunion/ + + Examples - $redis->del('store1', 'store2', 'store3'); -$redis->zAdd('store1', 1, 'apples', 3, 'pears', 6, 'bananas'); -$redis->zAdd('store2', 3, 'apples', 5, 'coconuts', 2, 'bananas'); -$redis->zAdd('store3', 2, 'bananas', 6, 'apples', 4, 'figs'); - -$redis->zUnion(['store1', 'store2', 'store3'], NULL, ['withscores' => true]); -$redis->zUnion(['store1', 'store3'], [2, .5], ['withscores' => true]); + $redis->del('store1', 'store2', 'store3'); +$redis->zAdd('store1', 1, 'apples', 3, 'pears', 6, 'bananas'); +$redis->zAdd('store2', 3, 'apples', 5, 'coconuts', 2, 'bananas'); +$redis->zAdd('store3', 2, 'bananas', 6, 'apples', 4, 'figs'); + +$redis->zUnion(['store1', 'store2', 'store3'], NULL, ['withscores' => true]); +$redis->zUnion(['store1', 'store3'], [2, .5], ['withscores' => true]); $redis->zUnion(['store1', 'store3'], [2, .5], ['withscores' => true, 'aggregate' => 'MIN']); @@ -19201,11 +25204,10 @@ Examples - - at line 4071 - Redis|int|false - zunionstore(string $dst, array $keys, array|null $weights = NULL, string|null $aggregate = NULL) - + + + at line 5994 + Redis|int|false zunionstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null) @@ -19242,15 +25244,17 @@ Parameters - Return Value + Return Value - + + Redis|int|false The number of members stored in the destination set or false on failure. + See also @@ -19258,7 +25262,7 @@ See also @@ -19276,10 +25280,10 @@ Examples - https://redis.io/commands/zunionstore + https://redis.io/docs/latest/commands/zunionstore/ - $redis->zAdd('zs1', 1, 'one', 3, 'three'); -$redis->zAdd('zs1', 2, 'two', 4, 'four'); -$redis->zadd('zs3', 1, 'one', 7, 'five'); - + $redis->zAdd('zs1', 1, 'one', 3, 'three'); +$redis->zAdd('zs1', 2, 'two', 4, 'four'); +$redis->zadd('zs3', 1, 'one', 7, 'five'); + $redis->zUnionStore('dst', ['zs1', 'zs2', 'zs3']); @@ -19287,6 +25291,68 @@ Examples

+

+ + + + at line 6008 + Redis|string|false digest(string $key) + + + + + + + Ask the server for the XXH3 digest of a given key's value + + + Parameters + + + + + + + + string $key The key to retrieve the digest for. + + + Return Value + + + + + + + + Redis|string|false The XXH3 digest as a string or false on failure. + + + + + See also + + + + + + + + https://redis.io/docs/latest/commands/digest/ + + + + Examples + + + + + + $redis->digest('session:42'); + + + +

diff --git a/docs/RedisArray.html b/docs/RedisArray.html index 2a8ffb4de1..c8d5b9b629 100644 --- a/docs/RedisArray.html +++ b/docs/RedisArray.html @@ -5,7 +5,7 @@ RedisArray | PhpRedis API - + @@ -16,11 +16,400 @@ + + + + + title="PhpRedis API (develop)" /> @@ -83,7 +472,7 @@ RedisArray class - RedisArray (View source) + RedisArray (View source) @@ -113,7 +502,7 @@ Methods

- __construct(string|array $name_or_hosts, array $options = NULL) + __construct(string|array $name_or_hosts, array|null $options = null) No description @@ -179,7 +568,7 @@ Methods bool|null

- _rehash(callable $fn = NULL) + _rehash(callable|null $fn = null) No description @@ -231,7 +620,7 @@ Methods

+ + + mixed + + + acl(string $subcmd, string $args) + + No description + + + + + RedisArray|int|false + + + append(string $key, mixed $value) + + No description + + + + + + RedisArray|bool + + + auth(SensitiveParameter] $ixed $credentials) + + No description + + + + + + RedisArray|bool + + + bgrewriteaof() + + No description + + + + + + RedisArray|array|false + + + waitaof(int $numlocal, int $numreplicas, int $timeout) + + No description + + + + + + RedisArray|int|false + + + bitcount(string $key, int $start, int $end = -1, bool $bybit = false) + + No description + + + + + + RedisArray|int|false + + + bitop(string $operation, string $deskey, string $srckey, string $other_keys) + + No description + + + + + + RedisArray|int|false + + + bitpos(string $key, bool $bit, int $start, int $end = -1, bool $bybit = false) + + No description + + + + + + RedisArray|array|null|false + + + blPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed $extra_args) + + No description + + + + + + RedisArray|array|null|false + + + brPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed $extra_args) + + No description + + + + + + RedisArray|string|false + + + brpoplpush(string $src, string $dst, int|float $timeout) + + No description + + + + + + RedisArray|array|false + + + bzPopMax(string|array $key, string|int $timeout_or_key, mixed $extra_args) + + No description + + + + + + RedisArray|array|false + + + bzPopMin(string|array $key, string|int $timeout_or_key, mixed $extra_args) + + No description + + + + + + RedisArray|array|null|false + + + bzmpop(float $timeout, array $keys, string $from, int $count = 1) + + No description + + + + + + RedisArray|array|null|false + + + zmpop(array $keys, string $from, int $count = 1) + + No description + + + + + + RedisArray|array|null|false + + + blmpop(float $timeout, array $keys, string $from, int $count = 1) + + No description + + + + + + RedisArray|array|null|false + + + lmpop(array $keys, string $from, int $count = 1) + + No description + + + + + + bool + + + clearLastError() + + No description + + + + + + mixed + + + client(string $opt, mixed $args) + + No description + + + + + + bool + + + close() + + No description + + + + + + mixed + + + command(?string $opt = null, mixed $args) + + No description + + + + + + mixed + + + config(string $operation, array|string|null $key_or_settings = null, ?string $value = null) + + No description + + + + + + RedisArray|bool + + + copy(string $src, string $dst, ?array $options = null) + + No description + + + + + + RedisArray|int|false + + + dbSize() + + No description + + + + + + RedisArray|string + + + debug(string $key) + + No description + + + + + + RedisArray|int|false + + + decr(string $key, int $by = 1) + + No description + + + + + + RedisArray|int|false + + + decrBy(string $key, int $value) + + No description + + + + + + RedisArray|int|false + + + delex(string $key, ?array $options = null) + + No description + + + + + + RedisArray|int|false + + + delifeq(string $key, mixed $value) + + No description + + + + + + RedisArray|int|false + + + delete(array|string $key, string $other_keys) + + No description + + + + + + RedisArray|string|false + + + dump(string $key) + + No description + + + + + + RedisArray|string|false + + + echo(string $str) + + No description + + + + + + mixed + + + eval(string $script, array $args = [], int $num_keys) + + No description + + + + + + mixed + + + eval_ro(string $script_sha, array $args = [], int $num_keys) + + No description + + + + + + mixed + + + evalsha(string $sha1, array $args = [], int $num_keys) + + No description + + + + + + mixed + + + evalsha_ro(string $sha1, array $args = [], int $num_keys) + + No description + + + + + + RedisArray|int|bool + + + exists(mixed $key, mixed $other_keys) + + No description + + + + + + RedisArray|bool + + + expire(string $key, int $timeout, ?string $mode = null) + + No description + + + + + + RedisArray|bool + + + expireAt(string $key, int $timestamp, ?string $mode = null) + + No description + + + + + + RedisArray|bool + + + failover(?array $to = null, bool $abort = false, int $timeout) + + No description + + + + + + RedisArray|int|false + + + expiretime(string $key) + + No description + + + + + + RedisArray|int|false + + + pexpiretime(string $key) + + No description + + + + + + mixed + + + fcall(string $fn, array $keys = [], array $args = []) + + No description + + + + + + mixed + + + fcall_ro(string $fn, array $keys = [], array $args = []) + + No description + + + + + + RedisArray|bool|string|array + + + function(string $operation, mixed $args) + + No description + + + + + + RedisArray|int|false + + + geoadd(string $key, float $lng, float $lat, string $member, mixed $other_triples_and_options) + + No description + + + + + + RedisArray|float|false + + + geodist(string $key, string $src, string $dst, ?string $unit = null) + + No description + + + + + + RedisArray|array|false + + + geohash(string $key, string $member, string $other_members) + + No description + + + + + + RedisArray|array|false + + + geopos(string $key, string $member, string $other_members) + + No description + + + + + + mixed + + + georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = []) + + No description + + + + + + mixed + + + georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = []) + + No description + + + + + + mixed + + + georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = []) + + No description + + + + + + mixed + + + georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = []) + + No description + + + + + + array + + + geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = []) + + No description + + + + + + RedisArray|array|int|false + + + geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = []) + + No description + + + + + + mixed + + + get(string $key) + + No description + + + + + + RedisArray|array|false + + + getWithMeta(string $key) + + No description + + + + + + mixed + + + getAuth() + + No description + + + + + + RedisArray|int|false + + + getBit(string $key, int $idx) + + No description + + + + + + RedisArray|string|bool + + + getEx(string $key, array $options = []) + + No description + + + + + + int + + + getDBNum() + + No description + + + + + + RedisArray|string|bool + + + getDel(string $key) + + No description + + + + + + string + + + getHost() + + No description + + + + + + string|null + + + getLastError() + + No description + + + + + + int + + + getMode() + + No description + + + + + + string|null + + + getPersistentID() + + No description + + + + + + int + + + getPort() + + No description + + + + + + string|false + + + serverName() + + No description + + + + + + string|false + + + serverVersion() + + No description + + + + + + RedisArray|string|false + + + getRange(string $key, int $start, int $end) + + No description + + + + + + RedisArray|string|array|int|false + + + lcs(string $key1, string $key2, ?array $options = null) + + No description + + + + + + float + + + getReadTimeout() + + No description + + + + + + RedisArray|string|false + + + getset(string $key, mixed $value) + + No description + + + + + + float|false + + + getTimeout() + + No description + + + + + + array + + + getTransferredBytes() + + No description + + + + + + void + + + clearTransferredBytes() + + No description + + + + + + RedisArray|int|false + + + hDel(string $key, string $field, string $other_fields) + + No description + + + + + + RedisArray|bool + + + hExists(string $key, string $field) + + No description + + + + + + mixed + + + hGet(string $key, string $member) + + No description + + + + + + RedisArray|array|false + + + hGetAll(string $key) + + No description + + + + + + mixed + + + hGetWithMeta(string $key, string $member) + + No description + + + + + + RedisArray|int|false + + + hIncrBy(string $key, string $field, int $value) + + No description + + + + + + RedisArray|float|false + + + hIncrByFloat(string $key, string $field, float $value) + + No description + + + + + + RedisArray|array|false + + + hKeys(string $key) + + No description + + + + + + RedisArray|int|false + + + hLen(string $key) + + No description + + + + + + RedisArray|array|false + + + hMget(string $key, array $fields) + + No description + + + + + + RedisArray|array|false + + + hgetex(string $key, array $fields, string|array|null $expiry = null) + + No description + + + + + + RedisArray|int|false + + + hsetex(string $key, array $fields, ?array $expiry = null) + + No description + + + + + + RedisArray|array|false + + + hgetdel(string $key, array $fields) + + No description + + + + + + RedisArray|bool + + + hMset(string $key, array $fieldvals) + + No description + + + + + + RedisArray|string|array|false + + + hRandField(string $key, ?array $options = null) + + No description + + + + + + RedisArray|int|false + + + hSet(string $key, mixed $fields_and_vals) + + No description + + + + + + RedisArray|bool + + + hSetNx(string $key, string $field, mixed $value) + + No description + + + + + + RedisArray|int|false + + + hStrLen(string $key, string $field) + + No description + + + + + + RedisArray|array|false + + + hVals(string $key) + + No description + + + + + + RedisArray|array|false + + + httl(string $key, array $fields) + + No description + + + + + + RedisArray|array|false + + + hpttl(string $key, array $fields) + + No description + + + + + + RedisArray|array|false + + + hexpiretime(string $key, array $fields) + + No description + + + + + + RedisArray|array|false + + + hpexpiretime(string $key, array $fields) + + No description + + + + + + RedisArray|array|false + + + hpersist(string $key, array $fields) + + No description + + + + + + RedisArray|int|false + + + expiremember(string $key, string $field, int $ttl, ?string $unit = null) + + No description + + + + + + RedisArray|int|false + + + expirememberat(string $key, string $field, int $timestamp) + + No description + + + + + + RedisArray|int|false + + + incr(string $key, int $by = 1) + + No description + + + + + + RedisArray|int|false + + + incrBy(string $key, int $value) + + No description + + + + + + RedisArray|float|false + + + incrByFloat(string $key, float $value) + + No description + + + + + + bool + + + isConnected() + + No description + + + + + + void + + + lInsert(string $key, string $pos, mixed $pivot, mixed $value) + + No description + + + + + + RedisArray|int|false + + + lLen(string $key) + + No description + + + + + + RedisArray|string|false + + + lMove(string $src, string $dst, string $wherefrom, string $whereto) + + No description + + + + + + RedisArray|string|false + + + blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout) + + No description + + + + + + RedisArray|bool|string|array + + + lPop(string $key, int $count) + + No description + + + + + + RedisArray|null|bool|int|array + + + lPos(string $key, mixed $value, ?array $options = null) + + No description + + + + + + RedisArray|int|false + + + lPush(string $key, mixed $elements) + + No description + + + + + + RedisArray|int|false + + + rPush(string $key, mixed $elements) + + No description + + + + + + RedisArray|int|false + + + lPushx(string $key, mixed $value) + + No description + + + + + + RedisArray|int|false + + + rPushx(string $key, mixed $value) + + No description + + + + + + RedisArray|bool + + + lSet(string $key, int $index, mixed $value) + + No description + + + + + + int + + + lastSave() + + No description + + + + + + mixed + + + lindex(string $key, int $index) + + No description + + + + + + RedisArray|array|false + + + lrange(string $key, int $start, int $end) + + No description + + + + + + RedisArray|int|false + + + lrem(string $key, mixed $value, int $count) + + No description + + + + + + RedisArray|bool + + + ltrim(string $key, int $start, int $end) + + No description + + + + + + RedisArray|bool + + + move(string $key, int $index) + + No description + + + + + + RedisArray|int|false + + + msetex(array $key_vals, int|float|array|null $expiry = null) + + No description + + + + + + RedisArray|bool + + + msetnx(array $key_values) + + No description + + + + + + RedisArray|int|string|false + + + object(string $subcommand, string $key) + + No description + + + + + + bool + + + open(string $host, int $port = 6379, float $timeout, ?string $persistent_id = null, int $retry_interval, float $read_timeout, ?array $context = null) + + No description + + + + + + bool + + + pconnect(string $host, int $port = 6379, float $timeout, ?string $persistent_id = null, int $retry_interval, float $read_timeout, ?array $context = null) + + No description + + + + + + RedisArray|bool + + + persist(string $key) + + No description + + + + + + bool + + + pexpire(string $key, int $timeout, ?string $mode = null) + + No description + + + + + + RedisArray|bool + + + pexpireAt(string $key, int $timestamp, ?string $mode = null) + + No description + + + + + + RedisArray|int + + + pfadd(string $key, array $elements) + + No description + + + + + + RedisArray|int|false + + + pfcount(array|string $key_or_keys) + + No description + + + + + + RedisArray|bool + + + pfmerge(string $dst, array $srckeys) + + No description + + + + + + RedisArray + + + pipeline() + + No description + + + + + + bool + + + popen(string $host, int $port = 6379, float $timeout, ?string $persistent_id = null, int $retry_interval, float $read_timeout, ?array $context = null) + + No description + + + + + + RedisArray|bool + + + psetex(string $key, int $expire, mixed $value) + + No description + + + + + + bool + + + psubscribe(array $patterns, callable $cb) + + No description + + + + + + RedisArray|int|false + + + pttl(string $key) + + No description + + + + + + RedisArray|int|false + + + publish(string $channel, string $message) + + No description + + + + + + mixed + + + pubsub(string $command, mixed $arg = null) + + No description + + + + + + RedisArray|array|bool + + + punsubscribe(array $patterns) + + No description + + + + + + RedisArray|array|string|bool + + + rPop(string $key, int $count) + + No description + + + + + + RedisArray|string|false + + + randomKey() + + No description + + + + + + mixed + + + rawcommand(string $command, mixed $args) + + No description + + + + + + RedisArray|bool + + + rename(string $old_name, string $new_name) + + No description + + + + + + RedisArray|bool + + + renameNx(string $key_src, string $key_dst) + + No description + + + + + + RedisArray|bool + + + reset() + + No description + + + + + + RedisArray|bool + + + restore(string $key, int $ttl, string $value, ?array $options = null) + + No description + + + + + + mixed + + + role() + + No description + + + + + + RedisArray|string|false + + + rpoplpush(string $srckey, string $dstkey) + + No description + + + + + + RedisArray|int|false + + + sAdd(string $key, mixed $value, mixed $other_values) + + No description + + + + + + int + + + sAddArray(string $key, array $values) + + No description + + + + + + RedisArray|array|false + + + sDiff(string $key, string $other_keys) + + No description + + + + + + RedisArray|int|false + + + sDiffStore(string $dst, string $key, string $other_keys) + + No description + + + + + + RedisArray|array|false + + + sInter(array|string $key, string $other_keys) + + No description + + + + + + RedisArray|int|false + + + sintercard(array $keys, int $limit = -1) + + No description + + + + + + RedisArray|int|false + + + sInterStore(array|string $key, string $other_keys) + + No description + + + + + + RedisArray|array|false + + + sMembers(string $key) + + No description + + + + + + RedisArray|array|false + + + sMisMember(string $key, string $member, string $other_members) + + No description + + + + + + RedisArray|bool + + + sMove(string $src, string $dst, mixed $value) + + No description + + + + + + RedisArray|string|array|false + + + sPop(string $key, int $count) + + No description + + + + + + mixed + + + sRandMember(string $key, int $count) + + No description + + + + + + RedisArray|array|false + + + sUnion(string $key, string $other_keys) + + No description + + + + + + RedisArray|int|false + + + sUnionStore(string $dst, string $key, string $other_keys) + + No description + + + + + + RedisArray|int|false + + + scard(string $key) + + No description + + + + + + mixed + + + script(string $command, mixed $args) + + No description + + + + + + RedisArray|string|bool + + + set(string $key, mixed $value, mixed $options = null) + + No description + + + + + + RedisArray|int|false + + + setBit(string $key, int $idx, bool $value) + + No description + + + + + + RedisArray|int|false + + + setRange(string $key, int $index, string $value) + + No description + + + + + + void + + + setex(string $key, int $expire, mixed $value) + + No description + + + + + + RedisArray|bool + + + setnx(string $key, mixed $value) + + No description + + + + + + RedisArray|bool + + + sismember(string $key, mixed $value) + + No description + + + + + + RedisArray|bool + + + slaveof(?string $host = null, int $port = 6379) + + No description + + + + + + RedisArray|bool + + + replicaof(?string $host = null, int $port = 6379) + + No description + + + + + + RedisArray|int|false + + + touch(array|string $key_or_array, string $more_keys) + + No description + + + + + + mixed + + + slowlog(string $operation, int $length) + + No description + + + + + + mixed + + + sort(string $key, ?array $options = null) + + No description + + + + + + mixed + + + sort_ro(string $key, ?array $options = null) + + No description + + + + + + array + + + sortAsc(string $key, ?string $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, ?string $store = null) + + No description + + + + + + array + + + sortAscAlpha(string $key, ?string $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, ?string $store = null) + + No description + + + + + + array + + + sortDesc(string $key, ?string $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, ?string $store = null) + + No description + + + + + + array + + + sortDescAlpha(string $key, ?string $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, ?string $store = null) + + No description + + + + + + RedisArray|int|false + + + srem(string $key, mixed $value, mixed $other_values) + + No description + + + + + + bool + + + ssubscribe(array $channels, callable $cb) + + No description + + + + + + RedisArray|int|false + + + strlen(string $key) + + No description + + + + + + bool + + + subscribe(array $channels, callable $cb) + + No description + + + + + + RedisArray|array|bool + + + sunsubscribe(array $channels) + + No description + + + + + + RedisArray|bool + + + swapdb(int $src, int $dst) + + No description + + + + + + RedisArray|array + + + time() + + No description + + + + + + RedisArray|int|false + + + ttl(string $key) + + No description + + + + + + RedisArray|int|false + + + type(string $key) + + No description + + + + + + RedisArray|array|bool + + + unsubscribe(array $channels) + + No description + + + + + + RedisArray|bool + + + watch(array|string $key, string $other_keys) + + No description + + + + + + int|false + + + wait(int $numreplicas, int $timeout) + + No description + + + + + + int|false + + + xack(string $key, string $group, array $ids) + + No description + + + + + + RedisArray|string|false + + + xadd(string $key, string $id, array $values, int $maxlen, bool $approx = false, bool $nomkstream = false) + + No description + + + + + + RedisArray|bool|array + + + xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = -1, bool $justid = false) + + No description + + + + + + RedisArray|array|bool + + + xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options) + + No description + + + + + + RedisArray|int|false + + + xdel(string $key, array $ids) + + No description + + + + + + Relay|array|false + + + xdelex(string $key, array $ids, ?string $mode = null) + + No description + + + + + + mixed + + + xinfo(string $operation, ?string $arg1 = null, ?string $arg2 = null, int $count = -1) + + No description + + + + + + RedisArray|int|false + + + xlen(string $key) + + No description + + + + + + RedisArray|array|false + + + xpending(string $key, string $group, ?string $start = null, ?string $end = null, int $count = -1, ?string $consumer = null) + + No description + + + + + + RedisArray|array|bool + + + xrange(string $key, string $start, string $end, int $count = -1) + + No description + + + + + + RedisArray|array|bool + + + xread(array $streams, int $count = -1, int $block = -1) + + No description + + + + + + RedisArray|array|bool + + + xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1) + + No description + + + + + + RedisArray|array|bool + + + xrevrange(string $key, string $end, string $start, int $count = -1) + + No description + + + + + + RedisArray|int|false + + + vadd(string $key, array $values, mixed $element, array|null $options = null) + + No description + + + + + + RedisArray|array|false + + + vsim(string $key, mixed $member, array|null $options = null) + + No description + + + + + + RedisArray|int|false + + + vcard(string $key) + + No description + + + + + + RedisArray|int|false + + + vdim(string $key) + + No description + + + + + + RedisArray|array|false + + + vinfo(string $key) + + No description + + + + + + RedisArray|bool + + + vismember(string $key, mixed $member) + + No description + + + + + + RedisArray|array|false + + + vemb(string $key, mixed $member, bool $raw = false) + + No description + + + + + + RedisArray|array|string|false + + + vrandmember(string $key, int $count) + + No description + + + + + + RedisArray|array|false + + + vrange(string $key, string $min, string $max, int $count = -1) + + No description + + + + + + RedisArray|int|false + + + vrem(string $key, mixed $member) + + No description + + + + + + RedisArray|int|false + + + vsetattr(string $key, mixed $member, array|string $attributes) + + No description + + + + + + RedisArray|array|string|false + + + vgetattr(string $key, mixed $member, bool $decode = true) + + No description + + + + + + RedisArray|array|false + + + vlinks(string $key, mixed $member, bool $withscores = false) + + No description + + + + + + RedisArray|int|false + + + xtrim(string $key, string $threshold, bool $approx = false, bool $minid = false, int $limit = -1) + + No description + + + + + + RedisArray|int|float|false + + + zAdd(string $key, array|float $score_or_options, mixed $more_scores_and_mems) + + No description + + + + + + RedisArray|int|false + + + zCard(string $key) + + No description + + + + + + RedisArray|int|false + + + zCount(string $key, int|string $start, int|string $end) + + No description + + + + + + RedisArray|float|false + + + zIncrBy(string $key, float $value, mixed $member) + + No description + + + + + + RedisArray|int|false + + + zLexCount(string $key, string $min, string $max) + + No description + + + + + + RedisArray|array|false + + + zMscore(string $key, mixed $member, mixed $other_members) + + No description + + + + + + RedisArray|array|false + + + zPopMax(string $key, ?int $count = null) + + No description + + + + + + RedisArray|array|false + + + zPopMin(string $key, ?int $count = null) + + No description + + + + + + RedisArray|array|false + + + zRange(string $key, string|int $start, string|int $end, array|bool|null $options = null) + + No description + + + + + + RedisArray|array|false + + + zRangeByLex(string $key, string $min, string $max, int $offset = -1, int $count = -1) + + No description + + + + + + RedisArray|array|false + + + zRangeByScore(string $key, string $start, string $end, array $options = []) + + No description + + + + + + RedisArray|string|array + + + zRandMember(string $key, ?array $options = null) + + No description + + + + + + RedisArray|int|false + + + zRank(string $key, mixed $member) + + No description + + + + + + RedisArray|int|false + + + zRem(mixed $key, mixed $member, mixed $other_members) + + No description + + + + + + RedisArray|int|false + + + zRemRangeByLex(string $key, string $min, string $max) + + No description + + + + + + RedisArray|int|false + + + zRemRangeByRank(string $key, int $start, int $end) + + No description + + + + + + RedisArray|int|false + + + zRemRangeByScore(string $key, string $start, string $end) + + No description + + + + + + RedisArray|array|false + + + zRevRange(string $key, int $start, int $end, mixed $scores = null) + + No description + + + + + + RedisArray|array|false + + + zRevRangeByLex(string $key, string $max, string $min, int $offset = -1, int $count = -1) + + No description + + + + + + RedisArray|array|false + + + zRevRangeByScore(string $key, string $max, string $min, array|bool $options = []) + + No description + + + + + + RedisArray|int|false + + + zRevRank(string $key, mixed $member) + + No description + + + + + + RedisArray|float|false + + + zScore(string $key, mixed $member) + + No description + + + + + + RedisArray|array|false + + + zdiff(array $keys, ?array $options = null) + + No description + + + + + + RedisArray|int|false + + + zdiffstore(string $dst, array $keys) + + No description + + + + + + RedisArray|array|false + + + zinter(array $keys, ?array $weights = null, ?array $options = null) + + No description + + + + + + RedisArray|int|false + + + zintercard(array $keys, int $limit = -1) + + No description + + + + + + RedisArray|int|false + + + zinterstore(string $dst, array $keys, ?array $weights = null, ?string $aggregate = null) + + No description + + + + + + RedisArray|array|false + + + zunion(array $keys, ?array $weights = null, ?array $options = null) + + No description + + + + + + RedisArray|int|false + + + zunionstore(string $dst, array $keys, ?array $weights = null, ?string $aggregate = null) + + No description + + + + + + RedisArray|string|false + + + digest(string $key) + + No description + + + +

+ + + Details + + + + + + at line 265 + mixed __call(string $function_name, array $arguments) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $function_name array $arguments + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 267 + __construct(string|array $name_or_hosts, array|null $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string|array $name_or_hosts array|null $options + + + + + + + + + + + + + at line 269 + bool|array _continuum() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 271 + bool|callable _distributor() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|callable + + + + + + + + + + + + + at line 273 + bool|callable _function() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|callable + + + + + + + + + + + + + at line 275 + bool|array _hosts() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 277 + bool|null|Redis _instance(string $host) + + + + + + + No description + + + + Parameters + + + + + + + + string $host + + + Return Value + + + + + + + + bool|null|Redis + + + + + + + + + + + + + at line 279 + bool|null _rehash(callable|null $fn = null) + + + + + + + No description + + + + Parameters + + + + + + + + callable|null $fn + + + Return Value + + + + + + + + bool|null + + + + + + + + + + + + + at line 281 + bool|string|null _target(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + bool|string|null + + + + + + + + + + + + + at line 283 + array bgsave() + + + + + + + No description + + + + + Return Value + + + + + + + + array + + + + + + + + + + + + + at line 285 + bool|int del(string|array $key, string ...$otherkeys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string|array $key string ...$otherkeys + + + Return Value + + + + + + + + bool|int + + + + + + + + + + + + + at line 287 + bool|null discard() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|null + + + + + + + + + + + + + at line 289 + bool|null|array exec() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|null|array + + + + + + + + + + + + + at line 291 + bool|array flushall() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 293 + bool|array flushdb() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 295 + bool|array getOption(int $opt) + + + + + + + No description + + + + Parameters + + + + + + + + int $opt + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 297 + bool|array hscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key null|int|string $iterator string|null $pattern int $count + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 299 + bool|array info() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 301 + bool|array keys(string $pattern) + + + + + + + No description + + + + Parameters + + + + + + + + string $pattern + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 303 + bool|array mget(array $keys) + + + + + + + No description + + + + Parameters + + + + + + + + array $keys + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 305 + bool mset(array $pairs) + + + + + + + No description + + + + Parameters + + + + + + + + array $pairs + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 307 + bool|RedisArray multi(string $host, int|null $mode = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $host int|null $mode + + + Return Value + + + + + + + + bool|RedisArray + + + + + + + + + + + + + at line 309 + bool|array ping() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 311 + bool|array save() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 313 + bool|array scan(null|int|string $iterator, string $node, string|null $pattern = null, int $count = 0) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + null|int|string $iterator string $node string|null $pattern int $count + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 315 + bool|array select(int $index) + + + + + + + No description + + + + Parameters + + + + + + + + int $index + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 317 + bool|array setOption(int $opt, string $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + int $opt string $value + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 319 + bool|array sscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key null|int|string $iterator string|null $pattern int $count + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 321 + bool|int unlink(string|array $key, string ...$otherkeys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string|array $key string ...$otherkeys + + + Return Value + + + + + + + + bool|int + + + + + + + + + + + + + at line 323 + bool|null unwatch() + + + + + + + No description + + + + + Return Value + + + + + + + + bool|null + + + + + + + + + + + + + at line 325 + bool|array zscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key null|int|string $iterator string|null $pattern int $count + + + Return Value + + + + + + + + bool|array + + + + + + + + + + + + + at line 263 + mixed acl(string $subcmd, string $args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $subcmd string $args + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|int|false append(string $key, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|bool auth(SensitiveParameter] $ixed $credentials) + + + + + + + No description + + + + Parameters + + + + + + + + SensitiveParameter] $ixed $credentials + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool bgrewriteaof() + + + + + + + No description + + + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|array|false waitaof(int $numlocal, int $numreplicas, int $timeout) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + int $numlocal int $numreplicas int $timeout + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false bitcount(string $key, int $start, int $end = -1, bool $bybit = false) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key int $start int $end bool $bybit + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false bitop(string $operation, string $deskey, string $srckey, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $operation string $deskey string $srckey string $other_keys + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false bitpos(string $key, bool $bit, int $start, int $end = -1, bool $bybit = false) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key bool $bit int $start int $end bool $bybit + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|null|false blPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed $extra_args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string|array $key_or_keys string|float|int $timeout_or_key mixed $extra_args + + + Return Value + + + + + + + + RedisArray|array|null|false + + + + + + + + + + + + + at line 263 + RedisArray|array|null|false brPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed $extra_args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string|array $key_or_keys string|float|int $timeout_or_key mixed $extra_args + + + Return Value + + + + + + + + RedisArray|array|null|false + + + + + + + + + + + + + at line 263 + RedisArray|string|false brpoplpush(string $src, string $dst, int|float $timeout) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $src string $dst int|float $timeout + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false bzPopMax(string|array $key, string|int $timeout_or_key, mixed $extra_args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string|array $key string|int $timeout_or_key mixed $extra_args + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false bzPopMin(string|array $key, string|int $timeout_or_key, mixed $extra_args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string|array $key string|int $timeout_or_key mixed $extra_args + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|null|false bzmpop(float $timeout, array $keys, string $from, int $count = 1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + float $timeout array $keys string $from int $count + + + Return Value + + + + + + + + RedisArray|array|null|false + + + + + + + + + + + + + at line 263 + RedisArray|array|null|false zmpop(array $keys, string $from, int $count = 1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + array $keys string $from int $count + + + Return Value + + + + + + + + RedisArray|array|null|false + + + + + + + + + + + + + at line 263 + RedisArray|array|null|false blmpop(float $timeout, array $keys, string $from, int $count = 1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + float $timeout array $keys string $from int $count + + + Return Value + + + + + + + + RedisArray|array|null|false + + + + + + + + + + + + + at line 263 + RedisArray|array|null|false lmpop(array $keys, string $from, int $count = 1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + array $keys string $from int $count + + + Return Value + + + + + + + + RedisArray|array|null|false + + + + + + + + + + + + + at line 263 + bool clearLastError() + + + + + + + No description + + + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + mixed client(string $opt, mixed $args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $opt mixed $args + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + bool close() + + + + + + + No description + + + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + mixed command(?string $opt = null, mixed $args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + ?string $opt mixed $args + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed config(string $operation, array|string|null $key_or_settings = null, ?string $value = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $operation array|string|null $key_or_settings ?string $value + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|bool copy(string $src, string $dst, ?array $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $src string $dst ?array $options + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false dbSize() + + + + + + + No description + + + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|string debug(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|string + + + + + + + + + + + + + at line 263 + RedisArray|int|false decr(string $key, int $by = 1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $by + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false decrBy(string $key, int $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false delex(string $key, ?array $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key ?array $options + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false delifeq(string $key, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false delete(array|string $key, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array|string $key string $other_keys + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|string|false dump(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + RedisArray|string|false echo(string $str) + + + + + + + No description + + + + Parameters + + + + + + + + string $str + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + mixed eval(string $script, array $args = [], int $num_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $script array $args int $num_keys + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed eval_ro(string $script_sha, array $args = [], int $num_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $script_sha array $args int $num_keys + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed evalsha(string $sha1, array $args = [], int $num_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $sha1 array $args int $num_keys + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed evalsha_ro(string $sha1, array $args = [], int $num_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $sha1 array $args int $num_keys + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|int|bool exists(mixed $key, mixed $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + mixed $key mixed $other_keys + + + Return Value + + + + + + + + RedisArray|int|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool expire(string $key, int $timeout, ?string $mode = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $timeout ?string $mode + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool expireAt(string $key, int $timestamp, ?string $mode = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $timestamp ?string $mode + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool failover(?array $to = null, bool $abort = false, int $timeout) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + ?array $to bool $abort int $timeout + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false expiretime(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false pexpiretime(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + mixed fcall(string $fn, array $keys = [], array $args = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $fn array $keys array $args + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed fcall_ro(string $fn, array $keys = [], array $args = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $fn array $keys array $args + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|bool|string|array function(string $operation, mixed $args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $operation mixed $args + + + Return Value + + + + + + + + RedisArray|bool|string|array + + + + + + + + + + + + + at line 263 + RedisArray|int|false geoadd(string $key, float $lng, float $lat, string $member, mixed $other_triples_and_options) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key float $lng float $lat string $member mixed $other_triples_and_options + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|float|false geodist(string $key, string $src, string $dst, ?string $unit = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key string $src string $dst ?string $unit + + + Return Value + + + + + + + + RedisArray|float|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false geohash(string $key, string $member, string $other_members) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $member string $other_members + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false geopos(string $key, string $member, string $other_members) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $member string $other_members + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + mixed georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key float $lng float $lat float $radius string $unit array $options + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key float $lng float $lat float $radius string $unit array $options + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key string $member float $radius string $unit array $options + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key string $member float $radius string $unit array $options + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + array geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key array|string $position array|int|float $shape string $unit array $options + + + Return Value + + + + + + + + array + + + + + + + + + + + + + at line 263 + RedisArray|array|int|false geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $dst string $src array|string $position array|int|float $shape string $unit array $options + + + Return Value + + + + + + + + RedisArray|array|int|false + + + + + + + + + + + + + at line 263 + mixed get(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|array|false getWithMeta(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + mixed getAuth() + + + + + + + No description + + + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|int|false getBit(string $key, int $idx) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $idx + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|string|bool getEx(string $key, array $options = []) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $options + + + Return Value + + + + + + + + RedisArray|string|bool + + + + + + + + + + + + + at line 263 + int getDBNum() + + + + + + + No description + + + + + Return Value + + + + + + + + int + + + + + + + + + + + + + at line 263 + RedisArray|string|bool getDel(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|string|bool + + + + + + + + + + + + + at line 263 + string getHost() + + + + + + + No description + + + + + Return Value + + + + + + + + string + + + + + + + + + + + + + at line 263 + string|null getLastError() + + + + + + + No description + + + + + Return Value + + + + + + + + string|null + + + + + + + + + + + + + at line 263 + int getMode() + + + + + + + No description + + + + + Return Value + + + + + + + + int + + + + + + + + + + + + + at line 263 + string|null getPersistentID() + + + + + + + No description + + + + + Return Value + + + + + + + + string|null + + + + + + + + + + + + + at line 263 + int getPort() + + + + + + + No description + + + + + Return Value + + + + + + + + int + + + + + + + + + + + + + at line 263 + string|false serverName() + + + + + + + No description + + + + + Return Value + + + + + + + + string|false + + + + + + + + + + + + + at line 263 + string|false serverVersion() + + + + + + + No description + + + + + Return Value + + + + + + + + string|false + + + + + + + + + + + + + at line 263 + RedisArray|string|false getRange(string $key, int $start, int $end) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $start int $end + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + RedisArray|string|array|int|false lcs(string $key1, string $key2, ?array $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key1 string $key2 ?array $options + + + Return Value + + + + + + + + RedisArray|string|array|int|false + + + + + + + + + + + + + at line 263 + float getReadTimeout() + + + + + + + No description + + + + + Return Value + + + + + + + + float + + + + + + + + + + + + + at line 263 + RedisArray|string|false getset(string $key, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $value + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + float|false getTimeout() + + + + + + + No description + + + + + Return Value + + + + + + + + float|false + + + + + + + + + + + + + at line 263 + array getTransferredBytes() + + + + + + + No description + + + + + Return Value + + + + + + + + array + + + + + + + + + + + + + at line 263 + void clearTransferredBytes() + + + + + + + No description + + + + + Return Value + + + + + + + + void + + + + + + + + + + + + + at line 263 + RedisArray|int|false hDel(string $key, string $field, string $other_fields) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $field string $other_fields + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|bool hExists(string $key, string $field) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key string $field + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + mixed hGet(string $key, string $member) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key string $member + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|array|false hGetAll(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + mixed hGetWithMeta(string $key, string $member) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key string $member + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|int|false hIncrBy(string $key, string $field, int $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $field int $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|float|false hIncrByFloat(string $key, string $field, float $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $field float $value + + + Return Value + + + + + + + + RedisArray|float|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hKeys(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false hLen(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hMget(string $key, array $fields) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $fields + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hgetex(string $key, array $fields, string|array|null $expiry = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key array $fields string|array|null $expiry + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false hsetex(string $key, array $fields, ?array $expiry = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key array $fields ?array $expiry + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hgetdel(string $key, array $fields) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $fields + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|bool hMset(string $key, array $fieldvals) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $fieldvals + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|string|array|false hRandField(string $key, ?array $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key ?array $options + + + Return Value + + + + + + + + RedisArray|string|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false hSet(string $key, mixed $fields_and_vals) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $fields_and_vals + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|bool hSetNx(string $key, string $field, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $field mixed $value + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false hStrLen(string $key, string $field) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key string $field + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hVals(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false httl(string $key, array $fields) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $fields + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hpttl(string $key, array $fields) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $fields + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hexpiretime(string $key, array $fields) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $fields + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hpexpiretime(string $key, array $fields) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $fields + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false hpersist(string $key, array $fields) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $fields + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false expiremember(string $key, string $field, int $ttl, ?string $unit = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key string $field int $ttl ?string $unit + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false expirememberat(string $key, string $field, int $timestamp) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $field int $timestamp + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false incr(string $key, int $by = 1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $by + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false incrBy(string $key, int $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|float|false incrByFloat(string $key, float $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key float $value + + + Return Value + + + + + + + + RedisArray|float|false + + + + + + + + + + + + + at line 263 + bool isConnected() + + + + + + + No description + + + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + void lInsert(string $key, string $pos, mixed $pivot, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key string $pos mixed $pivot mixed $value + + + Return Value + + + + + + + + void + + + + + + + + + + + + + at line 263 + RedisArray|int|false lLen(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|string|false lMove(string $src, string $dst, string $wherefrom, string $whereto) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $src string $dst string $wherefrom string $whereto + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + RedisArray|string|false blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $src string $dst string $wherefrom string $whereto float $timeout + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + RedisArray|bool|string|array lPop(string $key, int $count) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $count + + + Return Value + + + + + + + + RedisArray|bool|string|array + + + + + + + + + + + + + at line 263 + RedisArray|null|bool|int|array lPos(string $key, mixed $value, ?array $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $value ?array $options + + + Return Value + + + + + + + + RedisArray|null|bool|int|array + + + + + + + + + + + + + at line 263 + RedisArray|int|false lPush(string $key, mixed $elements) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $elements + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false rPush(string $key, mixed $elements) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $elements + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false lPushx(string $key, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false rPushx(string $key, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|bool lSet(string $key, int $index, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $index mixed $value + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + int lastSave() + + + + + + + No description + + + + + Return Value + + + + + + + + int + + + + + + + + + + + + + at line 263 + mixed lindex(string $key, int $index) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $index + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|array|false lrange(string $key, int $start, int $end) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $start int $end + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false lrem(string $key, mixed $value, int $count) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $value int $count + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|bool ltrim(string $key, int $start, int $end) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $start int $end + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool move(string $key, int $index) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $index + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false msetex(array $key_vals, int|float|array|null $expiry = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array $key_vals int|float|array|null $expiry + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|bool msetnx(array $key_values) + + + + + + + No description + + + + Parameters + + + + + + + + array $key_values + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|string|false object(string $subcommand, string $key) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $subcommand string $key + + + Return Value + + + + + + + + RedisArray|int|string|false + + + + + + + + + + + + + at line 263 + bool open(string $host, int $port = 6379, float $timeout, ?string $persistent_id = null, int $retry_interval, float $read_timeout, ?array $context = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $host int $port float $timeout ?string $persistent_id int $retry_interval float $read_timeout ?array $context + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + bool pconnect(string $host, int $port = 6379, float $timeout, ?string $persistent_id = null, int $retry_interval, float $read_timeout, ?array $context = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $host int $port float $timeout ?string $persistent_id int $retry_interval float $read_timeout ?array $context + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + RedisArray|bool persist(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + bool pexpire(string $key, int $timeout, ?string $mode = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $timeout ?string $mode + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + RedisArray|bool pexpireAt(string $key, int $timestamp, ?string $mode = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $timestamp ?string $mode + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|int pfadd(string $key, array $elements) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $elements + + + Return Value + + + + + + + + RedisArray|int + + + + + + + + + + + + + at line 263 + RedisArray|int|false pfcount(array|string $key_or_keys) + + + + + + + No description + + + + Parameters + + + + + + + + array|string $key_or_keys + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|bool pfmerge(string $dst, array $srckeys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $dst array $srckeys + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray pipeline() + + + + + + + No description + + + + + Return Value + + + + + + + + RedisArray + + + + + + + + + + + + + at line 263 + bool popen(string $host, int $port = 6379, float $timeout, ?string $persistent_id = null, int $retry_interval, float $read_timeout, ?array $context = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $host int $port float $timeout ?string $persistent_id int $retry_interval float $read_timeout ?array $context + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + RedisArray|bool psetex(string $key, int $expire, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $expire mixed $value + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + bool psubscribe(array $patterns, callable $cb) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array $patterns callable $cb + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false pttl(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false publish(string $channel, string $message) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $channel string $message + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + mixed pubsub(string $command, mixed $arg = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $command mixed $arg + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|array|bool punsubscribe(array $patterns) + + + + + + + No description + + + + Parameters + + + + + + + + array $patterns + + + Return Value + + + + + + + + RedisArray|array|bool + + + + + + + + + + + + + at line 263 + RedisArray|array|string|bool rPop(string $key, int $count) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $count + + + Return Value + + + + + + + + RedisArray|array|string|bool + + + + + + + + + + + + + at line 263 + RedisArray|string|false randomKey() + + + + + + + No description + + + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + mixed rawcommand(string $command, mixed $args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $command mixed $args + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|bool rename(string $old_name, string $new_name) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $old_name string $new_name + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool renameNx(string $key_src, string $key_dst) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key_src string $key_dst + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool reset() + + + + + + + No description + + + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool restore(string $key, int $ttl, string $value, ?array $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key int $ttl string $value ?array $options + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + mixed role() + + + + + + + No description + + + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|string|false rpoplpush(string $srckey, string $dstkey) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $srckey string $dstkey + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false sAdd(string $key, mixed $value, mixed $other_values) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $value mixed $other_values + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + int sAddArray(string $key, array $values) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $values + + + Return Value + + + + + + + + int + + + + + + + + + + + + + at line 263 + RedisArray|array|false sDiff(string $key, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key string $other_keys + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false sDiffStore(string $dst, string $key, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $dst string $key string $other_keys + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false sInter(array|string $key, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array|string $key string $other_keys + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false sintercard(array $keys, int $limit = -1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array $keys int $limit + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false sInterStore(array|string $key, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array|string $key string $other_keys + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false sMembers(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false sMisMember(string $key, string $member, string $other_members) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $member string $other_members + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|bool sMove(string $src, string $dst, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $src string $dst mixed $value + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|string|array|false sPop(string $key, int $count) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $count + + + Return Value + + + + + + + + RedisArray|string|array|false + + + + + + + + + + + + + at line 263 + mixed sRandMember(string $key, int $count) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $count + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|array|false sUnion(string $key, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key string $other_keys + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false sUnionStore(string $dst, string $key, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $dst string $key string $other_keys + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false scard(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + mixed script(string $command, mixed $args) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $command mixed $args + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|string|bool set(string $key, mixed $value, mixed $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $value mixed $options + + + Return Value + + + + + + + + RedisArray|string|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false setBit(string $key, int $idx, bool $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $idx bool $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false setRange(string $key, int $index, string $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $index string $value + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + void setex(string $key, int $expire, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key int $expire mixed $value + + + Return Value + + + + + + + + void + + + + + + + + + + + + + at line 263 + RedisArray|bool setnx(string $key, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $value + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool sismember(string $key, mixed $value) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $value + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool slaveof(?string $host = null, int $port = 6379) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + ?string $host int $port + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool replicaof(?string $host = null, int $port = 6379) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + ?string $host int $port + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false touch(array|string $key_or_array, string $more_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array|string $key_or_array string $more_keys + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + mixed slowlog(string $operation, int $length) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $operation int $length + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed sort(string $key, ?array $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key ?array $options + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + mixed sort_ro(string $key, ?array $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key ?array $options + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + array sortAsc(string $key, ?string $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, ?string $store = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key ?string $pattern mixed $get int $offset int $count ?string $store + + + Return Value + + + + + + + + array + + + + + + + + + + + + + at line 263 + array sortAscAlpha(string $key, ?string $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, ?string $store = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key ?string $pattern mixed $get int $offset int $count ?string $store + + + Return Value + + + + + + + + array + + + + + + + + + + + + + at line 263 + array sortDesc(string $key, ?string $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, ?string $store = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key ?string $pattern mixed $get int $offset int $count ?string $store + + + Return Value + + + + + + + + array + + + + + + + + + + + + + at line 263 + array sortDescAlpha(string $key, ?string $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, ?string $store = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key ?string $pattern mixed $get int $offset int $count ?string $store + + + Return Value + + + + + + + + array + + + + + + + + + + + + + at line 263 + RedisArray|int|false srem(string $key, mixed $value, mixed $other_values) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $value mixed $other_values + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + bool ssubscribe(array $channels, callable $cb) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array $channels callable $cb + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false strlen(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + bool subscribe(array $channels, callable $cb) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array $channels callable $cb + + + Return Value + + + + + + + + bool + + + + + + + + + + + + + at line 263 + RedisArray|array|bool sunsubscribe(array $channels) + + + + + + + No description + + + + Parameters + + + + + + + + array $channels + + + Return Value + + + + + + + + RedisArray|array|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool swapdb(int $src, int $dst) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + int $src int $dst + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|array time() + + + + + + + No description + + + + + Return Value + + + + + + + + RedisArray|array + + + + + + + + + + + + + at line 263 + RedisArray|int|false ttl(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false type(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|bool unsubscribe(array $channels) + + + + + + + No description + + + + Parameters + + + + + + + + array $channels + + + Return Value + + + + + + + + RedisArray|array|bool + + + + + + + + + + + + + at line 263 + RedisArray|bool watch(array|string $key, string $other_keys) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + array|string $key string $other_keys + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + int|false wait(int $numreplicas, int $timeout) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + int $numreplicas int $timeout + + + Return Value + + + + + + + + int|false + + + + + + + + + + + + + at line 263 + int|false xack(string $key, string $group, array $ids) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key string $group array $ids + + + Return Value + + + + + + + + int|false + + + + + + + + + + + + + at line 263 + RedisArray|string|false xadd(string $key, string $id, array $values, int $maxlen, bool $approx = false, bool $nomkstream = false) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key string $id array $values int $maxlen bool $approx bool $nomkstream + + + Return Value + + + + + + + + RedisArray|string|false + + + + + + + + + + + + + at line 263 + RedisArray|bool|array xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = -1, bool $justid = false) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key string $group string $consumer int $min_idle string $start int $count bool $justid + + + Return Value + + + + + + + + RedisArray|bool|array + + + + + + + + + + + + + at line 263 + RedisArray|array|bool xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key string $group string $consumer int $min_idle array $ids array $options + + + Return Value + + + + + + + + RedisArray|array|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false xdel(string $key, array $ids) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key array $ids + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + Relay|array|false xdelex(string $key, array $ids, ?string $mode = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key array $ids ?string $mode + + + Return Value + + + + + + + + Relay|array|false + + + + + + + + + + + + + at line 263 + mixed xinfo(string $operation, ?string $arg1 = null, ?string $arg2 = null, int $count = -1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $operation ?string $arg1 ?string $arg2 int $count + + + Return Value + + + + + + + + mixed + + + + + + + + + + + + + at line 263 + RedisArray|int|false xlen(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false xpending(string $key, string $group, ?string $start = null, ?string $end = null, int $count = -1, ?string $consumer = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $key string $group ?string $start ?string $end int $count ?string $consumer + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|bool xrange(string $key, string $start, string $end, int $count = -1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key string $start string $end int $count + + + Return Value + + + + + + + + RedisArray|array|bool + + + + + + + + + + + + + at line 263 + RedisArray|array|bool xread(array $streams, int $count = -1, int $block = -1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + array $streams int $count int $block + + + Return Value + + + + + + + + RedisArray|array|bool + + + + + + + + + + + + + at line 263 + RedisArray|array|bool xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + string $group string $consumer array $streams int $count int $block + + + Return Value + + + + + + + + RedisArray|array|bool + + + + + + + + + + + + + at line 263 + RedisArray|array|bool xrevrange(string $key, string $end, string $start, int $count = -1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key string $end string $start int $count + + + Return Value + + + + + + + + RedisArray|array|bool + + + + + + + + + + + + + at line 263 + RedisArray|int|false vadd(string $key, array $values, mixed $element, array|null $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key array $values mixed $element array|null $options + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false vsim(string $key, mixed $member, array|null $options = null) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $member array|null $options + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false vcard(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false vdim(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false vinfo(string $key) + + + + + + + No description + + + + Parameters + + + + + + + + string $key + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|bool vismember(string $key, mixed $member) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $member + + + Return Value + + + + + + + + RedisArray|bool + + + + + + + + + + + + + at line 263 + RedisArray|array|false vemb(string $key, mixed $member, bool $raw = false) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $member bool $raw + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|array|string|false vrandmember(string $key, int $count) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key int $count + + + Return Value + + + + + + + + RedisArray|array|string|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false vrange(string $key, string $min, string $max, int $count = -1) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + + + + + + string $key string $min string $max int $count + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false vrem(string $key, mixed $member) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + string $key mixed $member + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|int|false vsetattr(string $key, mixed $member, array|string $attributes) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $member array|string $attributes + + + Return Value + + + + + + + + RedisArray|int|false + + + + + + + + + + + + + at line 263 + RedisArray|array|string|false vgetattr(string $key, mixed $member, bool $decode = true) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $member bool $decode + + + Return Value + + + + + + + + RedisArray|array|string|false + + + + + + + + + + + + + at line 263 + RedisArray|array|false vlinks(string $key, mixed $member, bool $withscores = false) + + + + + + + No description + + + + Parameters + + + + + + + + + + + + + + + + + + string $key mixed $member bool $withscores + + + Return Value + + + + + + + + RedisArray|array|false + + + + + + + - - Details - - + - - at line 11 - mixed - __call(string $function_name, array $arguments) - + + + at line 263 + RedisArray|int|false xtrim(string $key, string $threshold, bool $approx = false, bool $minid = false, int $limit = -1) @@ -465,26 +16082,43 @@ Parameters - + - - + + + + + + + + + + + + + + + + + string $function_name $key array $arguments string $threshold bool $approx bool $minid int $limit - Return Value + Return Value - + + - + mixed RedisArray|int|false + @@ -493,11 +16127,10 @@ Return Value - - at line 13 - - __construct(string|array $name_or_hosts, array $options = NULL) - + + + at line 263 + RedisArray|int|float|false zAdd(string $key, array|float $score_or_options, mixed $more_scores_and_mems) @@ -512,18 +16145,34 @@ Parameters - - + + - - + + + + + + + string|array $name_or_hosts string $key array $options array|float $score_or_options mixed $more_scores_and_mems + Return Value + + + + + + + + RedisArray|int|float|false + + @@ -532,11 +16181,10 @@ Parameters - - at line 15 - bool|array - _continuum() - + + + at line 263 + RedisArray|int|false zCard(string $key) @@ -547,16 +16195,28 @@ - - Return Value + Parameters + + + + + + string $key + + + Return Value + + + - + bool|array RedisArray|int|false + @@ -565,11 +16225,10 @@ Return Value - - at line 17 - bool|callable - _distributor() - + + + at line 263 + RedisArray|int|false zCount(string $key, int|string $start, int|string $end) @@ -580,16 +16239,38 @@ - - Return Value + Parameters + + + + + + + + + + + + + + + + string $key int|string $start int|string $end + + + Return Value + + + - + bool|callable RedisArray|int|false + @@ -598,11 +16279,10 @@ Return Value - - at line 19 - bool|callable - _function() - + + + at line 263 + RedisArray|float|false zIncrBy(string $key, float $value, mixed $member) @@ -613,16 +16293,38 @@ - - Return Value + Parameters + + + + + + + + + + + + + + + + string $key float $value mixed $member + + + Return Value + + + - + bool|callable RedisArray|float|false + @@ -631,11 +16333,10 @@ Return Value - - at line 21 - bool|array - _hosts() - + + + at line 263 + RedisArray|int|false zLexCount(string $key, string $min, string $max) @@ -646,16 +16347,38 @@ - - Return Value + Parameters + + + + + + + + + + + + + + + + string $key string $min string $max + + + Return Value + + + - + bool|array RedisArray|int|false + @@ -664,11 +16387,10 @@ Return Value - - at line 23 - bool|null|Redis - _instance(string $host) - + + + at line 263 + RedisArray|array|false zMscore(string $key, mixed $member, mixed $other_members) @@ -684,21 +16406,33 @@ Parameters - + + + + + + + + + + + string $host $key mixed $member mixed $other_members - Return Value + Return Value - + + - + bool|null|Redis RedisArray|array|false + @@ -707,11 +16441,10 @@ Return Value - - at line 25 - bool|null - _rehash(callable $fn = NULL) - + + + at line 263 + RedisArray|array|false zPopMax(string $key, ?int $count = null) @@ -726,22 +16459,29 @@ Parameters - - + + + + + + + callable $fn string $key ?int $count - Return Value + Return Value - + + - + bool|null RedisArray|array|false + @@ -750,11 +16490,10 @@ Return Value - - at line 27 - bool|string|null - _target(string $key) - + + + at line 263 + RedisArray|array|false zPopMin(string $key, ?int $count = null) @@ -772,19 +16511,26 @@ Parameters string $key + + + ?int + $count + - Return Value + Return Value - + + - + bool|string|null RedisArray|array|false + @@ -793,11 +16539,10 @@ Return Value - - at line 29 - array - bgsave() - + + + at line 263 + RedisArray|array|false zRange(string $key, string|int $start, string|int $end, array|bool|null $options = null) @@ -808,16 +16553,43 @@ - - Return Value + Parameters + + + + + + + + + + + + + + + + + + + + + string $key string|int $start string|int $end array|bool|null $options + + + Return Value + + + - + array RedisArray|array|false + @@ -826,11 +16598,10 @@ Return Value - - at line 31 - bool|int - del(string|array $key, string ...$otherkeys) - + + + at line 263 + RedisArray|array|false zRangeByLex(string $key, string $min, string $max, int $offset = -1, int $count = -1) @@ -845,27 +16616,44 @@ Parameters - + - + + + + + + + + + + + + + + + + string|array string $key string ...$otherkeys $min string $max int $offset int $count - Return Value + Return Value - + + - + bool|int RedisArray|array|false + @@ -874,11 +16662,10 @@ Return Value - - at line 33 - bool|null - discard() - + + + at line 263 + RedisArray|array|false zRangeByScore(string $key, string $start, string $end, array $options = []) @@ -889,16 +16676,43 @@ - - Return Value + Parameters + + + + + + + + + + + + + + + + + + + + + string $key string $start string $end array $options + + + Return Value + + + - + bool|null RedisArray|array|false + @@ -907,11 +16721,10 @@ Return Value - - at line 35 - bool|null - exec() - + + + at line 263 + RedisArray|string|array zRandMember(string $key, ?array $options = null) @@ -922,16 +16735,33 @@ - - Return Value + Parameters + + + + + + + + + + + string $key ?array $options + + + Return Value + + + - + bool|null RedisArray|string|array + @@ -940,11 +16770,10 @@ Return Value - - at line 37 - bool|array - flushall() - + + + at line 263 + RedisArray|int|false zRank(string $key, mixed $member) @@ -955,16 +16784,33 @@ - - Return Value + Parameters + + + + + + + + + + + string $key mixed $member + + + Return Value + + + - + bool|array RedisArray|int|false + @@ -973,11 +16819,10 @@ Return Value - - at line 39 - bool|array - flushdb() - + + + at line 263 + RedisArray|int|false zRem(mixed $key, mixed $member, mixed $other_members) @@ -988,16 +16833,38 @@ - - Return Value + Parameters + + + + + + + + + + + + + + + + mixed $key mixed $member mixed $other_members + + + Return Value + + + - + bool|array RedisArray|int|false + @@ -1006,11 +16873,10 @@ Return Value - - at line 41 - bool|array - getOption(int $opt) - + + + at line 263 + RedisArray|int|false zRemRangeByLex(string $key, string $min, string $max) @@ -1025,22 +16891,34 @@ Parameters - - + + + + + + + + + + + + int $opt string $key string $min string $max - Return Value + Return Value - + + - + bool|array RedisArray|int|false + @@ -1049,11 +16927,10 @@ Return Value - - at line 43 - bool|array - hscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) - + + + at line 263 + RedisArray|int|false zRemRangeByRank(string $key, int $start, int $end) @@ -1073,32 +16950,29 @@ Parameters - int|null - $iterator - - - - string|null - $pattern + int + $start int - $count + $end - Return Value + Return Value - + + - + bool|array RedisArray|int|false + @@ -1107,11 +16981,10 @@ Return Value - - at line 45 - bool|array - info() - + + + at line 263 + RedisArray|int|false zRemRangeByScore(string $key, string $start, string $end) @@ -1122,16 +16995,38 @@ - - Return Value + Parameters + + + + + + + + + + + + + + + + string $key string $start string $end + + + Return Value + + + - + bool|array RedisArray|int|false + @@ -1140,11 +17035,10 @@ Return Value - - at line 47 - bool|array - keys(string $pattern) - + + + at line 263 + RedisArray|array|false zRevRange(string $key, int $start, int $end, mixed $scores = null) @@ -1160,21 +17054,38 @@ Parameters - + + + + + + + + + + + + + + + + string $pattern $key int $start int $end mixed $scores - Return Value + Return Value - + + - + bool|array RedisArray|array|false + @@ -1183,11 +17094,10 @@ Return Value - - at line 49 - bool|array - mget(array $keys) - + + + at line 263 + RedisArray|array|false zRevRangeByLex(string $key, string $max, string $min, int $offset = -1, int $count = -1) @@ -1202,22 +17112,44 @@ Parameters - - + + + + + + + + + + + + + + + + + + + + + + array $keys string $key string $max string $min int $offset int $count - Return Value + Return Value - + + - + bool|array RedisArray|array|false + @@ -1226,11 +17158,10 @@ Return Value - - at line 51 - bool - mset(array $pairs) - + + + at line 263 + RedisArray|array|false zRevRangeByScore(string $key, string $max, string $min, array|bool $options = []) @@ -1245,22 +17176,39 @@ Parameters - - + + + + + + + + + + + + + + + + + array $pairs string $key string $max string $min array|bool $options - Return Value + Return Value - + + - + bool RedisArray|array|false + @@ -1269,11 +17217,10 @@ Return Value - - at line 53 - bool|RedisArray - multi(string $host, int $mode = NULL) - + + + at line 263 + RedisArray|int|false zRevRank(string $key, mixed $member) @@ -1289,26 +17236,28 @@ Parameters - + - - + + string $host $key int $mode mixed $member - Return Value + Return Value - + + - + bool|RedisArray RedisArray|int|false + @@ -1317,11 +17266,10 @@ Return Value - - at line 55 - bool|array - ping() - + + + at line 263 + RedisArray|float|false zScore(string $key, mixed $member) @@ -1332,16 +17280,33 @@ - - Return Value + Parameters + + + + + + + + + + + string $key mixed $member + + + Return Value + + + - + bool|array RedisArray|float|false + @@ -1350,11 +17315,10 @@ Return Value - - at line 57 - bool|array - save() - + + + at line 263 + RedisArray|array|false zdiff(array $keys, ?array $options = null) @@ -1365,16 +17329,33 @@ - - Return Value + Parameters + + + + + + + + + + + array $keys ?array $options + + + Return Value + + + - + bool|array RedisArray|array|false + @@ -1383,11 +17364,10 @@ Return Value - - at line 59 - bool|array - scan(int|null $iterator, string $node, string|null $pattern = null, int $count = 0) - + + + at line 263 + RedisArray|int|false zdiffstore(string $dst, array $keys) @@ -1402,37 +17382,29 @@ Parameters - - - - - - - - - - - + - - + + int|null $iterator string $node string|null $pattern $dst int $count array $keys - Return Value + Return Value - + + - + bool|array RedisArray|int|false + @@ -1441,11 +17413,10 @@ Return Value - - at line 61 - bool|array - select(int $index) - + + + at line 263 + RedisArray|array|false zinter(array $keys, ?array $weights = null, ?array $options = null) @@ -1460,22 +17431,34 @@ Parameters - - + + + + + + + + + + + + int $index array $keys ?array $weights ?array $options - Return Value + Return Value - + + - + bool|array RedisArray|array|false + @@ -1484,11 +17467,10 @@ Return Value - - at line 63 - bool|array - setOption(int $opt, string $value) - + + + at line 263 + RedisArray|int|false zintercard(array $keys, int $limit = -1) @@ -1503,27 +17485,29 @@ Parameters - - + + - - + + int $opt array $keys string $value int $limit - Return Value + Return Value - + + - + bool|array RedisArray|int|false + @@ -1532,11 +17516,10 @@ Return Value - - at line 65 - bool|array - sscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) - + + + at line 263 + RedisArray|int|false zinterstore(string $dst, array $keys, ?array $weights = null, ?string $aggregate = null) @@ -1552,36 +17535,38 @@ Parameters - + - - + + - - + + - - + + string $key $dst int|null $iterator array $keys string|null $pattern ?array $weights int $count ?string $aggregate - Return Value + Return Value - + + - + bool|array RedisArray|int|false + @@ -1590,11 +17575,10 @@ Return Value - - at line 67 - bool|int - unlink(string|array $key, string ...$otherkeys) - + + + at line 263 + RedisArray|array|false zunion(array $keys, ?array $weights = null, ?array $options = null) @@ -1609,27 +17593,34 @@ Parameters - - + + - - + + + + + + + string|array $key array $keys string ...$otherkeys ?array $weights ?array $options - Return Value + Return Value - + + - + bool|int RedisArray|array|false + @@ -1638,11 +17629,10 @@ Return Value - - at line 69 - bool|null - unwatch() - + + + at line 263 + RedisArray|int|false zunionstore(string $dst, array $keys, ?array $weights = null, ?string $aggregate = null) @@ -1653,16 +17643,43 @@ - - Return Value + Parameters + + + + + + + + + + + + + + + + + + + + + string $dst array $keys ?array $weights ?string $aggregate + + + Return Value + + + - + bool|null RedisArray|int|false + @@ -1671,11 +17688,10 @@ Return Value - - at line 71 - bool|array - zscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) - + + + at line 263 + RedisArray|string|false digest(string $key) @@ -1693,34 +17709,21 @@ Parameters string $key - - - int|null - $iterator - - - - string|null - $pattern - - - - int - $count - - Return Value + Return Value - + + - + bool|array RedisArray|string|false + diff --git a/docs/RedisCluster.html b/docs/RedisCluster.html index 4e9fb9fa9e..3187136751 100644 --- a/docs/RedisCluster.html +++ b/docs/RedisCluster.html @@ -5,7 +5,7 @@ RedisCluster | PhpRedis API - + @@ -16,11 +16,400 @@ + + + + + title="PhpRedis API (develop)" /> @@ -83,7 +472,7 @@ RedisCluster class - RedisCluster (View source) + RedisCluster (View source) @@ -92,6 +481,56 @@ RedisCluster + Constants + + + + + + + + + + + + + + + + + + + + + + OPT_SLAVE_FAILOVER + + Used to configure how PhpRedis will failover to replica nodes when a +primary node fails to respond. + + + FAILOVER_NONE + + Never read from replicas. + + + FAILOVER_ERROR + + Attempt to read from replicas when the primary errors out or is down. + + + FAILOVER_DISTRIBUTE + + Distribute readonly commands at random between the primary and +replica(s). + + + FAILOVER_DISTRIBUTE_SLAVES + + Distribute readonly commands between the replicas only. + + + Methods @@ -102,7 +541,7 @@ Methods - __construct(string|null $name, array $seeds = NULL, int|float $timeout = 0, int|float $read_timeout = 0, bool $persistent = false, mixed $auth = NULL, array $context = NULL) + __construct(string|null $name, array|null $seeds = null, int|float $timeout = 0, int|float $read_timeout = 0, bool $persistent = false, mixed $auth = null, array|null $context = null) No description @@ -115,8 +554,7 @@ Methods _compress(string $value) - No description - + {\Redis::_compress()} @@ -164,6 +602,17 @@ Methods + + string + + + _digest(mixed $value) + + No description + + + + mixed @@ -241,6 +690,28 @@ Methods + + RedisCluster|int|false + + + wait(string|array $key_or_address, int $numreplicas, int $timeout) + + No description + + + + + + RedisCluster|array|false + + + waitaof(string|array $key_or_address, int $numlocal, int $numreplicas, int $timeout) + + No description + + + + RedisCluster|bool @@ -290,7 +761,8 @@ Methods blpop(string|array $key, string|float|int $timeout_or_key, mixed ...$extra_args) - See Redis::blpop() + No description + @@ -300,7 +772,8 @@ Methods brpop(string|array $key, string|float|int $timeout_or_key, mixed ...$extra_args) - See Redis::brpop() + No description + @@ -310,7 +783,28 @@ Methods brpoplpush(string $srckey, string $deskey, int $timeout) - See Redis::brpoplpush() + No description + + + + + + RedisCluster|string|false + + + lmove(string $src, string $dst, string $wherefrom, string $whereto) + + Move an element from one list into another. + + + + + RedisCluster|string|false + + + blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout) + + Move an element from one list to another, blocking up to a timeout until an element is available. @@ -395,7 +889,7 @@ Methods array|string|bool - client(string|array $key_or_address, string $subcommand, string|null $arg = NULL) + client(string|array $key_or_address, string $subcommand, string|null $arg = null) No description @@ -457,6 +951,17 @@ Methods + + RedisCluster|bool + + + copy(string $src, string $dst, array|null $options = null) + + No description + + + + RedisCluster|int|false @@ -499,6 +1004,27 @@ Methods No description + + + + RedisCluster|int|false + + + delex(string $key, array|null $options = null) + + Delete a key conditionally based on its value or hash digest + + + + + RedisCluster|int|false + + + delifeq(string $key, mixed $value) + + Delete a key if it's equal to the specified value. This command is +specific to Valkey >= 9.0 + @@ -615,7 +1141,7 @@ Methods RedisCluster|bool - expire(string $key, int $timeout, string|null $mode = NULL) + expire(string $key, int $timeout, string|null $mode = null) No description @@ -626,7 +1152,7 @@ Methods RedisCluster|bool - expireat(string $key, int $timestamp, string|null $mode = NULL) + expireat(string $key, int $timestamp, string|null $mode = null) No description @@ -766,10 +1292,10 @@ Methods - mixed + RedisCluster|array - get(string $key) + geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = []) No description @@ -777,10 +1303,10 @@ Methods - RedisCluster|int|false + RedisCluster|array|int|false - getbit(string $key, int $value) + geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = []) No description @@ -788,10 +1314,10 @@ Methods - string|null + mixed - getlasterror() + get(string $key) No description @@ -799,10 +1325,10 @@ Methods - int + mixed - getmode() + getdel(string $key) No description @@ -810,10 +1336,10 @@ Methods - mixed + RedisCluster|array|false - getoption(int $option) + getWithMeta(string $key) No description @@ -824,7 +1350,7 @@ Methods RedisCluster|string|false - getrange(string $key, int $start, int $end) + getex(string $key, array $options = []) No description @@ -832,10 +1358,10 @@ Methods - RedisCluster|string|array|int|false + RedisCluster|int|false - lcs(string $key1, string $key2, array|null $options = NULL) + getbit(string $key, int $value) No description @@ -843,10 +1369,10 @@ Methods - RedisCluster|string|bool + string|null - getset(string $key, mixed $value) + getlasterror() No description @@ -854,10 +1380,10 @@ Methods - int|false + int - gettransferredbytes() + getmode() No description @@ -865,10 +1391,10 @@ Methods - RedisCluster|int|false + mixed - hdel(string $key, string $member, string ...$other_members) + getoption(int $option) No description @@ -876,10 +1402,10 @@ Methods - RedisCluster|bool + RedisCluster|string|false - hexists(string $key, string $member) + getrange(string $key, int $start, int $end) No description @@ -887,10 +1413,10 @@ Methods - mixed + RedisCluster|string|array|int|false - hget(string $key, string $member) + lcs(string $key1, string $key2, array|null $options = null) No description @@ -898,10 +1424,10 @@ Methods - RedisCluster|array|false + RedisCluster|string|bool - hgetall(string $key) + getset(string $key, mixed $value) No description @@ -909,10 +1435,10 @@ Methods - RedisCluster|int|false + array|false - hincrby(string $key, string $member, int $value) + gettransferredbytes() No description @@ -920,10 +1446,10 @@ Methods - RedisCluster|float|false + void - hincrbyfloat(string $key, string $member, float $value) + cleartransferredbytes() No description @@ -931,10 +1457,10 @@ Methods - RedisCluster|array|false + RedisCluster|int|false - hkeys(string $key) + hdel(string $key, string $member, string ...$other_members) No description @@ -942,10 +1468,10 @@ Methods - RedisCluster|int|false + RedisCluster|bool - hlen(string $key) + hexists(string $key, string $member) No description @@ -953,10 +1479,10 @@ Methods - RedisCluster|array|false + mixed - hmget(string $key, array $keys) + hget(string $key, string $member) No description @@ -964,10 +1490,10 @@ Methods - RedisCluster|bool + RedisCluster|array|false - hmset(string $key, array $key_values) + hgetall(string $key) No description @@ -975,10 +1501,10 @@ Methods - array|bool + mixed - hscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) + hgetWithMeta(string $key, string $member) No description @@ -989,7 +1515,7 @@ Methods RedisCluster|int|false - hset(string $key, string $member, mixed $value) + hincrby(string $key, string $member, int $value) No description @@ -997,10 +1523,10 @@ Methods - RedisCluster|bool + RedisCluster|float|false - hsetnx(string $key, string $member, mixed $value) + hincrbyfloat(string $key, string $member, float $value) No description @@ -1008,10 +1534,10 @@ Methods - RedisCluster|int|false + RedisCluster|array|false - hstrlen(string $key, string $field) + hkeys(string $key) No description @@ -1019,10 +1545,10 @@ Methods - RedisCluster|array|false + RedisCluster|int|false - hvals(string $key) + hlen(string $key) No description @@ -1030,10 +1556,10 @@ Methods - RedisCluster|int|false + RedisCluster|array|false - incr(string $key, int $by = 1) + hmget(string $key, array $keys) No description @@ -1041,10 +1567,10 @@ Methods - RedisCluster|int|false + RedisCluster|array|false - incrby(string $key, int $value) + hgetex(string $key, array $fields, string|array|null $expiry = null) No description @@ -1052,10 +1578,10 @@ Methods - RedisCluster|float|false + RedisCluster|int|false - incrbyfloat(string $key, float $value) + hsetex(string $key, array $fields, array|null $expiry = null) No description @@ -1066,20 +1592,18 @@ Methods RedisCluster|array|false - info(string|array $key_or_address, string ...$sections) + hgetdel(string $key, array $fields) - Retrieve information about the connected redis-server. If no arguments are passed to -this function, redis will return every info field. Alternatively you may pass a specific -section you want returned (e.g. 'server', or 'memory') to receive only information pertaining -to that section. + No description + - RedisCluster|array|false + RedisCluster|bool - keys(string $pattern) + hmset(string $key, array $key_values) No description @@ -1087,10 +1611,10 @@ Methods - RedisCluster|int|false + array|bool - lastsave(string|array $key_or_address) + hscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0) No description @@ -1098,10 +1622,10 @@ Methods - RedisCluster|string|bool + RedisCluster|int|false - lget(string $key, int $index) + expiremember(string $key, string $field, int $ttl, string|null $unit = null) No description @@ -1109,10 +1633,10 @@ Methods - mixed + RedisCluster|int|false - lindex(string $key, int $index) + expirememberat(string $key, string $field, int $timestamp) No description @@ -1120,10 +1644,10 @@ Methods - RedisCluster|int|false + RedisCluster|string|array - linsert(string $key, string $pos, mixed $pivot, mixed $value) + hrandfield(string $key, array|null $options = null) No description @@ -1131,10 +1655,10 @@ Methods - RedisCluster|int|bool + RedisCluster|int|false - llen(string $key) + hset(string $key, string $member, mixed $value) No description @@ -1142,10 +1666,10 @@ Methods - RedisCluster|bool|string|array + RedisCluster|bool - lpop(string $key, int $count = 0) + hsetnx(string $key, string $member, mixed $value) No description @@ -1153,10 +1677,10 @@ Methods - RedisCluster|int|bool + RedisCluster|int|false - lpush(string $key, mixed $value, mixed ...$other_values) + hstrlen(string $key, string $field) No description @@ -1164,10 +1688,10 @@ Methods - RedisCluster|int|bool + RedisCluster|array|false - lpushx(string $key, mixed $value) + hexpire(string $key, int $ttl, array $fields, string|null $mode = NULL) No description @@ -1178,7 +1702,7 @@ Methods RedisCluster|array|false - lrange(string $key, int $start, int $end) + hpexpire(string $key, int $ttl, array $fields, string|null $mode = NULL) No description @@ -1186,10 +1710,10 @@ Methods - RedisCluster|int|bool + RedisCluster|array|false - lrem(string $key, mixed $value, int $count = 0) + hexpireat(string $key, int $time, array $fields, string|null $mode = NULL) No description @@ -1197,10 +1721,10 @@ Methods - RedisCluster|bool + RedisCluster|array|false - lset(string $key, int $index, mixed $value) + hpexpireat(string $key, int $mstime, array $fields, string|null $mode = NULL) No description @@ -1208,10 +1732,10 @@ Methods - RedisCluster|bool + RedisCluster|array|false - ltrim(string $key, int $start, int $end) + httl(string $key, array $fields) No description @@ -1222,7 +1746,7 @@ Methods RedisCluster|array|false - mget(array $keys) + hpttl(string $key, array $fields) No description @@ -1230,10 +1754,10 @@ Methods - RedisCluster|bool + RedisCluster|array|false - mset(array $key_values) + hexpiretime(string $key, array $fields) No description @@ -1244,7 +1768,7 @@ Methods RedisCluster|array|false - msetnx(array $key_values) + hpexpiretime(string $key, array $fields) No description @@ -1252,10 +1776,10 @@ Methods - RedisCluster|bool + RedisCluster|array|false - multi(int $value = Redis::MULTI) + hpersist(string $key, array $fields) No description @@ -1263,10 +1787,10 @@ Methods - RedisCluster|int|string|false + RedisCluster|array|false - object(string $subcommand, string $key) + hvals(string $key) No description @@ -1274,10 +1798,10 @@ Methods - RedisCluster|bool + RedisCluster|int|false - persist(string $key) + incr(string $key, int $by = 1) No description @@ -1285,10 +1809,10 @@ Methods - RedisCluster|bool + RedisCluster|int|false - pexpire(string $key, int $timeout, string|null $mode = NULL) + incrby(string $key, int $value) No description @@ -1296,10 +1820,10 @@ Methods - RedisCluster|bool + RedisCluster|float|false - pexpireat(string $key, int $timestamp, string|null $mode = NULL) + incrbyfloat(string $key, float $value) No description @@ -1307,10 +1831,23 @@ Methods - RedisCluster|bool + RedisCluster|array|false - pfadd(string $key, array $elements) + info(string|array $key_or_address, string ...$sections) + + Retrieve information about the connected redis-server. If no arguments are passed to +this function, redis will return every info field. Alternatively you may pass a specific +section you want returned (e.g. 'server', or 'memory') to receive only information pertaining +to that section. + + + + + RedisCluster|array|false + + + keys(string $pattern) No description @@ -1321,7 +1858,7 @@ Methods RedisCluster|int|false - pfcount(string $key) + lastsave(string|array $key_or_address) No description @@ -1329,10 +1866,10 @@ Methods - RedisCluster|bool + RedisCluster|string|bool - pfmerge(string $key, array $keys) + lget(string $key, int $index) No description @@ -1343,17 +1880,18 @@ Methods mixed - ping(string|array $key_or_address, string|null $message = NULL) + lindex(string $key, int $index) - PING an instance in the redis cluster. + No description +

- RedisCluster|bool + RedisCluster|int|false - psetex(string $key, int $timeout, string $value) + linsert(string $key, string $pos, mixed $pivot, mixed $value) No description @@ -1361,10 +1899,10 @@ Methods - void + RedisCluster|int|bool - psubscribe(array $patterns, callable $callback) + llen(string $key) No description @@ -1372,10 +1910,10 @@ Methods - RedisCluster|int|false + RedisCluster|bool|string|array - pttl(string $key) + lpop(string $key, int $count = 0) No description @@ -1383,10 +1921,10 @@ Methods - RedisCluster|bool + RedisCluster|null|bool|int|array - publish(string $channel, string $message) + lpos(string $key, mixed $value, array|null $options = null) No description @@ -1394,10 +1932,10 @@ Methods - mixed + RedisCluster|int|bool - pubsub(string|array $key_or_address, string ...$values) + lpush(string $key, mixed $value, mixed ...$other_values) No description @@ -1405,10 +1943,10 @@ Methods - bool|array + RedisCluster|int|bool - punsubscribe(string $pattern, string ...$other_patterns) + lpushx(string $key, mixed $value) No description @@ -1416,10 +1954,10 @@ Methods - RedisCluster|bool|string + RedisCluster|array|false - randomkey(string|array $key_or_address) + lrange(string $key, int $start, int $end) No description @@ -1427,10 +1965,10 @@ Methods - mixed + RedisCluster|int|bool - rawcommand(string|array $key_or_address, string $command, mixed ...$args) + lrem(string $key, mixed $value, int $count = 0) No description @@ -1441,7 +1979,7 @@ Methods RedisCluster|bool - rename(string $key_src, string $key_dst) + lset(string $key, int $index, mixed $value) No description @@ -1452,7 +1990,7 @@ Methods RedisCluster|bool

- renamenx(string $key, string $newkey) + ltrim(string $key, int $start, int $end) No description @@ -1460,10 +1998,10 @@ Methods

- RedisCluster|bool + RedisCluster|array|false - restore(string $key, int $timeout, string $value, array|null $options = NULL) + mget(array $keys) No description @@ -1471,10 +2009,10 @@ Methods - mixed + RedisCluster|bool - role(string|array $key_or_address) + mset(array $key_values) No description @@ -1482,10 +2020,10 @@ Methods - RedisCluster|bool|string|array + RedisCluster|array|false - rpop(string $key, int $count = 0) + msetnx(array $key_values) No description @@ -1493,10 +2031,10 @@ Methods - RedisCluster|bool|string + Redis|int|false - rpoplpush(string $src, string $dst) + msetex(array $key_vals, int|float|array|null $expiry = null) No description @@ -1504,10 +2042,10 @@ Methods - RedisCluster|int|false + RedisCluster|bool - rpush(string $key, mixed ...$elements) + multi(int $value = Redis::MULTI) No description @@ -1515,10 +2053,10 @@ Methods - RedisCluster|bool|int + RedisCluster|int|string|false - rpushx(string $key, string $value) + object(string $subcommand, string $key) No description @@ -1526,10 +2064,10 @@ Methods - RedisCluster|int|false + RedisCluster|bool - sadd(string $key, mixed $value, mixed ...$other_values) + persist(string $key) No description @@ -1537,10 +2075,10 @@ Methods - RedisCluster|bool|int + RedisCluster|bool - saddarray(string $key, array $values) + pexpire(string $key, int $timeout, string|null $mode = null) No description @@ -1551,7 +2089,7 @@ Methods RedisCluster|bool - save(string|array $key_or_address) + pexpireat(string $key, int $timestamp, string|null $mode = null) No description @@ -1559,10 +2097,10 @@ Methods

- mixed + RedisCluster|bool - script(string|array $key_or_address, mixed ...$args) + pfmerge(string $key, array $keys) No description @@ -1592,21 +2130,20 @@ Methods - RedisCluster|array|false + mixed - sdiff(string $key, string ...$other_keys) + ping(string|array $key_or_address, string|null $message = null) - No description - + PING an instance in the redis cluster.

- RedisCluster|int|false + RedisCluster|bool - sdiffstore(string $dst, string $key, string ...$other_keys) + psetex(string $key, int $timeout, string $value) No description @@ -1614,10 +2151,10 @@ Methods - RedisCluster|string|bool + void - set(string $key, mixed $value, mixed $options = NULL) + psubscribe(array $patterns, callable $callback) No description @@ -1628,7 +2165,7 @@ Methods RedisCluster|int|false - setbit(string $key, int $offset, bool $onoff) + pttl(string $key) No description @@ -1636,10 +2173,10 @@ Methods

- RedisCluster|bool + RedisCluster|bool|int - setex(string $key, int $expire, mixed $value) + publish(string $channel, string $message) No description @@ -1647,10 +2184,10 @@ Methods - RedisCluster|bool + mixed - setnx(string $key, mixed $value) + pubsub(string|array $key_or_address, string ...$values) No description @@ -1658,10 +2195,10 @@ Methods - bool + bool|array - setoption(int $option, mixed $value) + punsubscribe(string $pattern, string ...$other_patterns) No description @@ -1669,10 +2206,10 @@ Methods - RedisCluster|int|false + RedisCluster|bool|string - setrange(string $key, int $offset, string $value) + randomkey(string|array $key_or_address) No description @@ -1680,10 +2217,10 @@ Methods - RedisCluster|array|false + mixed - sinter(array|string $key, string ...$other_keys) + rawcommand(string|array $key_or_address, string $command, mixed ...$args) No description @@ -1691,10 +2228,10 @@ Methods - RedisCluster|int|false + RedisCluster|bool - sintercard(array $keys, int $limit = -1) + rename(string $key_src, string $key_dst) No description @@ -1702,10 +2239,10 @@ Methods - RedisCluster|int|false + RedisCluster|bool - sinterstore(array|string $key, string ...$other_keys) + renamenx(string $key, string $newkey) No description @@ -1716,7 +2253,7 @@ Methods RedisCluster|bool - sismember(string $key, mixed $value) + restore(string $key, int $timeout, string $value, array|null $options = null) No description @@ -1727,7 +2264,7 @@ Methods mixed

- slowlog(string|array $key_or_address, mixed ...$args) + role(string|array $key_or_address) No description @@ -1735,10 +2272,10 @@ Methods

- void + mixed - subscribe(array $channels, callable $cb) + script(string|array $key_or_address, mixed ...$args) No description @@ -1845,10 +2382,10 @@ Methods - RedisCluster|bool|array + RedisCluster|array|false - sunion(string $key, string ...$other_keys) + sdiff(string $key, string ...$other_keys) No description @@ -1859,7 +2396,7 @@ Methods RedisCluster|int|false - sunionstore(string $dst, string $key, string ...$other_keys) + sdiffstore(string $dst, string $key, string ...$other_keys) No description @@ -1867,10 +2404,10 @@ Methods

- RedisCluster|int|false + RedisCluster|bool - type(string $key) + setex(string $key, int $expire, mixed $value) No description @@ -1900,10 +2437,10 @@ Methods - bool|array + RedisCluster|bool - unsubscribe(array $channels) + setnx(string $key, mixed $value) No description @@ -1911,10 +2448,10 @@ Methods - RedisCluster|int|false + bool - unlink(array|string $key, string ...$other_keys) + setoption(int $option, mixed $value) No description @@ -1922,10 +2459,10 @@ Methods - bool + RedisCluster|int|false - unwatch() + setrange(string $key, int $offset, string $value) No description @@ -1933,10 +2470,10 @@ Methods - RedisCluster|bool + RedisCluster|array|false - watch(string $key, string ...$other_keys) + sinter(array|string $key, string ...$other_keys) No description @@ -1947,7 +2484,7 @@ Methods RedisCluster|int|false - xack(string $key, string $group, array $ids) + sintercard(array $keys, int $limit = -1) No description @@ -1955,10 +2492,10 @@ Methods

- RedisCluster|string|false + RedisCluster|int|false - xadd(string $key, string $id, array $values, int $maxlen = 0, bool $approx = false) + sinterstore(array|string $key, string ...$other_keys) No description @@ -1966,10 +2503,10 @@ Methods - RedisCluster|string|array|false + RedisCluster|bool - xclaim(string $key, string $group, string $consumer, int $min_iddle, array $ids, array $options) + sismember(string $key, mixed $value) No description @@ -1977,10 +2514,10 @@ Methods - RedisCluster|int|false + RedisCluster|array|false - xdel(string $key, array $ids) + smismember(string $key, string $member, string ...$other_members) No description @@ -1991,7 +2528,7 @@ Methods mixed - xgroup(string $operation, string $key = null, string $group = null, string $id_or_consumer = null, bool $mkstream = false, int $entries_read = -2) + slowlog(string|array $key_or_address, mixed ...$args) No description @@ -1999,10 +2536,10 @@ Methods

- Redis|bool|array + RedisCluster|array|false - xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = -1, bool $justid = false) + smembers(string $key) No description @@ -2010,10 +2547,10 @@ Methods - mixed + RedisCluster|bool - xinfo(string $operation, string|null $arg1 = null, string|null $arg2 = null, int $count = -1) + smove(string $src, string $dst, string $member) No description @@ -2021,10 +2558,10 @@ Methods - RedisCluster|int|false + RedisCluster|array|bool|int|string - xlen(string $key) + sort(string $key, array|null $options = null) No description @@ -2032,10 +2569,10 @@ Methods - RedisCluster|array|false + RedisCluster|array|bool|int|string - xpending(string $key, string $group, string|null $start = null, string|null $end = null, int $count = -1, string|null $consumer = null) + sort_ro(string $key, array|null $options = null) No description @@ -2043,10 +2580,10 @@ Methods - RedisCluster|bool|array + RedisCluster|string|array|false - xrange(string $key, string $start, string $end, int $count = -1) + spop(string $key, int $count = 0) No description @@ -2054,10 +2591,10 @@ Methods - RedisCluster|bool|array + RedisCluster|string|array|false - xread(array $streams, int $count = -1, int $block = -1) + srandmember(string $key, int $count = 0) No description @@ -2065,10 +2602,10 @@ Methods - RedisCluster|bool|array + RedisCluster|int|false - xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1) + srem(string $key, mixed $value, mixed ...$other_values) No description @@ -2076,10 +2613,10 @@ Methods - RedisCluster|bool|array + array|false - xrevrange(string $key, string $start, string $end, int $count = -1) + sscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0) No description @@ -2090,7 +2627,7 @@ Methods RedisCluster|int|false - xtrim(string $key, int $maxlen, bool $approx = false, bool $minid = false, int $limit = -1) + strlen(string $key) No description @@ -2098,10 +2635,10 @@ Methods

- RedisCluster|int|false + void - zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems) + subscribe(array $channels, callable $cb) No description @@ -2109,10 +2646,10 @@ Methods - RedisCluster|int|false + RedisCluster|bool|array - zcard(string $key) + sunion(string $key, string ...$other_keys) No description @@ -2123,7 +2660,7 @@ Methods RedisCluster|int|false - zcount(string $key, string $start, string $end) + sunionstore(string $dst, string $key, string ...$other_keys) No description @@ -2131,10 +2668,10 @@ Methods

- zintercard(array $keys, int $limit = -1) + type(string $key) + + No description + + +

- - at line 43 - array|bool|RedisSentinel - slaves(string $master) - + + + at line 43 + array|bool|RedisSentinel slaves(string $master) @@ -721,15 +1083,17 @@ Parameters - Return Value + Return Value - + + array|bool|RedisSentinel + diff --git a/docs/[Global_Namespace].html b/docs/[Global_Namespace].html index b30c8eb2e2..1993f6549a 100644 --- a/docs/[Global_Namespace].html +++ b/docs/[Global_Namespace].html @@ -5,7 +5,7 @@ [Global Namespace] | PhpRedis API - + @@ -16,11 +16,400 @@ + + + + + title="PhpRedis API (develop)" /> diff --git a/docs/classes.html b/docs/classes.html index f281726e73..99aeb1151b 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -5,7 +5,7 @@ All Classes | PhpRedis API - + @@ -16,11 +16,400 @@ + + + + + title="PhpRedis API (develop)" /> diff --git a/docs/css/highlight-github.min.css b/docs/css/highlight-github.min.css new file mode 100644 index 0000000000..7a9730c0dc --- /dev/null +++ b/docs/css/highlight-github.min.css @@ -0,0 +1,10 @@ +pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*! + Theme: GitHub + Description: Light theme as seen on github.com + Author: github.com + Maintainer: @Hirse + Updated: 2021-05-15 + + Outdated base version: https://github.com/primer/github-syntax-light + Current colors taken from GitHub's CSS +*/.hljs{color:#24292e;background:#fff}.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-template-tag,.hljs-template-variable,.hljs-type,.hljs-variable.language_{color:#d73a49}.hljs-title,.hljs-title.class_,.hljs-title.class_.inherited__,.hljs-title.function_{color:#6f42c1}.hljs-attr,.hljs-attribute,.hljs-literal,.hljs-meta,.hljs-number,.hljs-operator,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-id,.hljs-variable{color:#005cc5}.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#22863a}.hljs-built_in,.hljs-symbol{color:#e36209}.hljs-code,.hljs-comment,.hljs-formula{color:#6a737d}.hljs-name,.hljs-quote,.hljs-selector-pseudo,.hljs-selector-tag{color:#22863a}.hljs-subst{color:#24292e}.hljs-section{color:#005cc5;font-weight:700}.hljs-bullet{color:#735c0f}.hljs-emphasis{color:#24292e;font-style:italic}.hljs-strong{color:#24292e;font-weight:700}.hljs-addition{color:#22863a;background-color:#f0fff4}.hljs-deletion{color:#b31d28;background-color:#ffeef0} diff --git a/docs/doc-index.html b/docs/doc-index.html index e475ef25be..905a5b9b56 100644 --- a/docs/doc-index.html +++ b/docs/doc-index.html @@ -5,7 +5,7 @@ Index | PhpRedis API - + @@ -16,11 +16,400 @@ + + + + + title="PhpRedis API (develop)" /> @@ -102,7 +491,7 @@ Index S T U - V + V W X Y @@ -112,11 +501,17 @@ Index A Redis::acl() — Method in class Redis - + Execute Redis ACL subcommands. Redis::append() — Method in class Redis Append data to a Redis STRING key. Redis::auth() — Method in class Redis - Authenticate a Redis connection after its been established. + Authenticate a Redis connection after its been established. +RedisArray::acl() — Method in class RedisArray + +RedisArray::append() — Method in class RedisArray + +RedisArray::auth() — Method in class RedisArray + RedisCluster::acl() — Method in class RedisCluster RedisCluster::append() — Method in class RedisCluster @@ -151,8 +546,34 @@ A when no elements are available. Redis::blmpop() — Method in class Redis Pop one or more elements from one or more Redis LISTs, blocking up to a specified timeout when -no elements are available. +no elements are available. +Redis::blmove() — Method in class Redis + RedisArray::bgsave() — Method in class RedisArray + +RedisArray::bgrewriteaof() — Method in class RedisArray + +RedisArray::bitcount() — Method in class RedisArray + +RedisArray::bitop() — Method in class RedisArray + +RedisArray::bitpos() — Method in class RedisArray + +RedisArray::blPop() — Method in class RedisArray + +RedisArray::brPop() — Method in class RedisArray + +RedisArray::brpoplpush() — Method in class RedisArray + +RedisArray::bzPopMax() — Method in class RedisArray + +RedisArray::bzPopMin() — Method in class RedisArray + +RedisArray::bzmpop() — Method in class RedisArray + +RedisArray::blmpop() — Method in class RedisArray + +RedisArray::blmove() — Method in class RedisArray RedisCluster::bgrewriteaof() — Method in class RedisCluster @@ -165,11 +586,13 @@ A RedisCluster::bitpos() — Method in class RedisCluster Return the position of the first bit set to 0 or 1 in a string. RedisCluster::blpop() — Method in class RedisCluster - See Redis::blpop() + RedisCluster::brpop() — Method in class RedisCluster - See Redis::brpop() + RedisCluster::brpoplpush() — Method in class RedisCluster - See Redis::brpoplpush() + +RedisCluster::blmove() — Method in class RedisCluster + Move an element from one list to another, blocking up to a timeout until an element is available. RedisCluster::bzpopmax() — Method in class RedisCluster RedisCluster::bzpopmin() — Method in class RedisCluster @@ -182,17 +605,33 @@ A Redis::clearLastError() — Method in class Redis Reset any last error on the connection to NULL Redis::client() — Method in class Redis - + Execute Redis CLIENT subcommands. Redis::close() — Method in class Redis - + Closes the connection to Redis Redis::command() — Method in class Redis - + Execute Redis COMMAND subcommands. Redis::config() — Method in class Redis Execute the Redis CONFIG command in a variety of ways. Redis::connect() — Method in class Redis - + Connect to a Redis server Redis::copy() — Method in class Redis - Make a copy of a key. + Make a copy of a key. +Redis::clearTransferredBytes() — Method in class Redis + Reset the number of bytes sent and received on the socket. +RedisArray::clearLastError() — Method in class RedisArray + +RedisArray::client() — Method in class RedisArray + +RedisArray::close() — Method in class RedisArray + +RedisArray::command() — Method in class RedisArray + +RedisArray::config() — Method in class RedisArray + +RedisArray::copy() — Method in class RedisArray + +RedisArray::clearTransferredBytes() — Method in class RedisArray + RedisCluster::clearlasterror() — Method in class RedisCluster RedisCluster::client() — Method in class RedisCluster @@ -204,6 +643,10 @@ A RedisCluster::command() — Method in class RedisCluster RedisCluster::config() — Method in class RedisCluster + +RedisCluster::copy() — Method in class RedisCluster + +RedisCluster::cleartransferredbytes() — Method in class RedisCluster RedisSentinel::ckquorum() — Method in class RedisSentinel D @@ -211,22 +654,49 @@ A Redis::dbSize() — Method in class Redis Return the number of keys in the currently selected Redis database. Redis::debug() — Method in class Redis - + Execute the Redis DEBUG command. Note that this is disabled by default +and can be very dangerous, even allowing you to crash the server. Use +with caution Redis::decr() — Method in class Redis Decrement a Redis integer by 1 or a provided value. Redis::decrBy() — Method in class Redis Decrement a redis integer by a value Redis::del() — Method in class Redis - Delete one or more keys from Redis. + Delete one or more keys from Redis. +Redis::delex() — Method in class Redis + Delete a key conditionally based on its value or hash digest +Redis::delifeq() — Method in class Redis + Delete a key if it's equal to the specified value. This command is +specific to Valkey >= 9.0 Redis::delete() — Method in class Redis Redis::discard() — Method in class Redis Discard a transaction currently in progress. Redis::dump() — Method in class Redis - Dump Redis' internal binary representation of a key. + Dump Redis' internal binary representation of a key. +Redis::digest() — Method in class Redis + Ask the server for the XXH3 digest of a given key's value RedisArray::del() — Method in class RedisArray RedisArray::discard() — Method in class RedisArray + +RedisArray::dbSize() — Method in class RedisArray + +RedisArray::debug() — Method in class RedisArray + +RedisArray::decr() — Method in class RedisArray + +RedisArray::decrBy() — Method in class RedisArray + +RedisArray::delex() — Method in class RedisArray + +RedisArray::delifeq() — Method in class RedisArray + +RedisArray::delete() — Method in class RedisArray + +RedisArray::dump() — Method in class RedisArray + +RedisArray::digest() — Method in class RedisArray RedisCluster::dbsize() — Method in class RedisCluster @@ -237,10 +707,17 @@ A RedisCluster::decrbyfloat() — Method in class RedisCluster RedisCluster::del() — Method in class RedisCluster - + +RedisCluster::delex() — Method in class RedisCluster + Delete a key conditionally based on its value or hash digest +RedisCluster::delifeq() — Method in class RedisCluster + Delete a key if it's equal to the specified value. This command is +specific to Valkey >= 9.0 RedisCluster::discard() — Method in class RedisCluster RedisCluster::dump() — Method in class RedisCluster + +RedisCluster::digest() — Method in class RedisCluster E Redis::echo() — Method in class Redis @@ -267,8 +744,34 @@ A Redis::expireAt() — Method in class Redis Set a key to expire at an exact unix timestamp. Redis::expiretime() — Method in class Redis - Get the expiration of a given key as a unix timestamp + Get the expiration of a given key as a unix timestamp +Redis::expiremember() — Method in class Redis + Set an expiration on a key member (KeyDB only). +Redis::expirememberat() — Method in class Redis + Set an expiration on a key membert to a specific unix timestamp (KeyDB only). RedisArray::exec() — Method in class RedisArray + +RedisArray::echo() — Method in class RedisArray + +RedisArray::eval() — Method in class RedisArray + +RedisArray::eval_ro() — Method in class RedisArray + +RedisArray::evalsha() — Method in class RedisArray + +RedisArray::evalsha_ro() — Method in class RedisArray + +RedisArray::exists() — Method in class RedisArray + +RedisArray::expire() — Method in class RedisArray + +RedisArray::expireAt() — Method in class RedisArray + +RedisArray::expiretime() — Method in class RedisArray + +RedisArray::expiremember() — Method in class RedisArray + +RedisArray::expirememberat() — Method in class RedisArray RedisCluster::echo() — Method in class RedisCluster @@ -289,17 +792,35 @@ A RedisCluster::expireat() — Method in class RedisCluster RedisCluster::expiretime() — Method in class RedisCluster + +RedisCluster::expiremember() — Method in class RedisCluster + +RedisCluster::expirememberat() — Method in class RedisCluster F Redis::failover() — Method in class Redis - + +Redis::fcall() — Method in class Redis + Invoke a function. +Redis::fcall_ro() — Method in class Redis + This is a read-only variant of the FCALL command that cannot execute commands that modify data. Redis::flushAll() — Method in class Redis Deletes every key in all Redis databases Redis::flushDB() — Method in class Redis - Deletes all the keys of the currently selected database. + Deletes all the keys of the currently selected database. +Redis::function() — Method in class Redis + Functions is an API for managing code to be executed on the server. RedisArray::flushall() — Method in class RedisArray RedisArray::flushdb() — Method in class RedisArray + +RedisArray::failover() — Method in class RedisArray + +RedisArray::fcall() — Method in class RedisArray + +RedisArray::fcall_ro() — Method in class RedisArray + +RedisArray::function() — Method in class RedisArray RedisCluster::flushall() — Method in class RedisCluster @@ -317,7 +838,7 @@ A Redis::geohash() — Method in class Redis Retrieve one or more GeoHash encoded strings for members of the set. Redis::geopos() — Method in class Redis - Return the longitude and lattitude for one or more members of a geospacially encoded sorted set. + Return the longitude and latitude for one or more members of a geospacially encoded sorted set. Redis::georadius() — Method in class Redis Retrieve members of a geospacially sorted set that are within a certain radius of a location. Redis::georadius_ro() — Method in class Redis @@ -332,7 +853,9 @@ A Search a geospacial sorted set for members within a given area or range, storing the results into a new set. Redis::get() — Method in class Redis - Retrieve a string keys value. + Retrieve a string keys value. +Redis::getWithMeta() — Method in class Redis + Retrieve a value and metadata of key. Redis::getAuth() — Method in class Redis Get the authentication information on the connection, if any. Redis::getBit() — Method in class Redis @@ -364,8 +887,64 @@ A Redis::getTimeout() — Method in class Redis Retrieve any set connection timeout Redis::getTransferredBytes() — Method in class Redis - + Get the number of bytes sent and received on the socket. +Redis::gcra() — Method in class Redis + Get rate limiting information RedisArray::getOption() — Method in class RedisArray + +RedisArray::geoadd() — Method in class RedisArray + +RedisArray::geodist() — Method in class RedisArray + +RedisArray::geohash() — Method in class RedisArray + +RedisArray::geopos() — Method in class RedisArray + +RedisArray::georadius() — Method in class RedisArray + +RedisArray::georadius_ro() — Method in class RedisArray + +RedisArray::georadiusbymember() — Method in class RedisArray + +RedisArray::georadiusbymember_ro() — Method in class RedisArray + +RedisArray::geosearch() — Method in class RedisArray + +RedisArray::geosearchstore() — Method in class RedisArray + +RedisArray::get() — Method in class RedisArray + +RedisArray::getWithMeta() — Method in class RedisArray + +RedisArray::getAuth() — Method in class RedisArray + +RedisArray::getBit() — Method in class RedisArray + +RedisArray::getEx() — Method in class RedisArray + +RedisArray::getDBNum() — Method in class RedisArray + +RedisArray::getDel() — Method in class RedisArray + +RedisArray::getHost() — Method in class RedisArray + +RedisArray::getLastError() — Method in class RedisArray + +RedisArray::getMode() — Method in class RedisArray + +RedisArray::getPersistentID() — Method in class RedisArray + +RedisArray::getPort() — Method in class RedisArray + +RedisArray::getRange() — Method in class RedisArray + +RedisArray::getReadTimeout() — Method in class RedisArray + +RedisArray::getset() — Method in class RedisArray + +RedisArray::getTimeout() — Method in class RedisArray + +RedisArray::getTransferredBytes() — Method in class RedisArray RedisCluster::geoadd() — Method in class RedisCluster @@ -382,8 +961,18 @@ A RedisCluster::georadiusbymember() — Method in class RedisCluster RedisCluster::georadiusbymember_ro() — Method in class RedisCluster + +RedisCluster::geosearch() — Method in class RedisCluster + +RedisCluster::geosearchstore() — Method in class RedisCluster RedisCluster::get() — Method in class RedisCluster + +RedisCluster::getdel() — Method in class RedisCluster + +RedisCluster::getWithMeta() — Method in class RedisCluster + +RedisCluster::getex() — Method in class RedisCluster RedisCluster::getbit() — Method in class RedisCluster @@ -398,6 +987,8 @@ A RedisCluster::getset() — Method in class RedisCluster RedisCluster::gettransferredbytes() — Method in class RedisCluster + +RedisCluster::gcra() — Method in class RedisCluster RedisSentinel::getMasterAddrByName() — Method in class RedisSentinel H @@ -409,7 +1000,9 @@ A Redis::hGet() — Method in class Redis Redis::hGetAll() — Method in class Redis - Read every field and value from a hash. + Read every field and value from a hash. +Redis::hGetWithMeta() — Method in class Redis + Retrieve a value and metadata of hash field. Redis::hIncrBy() — Method in class Redis Increment a hash field's value by an integer Redis::hIncrByFloat() — Method in class Redis @@ -419,22 +1012,95 @@ A Redis::hLen() — Method in class Redis Get the number of fields in a hash. Redis::hMget() — Method in class Redis - Get one or more fields from a hash. + Get one or more fields from a hash. +Redis::hgetex() — Method in class Redis + Get one or more fields of a hash while optionally setting expiration +information +Redis::hsetex() — Method in class Redis + Set one or more fields in a hash with optional expiration information. +Redis::hgetdel() — Method in class Redis + Get one or more fields and delete them Redis::hMset() — Method in class Redis Add or update one or more hash fields and values Redis::hRandField() — Method in class Redis Get one or more random field from a hash. Redis::hSet() — Method in class Redis - + Add or update one or more hash fields and values. Redis::hSetNx() — Method in class Redis Set a hash field and value, but only if that field does not exist Redis::hStrLen() — Method in class Redis Get the string length of a hash field Redis::hVals() — Method in class Redis - Get all of the values from a hash. + Get all of the values from a hash. +Redis::hexpire() — Method in class Redis + Set the expiration on one or more fields in a hash. +Redis::hpexpire() — Method in class Redis + Set the expiration on one or more fields in a hash in milliseconds. +Redis::hexpireat() — Method in class Redis + Set the expiration time on one or more fields of a hash. +Redis::hpexpireat() — Method in class Redis + Set the expiration time on one or more fields of a hash in milliseconds. +Redis::httl() — Method in class Redis + Get the TTL of one or more fields in a hash +Redis::hpttl() — Method in class Redis + Get the millisecond TTL of one or more fields in a hash +Redis::hexpiretime() — Method in class Redis + Get the expiration time of one or more fields in a hash +Redis::hpexpiretime() — Method in class Redis + Get the expiration time in milliseconds of one or more fields in a hash +Redis::hpersist() — Method in class Redis + Persist one or more hash fields Redis::hscan() — Method in class Redis Iterate over the fields and values of a hash in an incremental fashion. RedisArray::hscan() — Method in class RedisArray + +RedisArray::hDel() — Method in class RedisArray + +RedisArray::hExists() — Method in class RedisArray + +RedisArray::hGet() — Method in class RedisArray + +RedisArray::hGetAll() — Method in class RedisArray + +RedisArray::hGetWithMeta() — Method in class RedisArray + +RedisArray::hIncrBy() — Method in class RedisArray + +RedisArray::hIncrByFloat() — Method in class RedisArray + +RedisArray::hKeys() — Method in class RedisArray + +RedisArray::hLen() — Method in class RedisArray + +RedisArray::hMget() — Method in class RedisArray + +RedisArray::hgetex() — Method in class RedisArray + +RedisArray::hsetex() — Method in class RedisArray + +RedisArray::hgetdel() — Method in class RedisArray + +RedisArray::hMset() — Method in class RedisArray + +RedisArray::hRandField() — Method in class RedisArray + +RedisArray::hSet() — Method in class RedisArray + +RedisArray::hSetNx() — Method in class RedisArray + +RedisArray::hStrLen() — Method in class RedisArray + +RedisArray::hVals() — Method in class RedisArray + +RedisArray::httl() — Method in class RedisArray + +RedisArray::hpttl() — Method in class RedisArray + +RedisArray::hexpiretime() — Method in class RedisArray + +RedisArray::hpexpiretime() — Method in class RedisArray + +RedisArray::hpersist() — Method in class RedisArray RedisCluster::hdel() — Method in class RedisCluster @@ -443,6 +1109,8 @@ A RedisCluster::hget() — Method in class RedisCluster RedisCluster::hgetall() — Method in class RedisCluster + +RedisCluster::hgetWithMeta() — Method in class RedisCluster RedisCluster::hincrby() — Method in class RedisCluster @@ -453,22 +1121,48 @@ A RedisCluster::hlen() — Method in class RedisCluster RedisCluster::hmget() — Method in class RedisCluster + +RedisCluster::hgetex() — Method in class RedisCluster + +RedisCluster::hsetex() — Method in class RedisCluster + +RedisCluster::hgetdel() — Method in class RedisCluster RedisCluster::hmset() — Method in class RedisCluster RedisCluster::hscan() — Method in class RedisCluster + +RedisCluster::hrandfield() — Method in class RedisCluster RedisCluster::hset() — Method in class RedisCluster RedisCluster::hsetnx() — Method in class RedisCluster RedisCluster::hstrlen() — Method in class RedisCluster + +RedisCluster::hexpire() — Method in class RedisCluster + +RedisCluster::hpexpire() — Method in class RedisCluster + +RedisCluster::hexpireat() — Method in class RedisCluster + +RedisCluster::hpexpireat() — Method in class RedisCluster + +RedisCluster::httl() — Method in class RedisCluster + +RedisCluster::hpttl() — Method in class RedisCluster + +RedisCluster::hexpiretime() — Method in class RedisCluster + +RedisCluster::hpexpiretime() — Method in class RedisCluster + +RedisCluster::hpersist() — Method in class RedisCluster RedisCluster::hvals() — Method in class RedisCluster I Redis::incr() — Method in class Redis - Increment a key's value, optionally by a specifc amount. + Increment a key's value, optionally by a specific amount. Redis::incrBy() — Method in class Redis Increment a key by a specific integer value Redis::incrByFloat() — Method in class Redis @@ -481,6 +1175,14 @@ A Redis::isConnected() — Method in class Redis Check if we are currently connected to a Redis instance. RedisArray::info() — Method in class RedisArray + +RedisArray::incr() — Method in class RedisArray + +RedisArray::incrBy() — Method in class RedisArray + +RedisArray::incrByFloat() — Method in class RedisArray + +RedisArray::isConnected() — Method in class RedisArray RedisCluster::incr() — Method in class RedisCluster @@ -508,7 +1210,7 @@ A Redis::lInsert() — Method in class Redis Redis::lLen() — Method in class Redis - Retrieve the lenght of a list. + Retrieve the length of a list. Redis::lMove() — Method in class Redis Move an element from one list into another. Redis::lPop() — Method in class Redis @@ -530,7 +1232,39 @@ A Redis::lrem() — Method in class Redis Remove one or more matching elements from a list. Redis::ltrim() — Method in class Redis - Trim a list to a subrange of elements. + Trim a list to a subrange of elements. +RedisArray::lmpop() — Method in class RedisArray + +RedisArray::lcs() — Method in class RedisArray + +RedisArray::lInsert() — Method in class RedisArray + +RedisArray::lLen() — Method in class RedisArray + +RedisArray::lMove() — Method in class RedisArray + +RedisArray::lPop() — Method in class RedisArray + +RedisArray::lPos() — Method in class RedisArray + +RedisArray::lPush() — Method in class RedisArray + +RedisArray::lPushx() — Method in class RedisArray + +RedisArray::lSet() — Method in class RedisArray + +RedisArray::lastSave() — Method in class RedisArray + +RedisArray::lindex() — Method in class RedisArray + +RedisArray::lrange() — Method in class RedisArray + +RedisArray::lrem() — Method in class RedisArray + +RedisArray::ltrim() — Method in class RedisArray + +RedisCluster::lmove() — Method in class RedisCluster + Move an element from one list into another. RedisCluster::lmpop() — Method in class RedisCluster RedisCluster::lcs() — Method in class RedisCluster @@ -546,6 +1280,8 @@ A RedisCluster::llen() — Method in class RedisCluster RedisCluster::lpop() — Method in class RedisCluster + +RedisCluster::lpos() — Method in class RedisCluster RedisCluster::lpush() — Method in class RedisCluster @@ -561,15 +1297,17 @@ A M Redis::mget() — Method in class Redis - Get one ore more string keys. + Get one or more string keys. Redis::migrate() — Method in class Redis - + Proxy for the Redis MIGRATE command. Redis::move() — Method in class Redis Move a key to a different database on the same redis instance. Redis::mset() — Method in class Redis - Set one ore more string keys. + Set one or more string keys. +Redis::msetex() — Method in class Redis + Set one or more keys and values with optional expiry information. Redis::msetnx() — Method in class Redis - Set one ore more string keys but only if none of the key exist. + Set one or more string keys but only if none of the key exist. Redis::multi() — Method in class Redis Begin a transaction. RedisArray::mget() — Method in class RedisArray @@ -577,12 +1315,20 @@ A RedisArray::mset() — Method in class RedisArray RedisArray::multi() — Method in class RedisArray + +RedisArray::move() — Method in class RedisArray + +RedisArray::msetex() — Method in class RedisArray + +RedisArray::msetnx() — Method in class RedisArray RedisCluster::mget() — Method in class RedisCluster RedisCluster::mset() — Method in class RedisCluster RedisCluster::msetnx() — Method in class RedisCluster + +RedisCluster::msetex() — Method in class RedisCluster RedisCluster::multi() — Method in class RedisCluster @@ -594,16 +1340,20 @@ A O Redis::object() — Method in class Redis - + Get encoding and other information about a key. Redis::open() — Method in class Redis + +RedisArray::object() — Method in class RedisArray + +RedisArray::open() — Method in class RedisArray RedisCluster::object() — Method in class RedisCluster P Redis::pexpiretime() — Method in class Redis - Get the expriation timestamp of a given Redis key but in milliseconds. + Get the expiration timestamp of a given Redis key but in milliseconds. Redis::pconnect() — Method in class Redis - + Connects to a Redis server creating or reusing a persistent connection. Redis::persist() — Method in class Redis Remove the expiration from a key. Redis::pexpire() — Method in class Redis @@ -633,10 +1383,42 @@ A Redis::publish() — Method in class Redis Publish a message to a pubsub channel Redis::pubsub() — Method in class Redis - + Interact with the Redis PubSub subsystem. Redis::punsubscribe() — Method in class Redis Unsubscribe from one or more channels by pattern RedisArray::ping() — Method in class RedisArray + +RedisArray::pexpiretime() — Method in class RedisArray + +RedisArray::pconnect() — Method in class RedisArray + +RedisArray::persist() — Method in class RedisArray + +RedisArray::pexpire() — Method in class RedisArray + +RedisArray::pexpireAt() — Method in class RedisArray + +RedisArray::pfadd() — Method in class RedisArray + +RedisArray::pfcount() — Method in class RedisArray + +RedisArray::pfmerge() — Method in class RedisArray + +RedisArray::pipeline() — Method in class RedisArray + +RedisArray::popen() — Method in class RedisArray + +RedisArray::psetex() — Method in class RedisArray + +RedisArray::psubscribe() — Method in class RedisArray + +RedisArray::pttl() — Method in class RedisArray + +RedisArray::publish() — Method in class RedisArray + +RedisArray::pubsub() — Method in class RedisArray + +RedisArray::punsubscribe() — Method in class RedisArray RedisCluster::pexpiretime() — Method in class RedisCluster @@ -696,6 +1478,30 @@ A Redis::replicaof() — Method in class Redis Used to turn a Redis instance into a replica of another, or to remove replica status promoting the instance to a primary. RedisArray + +RedisArray::rPush() — Method in class RedisArray + +RedisArray::rPushx() — Method in class RedisArray + +RedisArray::rPop() — Method in class RedisArray + +RedisArray::randomKey() — Method in class RedisArray + +RedisArray::rawcommand() — Method in class RedisArray + +RedisArray::rename() — Method in class RedisArray + +RedisArray::renameNx() — Method in class RedisArray + +RedisArray::reset() — Method in class RedisArray + +RedisArray::restore() — Method in class RedisArray + +RedisArray::role() — Method in class RedisArray + +RedisArray::rpoplpush() — Method in class RedisArray + +RedisArray::replicaof() — Method in class RedisArray RedisCluster RedisCluster::randomkey() — Method in class RedisCluster @@ -723,11 +1529,15 @@ A RedisSentinel::reset() — Method in class RedisSentinel S - + +Redis::serverName() — Method in class Redis + Get the server name as reported by the HELLO response. +Redis::serverVersion() — Method in class Redis + Get the server version as reported by the HELLO response. Redis::sAdd() — Method in class Redis Add one or more values to a Redis SET key. Redis::sAddArray() — Method in class Redis - Add one ore more values to a Redis SET key. This is an alternative to Redis::sadd() but + Add one or more values to a Redis SET key. This is an alternative to Redis::sadd() but instead of being variadic, takes a single array of values. Redis::sDiff() — Method in class Redis Given one or more Redis SETS, this command returns all of the members from the first @@ -804,11 +1614,16 @@ A Redis::srem() — Method in class Redis Remove one or more values from a Redis SET key. Redis::sscan() — Method in class Redis - Scan the members of a redis SET key. + Scan the members of a redis SET key. +Redis::ssubscribe() — Method in class Redis + Subscribes the client to the specified shard channels. Redis::strlen() — Method in class Redis Retrieve the length of a Redis STRING key. Redis::subscribe() — Method in class Redis - Subscribe to one or more Redis pubsub channels. + Subscribe to one or more Redis pubsub channels. +Redis::sunsubscribe() — Method in class Redis + Unsubscribes the client from the given shard channels, +or from all of them if none is given. Redis::swapdb() — Method in class Redis Atomically swap two Redis databases so that all of the keys in the source database will now be in the destination database and vice-versa. @@ -821,6 +1636,82 @@ A RedisArray::setOption() — Method in class RedisArray RedisArray::sscan() — Method in class RedisArray + +RedisArray::serverName() — Method in class RedisArray + +RedisArray::serverVersion() — Method in class RedisArray + +RedisArray::sAdd() — Method in class RedisArray + +RedisArray::sAddArray() — Method in class RedisArray + +RedisArray::sDiff() — Method in class RedisArray + +RedisArray::sDiffStore() — Method in class RedisArray + +RedisArray::sInter() — Method in class RedisArray + +RedisArray::sintercard() — Method in class RedisArray + +RedisArray::sInterStore() — Method in class RedisArray + +RedisArray::sMembers() — Method in class RedisArray + +RedisArray::sMisMember() — Method in class RedisArray + +RedisArray::sMove() — Method in class RedisArray + +RedisArray::sPop() — Method in class RedisArray + +RedisArray::sRandMember() — Method in class RedisArray + +RedisArray::sUnion() — Method in class RedisArray + +RedisArray::sUnionStore() — Method in class RedisArray + +RedisArray::scard() — Method in class RedisArray + +RedisArray::script() — Method in class RedisArray + +RedisArray::set() — Method in class RedisArray + +RedisArray::setBit() — Method in class RedisArray + +RedisArray::setRange() — Method in class RedisArray + +RedisArray::setex() — Method in class RedisArray + +RedisArray::setnx() — Method in class RedisArray + +RedisArray::sismember() — Method in class RedisArray + +RedisArray::slaveof() — Method in class RedisArray + +RedisArray::slowlog() — Method in class RedisArray + +RedisArray::sort() — Method in class RedisArray + +RedisArray::sort_ro() — Method in class RedisArray + +RedisArray::sortAsc() — Method in class RedisArray + +RedisArray::sortAscAlpha() — Method in class RedisArray + +RedisArray::sortDesc() — Method in class RedisArray + +RedisArray::sortDescAlpha() — Method in class RedisArray + +RedisArray::srem() — Method in class RedisArray + +RedisArray::ssubscribe() — Method in class RedisArray + +RedisArray::strlen() — Method in class RedisArray + +RedisArray::subscribe() — Method in class RedisArray + +RedisArray::sunsubscribe() — Method in class RedisArray + +RedisArray::swapdb() — Method in class RedisArray RedisCluster::sadd() — Method in class RedisCluster @@ -857,6 +1748,8 @@ A RedisCluster::sinterstore() — Method in class RedisCluster RedisCluster::sismember() — Method in class RedisCluster + +RedisCluster::smismember() — Method in class RedisCluster RedisCluster::slowlog() — Method in class RedisCluster @@ -896,7 +1789,15 @@ A Redis::ttl() — Method in class Redis Get the amount of time a Redis key has before it will expire, in seconds. Redis::type() — Method in class Redis - Get the type of a given Redis key. + Get the type of a given Redis key. +RedisArray::touch() — Method in class RedisArray + +RedisArray::time() — Method in class RedisArray + +RedisArray::ttl() — Method in class RedisArray + +RedisArray::type() — Method in class RedisArray + RedisCluster::touch() — Method in class RedisCluster RedisCluster::time() — Method in class RedisCluster @@ -917,24 +1818,117 @@ A RedisArray::unlink() — Method in class RedisArray RedisArray::unwatch() — Method in class RedisArray + +RedisArray::unsubscribe() — Method in class RedisArray RedisCluster::unsubscribe() — Method in class RedisCluster RedisCluster::unlink() — Method in class RedisCluster RedisCluster::unwatch() — Method in class RedisCluster + V + +Redis::vadd() — Method in class Redis + Add to a vector set +Redis::vsim() — Method in class Redis + Query similarity of a vector by element or scores +Redis::vcard() — Method in class Redis + Get the length of a vector set +Redis::vdim() — Method in class Redis + Get the dimensions of a vector set +Redis::vinfo() — Method in class Redis + Get various bits of information about a vector set +Redis::vismember() — Method in class Redis + Check if an element is a member of a vectorset +Redis::vemb() — Method in class Redis + Get the embeddings for a specific member +Redis::vrandmember() — Method in class Redis + Get one or more random members from a vector set +Redis::vrange() — Method in class Redis + Retreive a lexographical range of elements from a vector set +Redis::vrem() — Method in class Redis + Remove an element from a vector set +Redis::vsetattr() — Method in class Redis + Set the attributes of a vector set element +Redis::vgetattr() — Method in class Redis + Get the attributes of a vector set element +Redis::vlinks() — Method in class Redis + Get any adajcent values for a member of a vector set. +RedisArray::vadd() — Method in class RedisArray + +RedisArray::vsim() — Method in class RedisArray + +RedisArray::vcard() — Method in class RedisArray + +RedisArray::vdim() — Method in class RedisArray + +RedisArray::vinfo() — Method in class RedisArray + +RedisArray::vismember() — Method in class RedisArray + +RedisArray::vemb() — Method in class RedisArray + +RedisArray::vrandmember() — Method in class RedisArray + +RedisArray::vrange() — Method in class RedisArray + +RedisArray::vrem() — Method in class RedisArray + +RedisArray::vsetattr() — Method in class RedisArray + +RedisArray::vgetattr() — Method in class RedisArray + +RedisArray::vlinks() — Method in class RedisArray + +RedisCluster::vadd() — Method in class RedisCluster + +RedisCluster::vsim() — Method in class RedisCluster + +RedisCluster::vcard() — Method in class RedisCluster + +RedisCluster::vdim() — Method in class RedisCluster + +RedisCluster::vinfo() — Method in class RedisCluster + +RedisCluster::vismember() — Method in class RedisCluster + Check if an element is a member of a vectorset +RedisCluster::vemb() — Method in class RedisCluster + +RedisCluster::vrandmember() — Method in class RedisCluster + +RedisCluster::vrange() — Method in class RedisCluster + Retreive a lexographical range of elements from a vector set +RedisCluster::vrem() — Method in class RedisCluster + +RedisCluster::vlinks() — Method in class RedisCluster + +RedisCluster::vgetattr() — Method in class RedisCluster + +RedisCluster::vsetattr() — Method in class RedisCluster W - + +Redis::waitaof() — Method in class Redis + Redis::watch() — Method in class Redis Watch one or more keys for conditional execution of a transaction. Redis::wait() — Method in class Redis Block the client up to the provided timeout until a certain number of replicas have confirmed -recieving them. +receiving them. +RedisArray::waitaof() — Method in class RedisArray + +RedisArray::watch() — Method in class RedisArray + +RedisArray::wait() — Method in class RedisArray + +RedisCluster::wait() — Method in class RedisCluster + +RedisCluster::waitaof() — Method in class RedisCluster + RedisCluster::watch() — Method in class RedisCluster X Redis::xack() — Method in class Redis - Acknowledge one ore more messages that are pending (have been consumed using XREADGROUP but + Acknowledge one or more messages that are pending (have been consumed using XREADGROUP but not yet acknowledged by XACK.) Redis::xadd() — Method in class Redis Append a message to a stream. @@ -944,7 +1938,9 @@ A This method allows a consumer to take ownership of pending stream entries, by ID. Another command that does much the same thing but does not require passing specific IDs is Redis::xAutoClaim. Redis::xdel() — Method in class Redis - Remove one or more specific IDs from a stream. + Remove one or more specific IDs from a stream. +Redis::xdelex() — Method in class Redis + Remove one or more IDs from a stream with extended options. Redis::xgroup() — Method in class Redis XGROUP Redis::xinfo() — Method in class Redis @@ -961,9 +1957,37 @@ A Redis::xreadgroup() — Method in class Redis Read one or more messages using a consumer group. Redis::xrevrange() — Method in class Redis - Get a range of entries from a STREAM ke in reverse cronological order. + Get a range of entries from a STREAM key in reverse chronological order. Redis::xtrim() — Method in class Redis - Truncate a STREAM key in various ways. + Truncate a STREAM key in various ways. +RedisArray::xack() — Method in class RedisArray + +RedisArray::xadd() — Method in class RedisArray + +RedisArray::xautoclaim() — Method in class RedisArray + +RedisArray::xclaim() — Method in class RedisArray + +RedisArray::xdel() — Method in class RedisArray + +RedisArray::xdelex() — Method in class RedisArray + +RedisArray::xinfo() — Method in class RedisArray + +RedisArray::xlen() — Method in class RedisArray + +RedisArray::xpending() — Method in class RedisArray + +RedisArray::xrange() — Method in class RedisArray + +RedisArray::xread() — Method in class RedisArray + +RedisArray::xreadgroup() — Method in class RedisArray + +RedisArray::xrevrange() — Method in class RedisArray + +RedisArray::xtrim() — Method in class RedisArray + RedisCluster::xack() — Method in class RedisCluster RedisCluster::xadd() — Method in class RedisCluster @@ -971,6 +1995,8 @@ A RedisCluster::xclaim() — Method in class RedisCluster RedisCluster::xdel() — Method in class RedisCluster + +RedisCluster::xdelex() — Method in class RedisCluster RedisCluster::xgroup() — Method in class RedisCluster @@ -1004,7 +2030,7 @@ A Redis::zIncrBy() — Method in class Redis Create or increment the score of a member in a Redis sorted set Redis::zLexCount() — Method in class Redis - Count the number of elements in a sorted set whos members fall within the provided + Count the number of elements in a sorted set whose members fall within the provided lexographical range. Redis::zMscore() — Method in class Redis Retrieve the score of one or more members in a sorted set. @@ -1054,7 +2080,7 @@ A Similar to ZINTER but instead of returning the intersected values, this command returns the cardinality of the intersected set. Redis::zinterstore() — Method in class Redis - Compute the intersection of one ore more sorted sets storing the result in a new sorted set. + Compute the intersection of one or more sorted sets storing the result in a new sorted set. Redis::zscan() — Method in class Redis Scan the members of a sorted set incrementally, using a cursor Redis::zunion() — Method in class Redis @@ -1062,6 +2088,66 @@ A Redis::zunionstore() — Method in class Redis Perform a union on one or more Redis sets and store the result in a destination sorted set. RedisArray::zscan() — Method in class RedisArray + +RedisArray::zmpop() — Method in class RedisArray + +RedisArray::zAdd() — Method in class RedisArray + +RedisArray::zCard() — Method in class RedisArray + +RedisArray::zCount() — Method in class RedisArray + +RedisArray::zIncrBy() — Method in class RedisArray + +RedisArray::zLexCount() — Method in class RedisArray + +RedisArray::zMscore() — Method in class RedisArray + +RedisArray::zPopMax() — Method in class RedisArray + +RedisArray::zPopMin() — Method in class RedisArray + +RedisArray::zRange() — Method in class RedisArray + +RedisArray::zRangeByLex() — Method in class RedisArray + +RedisArray::zRangeByScore() — Method in class RedisArray + +RedisArray::zRandMember() — Method in class RedisArray + +RedisArray::zRank() — Method in class RedisArray + +RedisArray::zRem() — Method in class RedisArray + +RedisArray::zRemRangeByLex() — Method in class RedisArray + +RedisArray::zRemRangeByRank() — Method in class RedisArray + +RedisArray::zRemRangeByScore() — Method in class RedisArray + +RedisArray::zRevRange() — Method in class RedisArray + +RedisArray::zRevRangeByLex() — Method in class RedisArray + +RedisArray::zRevRangeByScore() — Method in class RedisArray + +RedisArray::zRevRank() — Method in class RedisArray + +RedisArray::zScore() — Method in class RedisArray + +RedisArray::zdiff() — Method in class RedisArray + +RedisArray::zdiffstore() — Method in class RedisArray + +RedisArray::zinter() — Method in class RedisArray + +RedisArray::zintercard() — Method in class RedisArray + +RedisArray::zinterstore() — Method in class RedisArray + +RedisArray::zunion() — Method in class RedisArray + +RedisArray::zunionstore() — Method in class RedisArray RedisCluster::zmpop() — Method in class RedisCluster @@ -1086,6 +2172,8 @@ A RedisCluster::zrange() — Method in class RedisCluster RedisCluster::zrangestore() — Method in class RedisCluster + +RedisCluster::zrandmember() — Method in class RedisCluster RedisCluster::zrangebylex() — Method in class RedisCluster @@ -1112,8 +2200,18 @@ A RedisCluster::zscan() — Method in class RedisCluster RedisCluster::zscore() — Method in class RedisCluster + +RedisCluster::zmscore() — Method in class RedisCluster RedisCluster::zunionstore() — Method in class RedisCluster + +RedisCluster::zinter() — Method in class RedisCluster + +RedisCluster::zdiffstore() — Method in class RedisCluster + +RedisCluster::zunion() — Method in class RedisCluster + +RedisCluster::zdiff() — Method in class RedisCluster _

Redis::__construct() — Method in class Redis
Redis::__destruct() — Method in class Redis
+: Destructor to clean up the Redis object.
Redis::_compress() — Method in class Redis: Compress a value with the currently configured compressor as set with -Redis::setOption().
+: Compress a value with the currently configured compressor (Redis::OPT_COMPRESSION) +exactly the same way PhpRedis does before sending data to Redis.
Redis::_uncompress() — Method in class Redis: Uncompress the provided argument that has been compressed with the -currently configured compressor as set with Redis::setOption().
+: Uncompress the provided argument using the compressor configured via +Redis::setOption() (Redis::OPT_COMPRESSION).
Redis::_prefix() — Method in class Redis: Prefix the passed argument with the currently set key prefix as set with Redis::setOption().
@@ -1138,11 +2236,16 @@ A: Unserialize the passed argument with the currently set serializer as set with Redis::setOption().
Redis::_pack() — Method in class Redis: Pack the provided value with the configured serializer and compressor -as set with Redis::setOption().
+: Pack the provided value by first serializing it (if Redis::OPT_SERIALIZER is set) +and then compressing the serialized payload (if Redis::OPT_COMPRESSION is set), +mirroring exactly what PhpRedis transmits to Redis.
+Redis::_digest() — Method in class Redis: Compute the XXH3 digest of a PHP value after it has been _packed, producing +the same digest Redis' DIGEST command would return for the stored value.
Redis::_unpack() — Method in class Redis: Unpack the provided value with the configured compressor and serializer -as set with Redis::setOption().
+: Unpack the provided value by first uncompressing it (if Redis::OPT_COMPRESSION +is set) and then unserializing it (if Redis::OPT_SERIALIZER is set) to recover +the original PHP value.
RedisArray::__call() — Method in class RedisArray
RedisArray::__construct() — Method in class RedisArray
RedisCluster::_compress() — Method in class RedisCluster
+: {\Redis::_compress()}
RedisCluster::_uncompress() — Method in class RedisCluster
RedisCluster::_serialize() — Method in class RedisCluster
RedisCluster::_pack() — Method in class RedisCluster
+RedisCluster::_digest() — Method in class RedisCluster
RedisCluster::_unpack() — Method in class RedisCluster

+ REDIS_NOT_FOUND +	+ Returned by `\Redis::type()` when the key does not exist or has a type +we are not familiar with. + +
+ REDIS_STRING +	+ Returned by `\Redis::type()` when the key is a string. + +
+ REDIS_SET +	+ Returned by `\Redis::type()` when the key is a set. + +
+ REDIS_LIST +	+ Returned by `\Redis::type()` when the key is a list. + +
+ REDIS_ZSET +	+ Returned by `\Redis::type()` when the key is a sorted set. + +
+ REDIS_HASH +	+ Returned by `\Redis::type()` when the key is a hash. + +
+ REDIS_STREAM +	+ Returned by `\Redis::type()` when the key is a stream. + +
+ REDIS_VECTORSET +	+ Returned by `\Redis::type()` when the key is a vector set. + +
+ ATOMIC +	+ Returned from `\Redis::getMode()` when we're not in a multi or pipeline +transaction. + +
+ MULTI +	+ Returned from `\Redis::getMode()` when we're in a multi transaction. + +
+ PIPELINE +	+ Returned from `\Redis::getMode()` when we're in a pipeline transaction. + +
+ OPT_SERIALIZER +	+ Used with `\Redis::setOption()` to specify the serializer to use + +
+ OPT_PREFIX +	+ Used to set an automatic prefix for keys used in commands. + +
+ OPT_READ_TIMEOUT +	+ Used to set the read timeout for the connection. + +
+ OPT_TCP_KEEPALIVE +	+ Used to enable or disable TCP keepalive on the connection. + +
+ OPT_COMPRESSION +	+ Used to set the compression algorithm to use for compressing + +
+ OPT_REPLY_LITERAL +	+ Causes PhpRedis to return the actual string in `+OK` style responses +from Redis. If disabled those replies are just converted to boolean +true. + +
+ OPT_COMPRESSION_LEVEL +	+ Used to specify the compression level to use when compressing data. + +
+ OPT_NULL_MULTIBULK_AS_NULL +	+ Tells PhpRedis to return a NULL multi-bulk (`-1\r\n`) response +as `null` as opposed to an empty array.* + +
+ OPT_PACK_IGNORE_NUMBERS +	+ When enabled, this option tells PhpRedis to ignore purely numeric values +when packing and unpacking data. This does not include numeric strings. + If you want numeric strings to be ignored, typecast them to an int or +float. + The primary purpose of this option is to make it more ergonomic when +setting keys that will later be incremented or decremented. + Note: This option incurs a small performance penalty when reading data +because we have to see if the data is a string representation of an int +or float. +
+ SERIALIZER_NONE +	+ Sets the serializer to none (no serialization). + +
+ SERIALIZER_PHP +	+ Sets the serializer to PHP's built-in `serialize()`/`unserialize()` + +
+ SERIALIZER_IGBINARY +	+ Sets the serializer to igbinary. Note that phpredis must be compiled +with ighbinary support to use this serializer. + +
+ SERIALIZER_MSGPACK +	+ Sets the serializer to msgpack. Note that phpredis must be compiled +with msgpack support to use this serializer. + +
+ SERIALIZER_JSON +	+ Sets the serializer to JSON. + +
+ COMPRESSION_NONE +	+ Disables compression. + +
+ COMPRESSION_LZF +	+ Sets the compression algorithm to LZF. PhpRedis must be compiled with +lzf support but this serializer is bundled with the extension. + +
+ COMPRESSION_ZSTD +	+ Sets the compression algorithm to ZSTD. PhpRedis must be compiled with +zstd support to use this serializer. This is often the best balance +between speed and compression ratio. + +
+ COMPRESSION_ZSTD_DEFAULT +	+ This constant represents the "default" compression level for ZSTD. If +PhpRedis is compiled against a new enough ZSTD the value comes from the +library, otherwise we just set it to 3. + +
+ COMPRESSION_ZSTD_MIN +	+ The minimum compression level ZSTD supports, which comes from the +underlying ZSTD library if new enough. Otherwise we just set it to 1. + +
+ COMPRESSION_ZSTD_MAX +	+ The maximum compression level ZSTD supports, which comes from the +underlying ZSTD library. + +
+ COMPRESSION_LZ4 +	+ Set the compression algorithm to LZ4. PhpRedis must be compiled with +lz4 support to use this serializer. This algorithm is generally +the fastest but has a lower compression ratio than ZSTD. + +
+ OPT_SCAN +	+ Used with `\Redis::setOption()` to specify scan options. + +
+ SCAN_RETRY +	+ When enabled, this option causes PhpRedis to automatically retry `SCAN` +commands when Redis returns a non-zero cursor but no keys. This can +happen due to the nature of Redis' scanning algorithm. + +
+ SCAN_NORETRY +	+ Then enabled, this option tells PhpRedis to not retry `SCAN` commands +when Redis returns a non-zero cursor but no keys. This means that your +code must handle this case itself. + +
+ SCAN_PREFIX +	+ Tells PhpRedis to prefix keys returned from `SCAN` commands with the +currently set key prefix. + +
+ SCAN_NOPREFIX +	+ Tells PhpRedis to NOT prefix keys returned from `SCAN` commands with +the currently set key prefix. + +
+ BEFORE +	+ This is just the string "before" which is used with various list +commands to indicate an insertion point. + +
+ AFTER +	+ This is just the string "after" which is used with various list commands +to indicate an insertion point. + +
+ LEFT +	+ This is just the string "left" which is used with various list commands +such as `LMOVE`. + +
+ RIGHT +	+ This is just the string "right" which is used with various list commands +such as `LMOVE`. + +
+ OPT_MAX_RETRIES +	+ How many times should `PhpRedis` attempt to reconnect when we are +disconnected. + +
+ OPT_BACKOFF_ALGORITHM +	+ Used to specify the backoff algorithm to use when reconnecting. + +
+ BACKOFF_ALGORITHM_DEFAULT +	+ Default backoff - random delay before the first retry, then constant `base` ms. + +
+ BACKOFF_ALGORITHM_CONSTANT +	+ Constant backoff - always sleep for exactly `base` ms (capped by `cap`). + +
+ BACKOFF_ALGORITHM_UNIFORM +	+ Uniform backoff - randomly sleep between 0 and `base` ms for each retry. + +
+ BACKOFF_ALGORITHM_EXPONENTIAL +	+ Exponential backoff - doubles the delay every retry (up to 2^10) before `cap`. + +
+ BACKOFF_ALGORITHM_FULL_JITTER +	+ Full jitter - exponential delay but pick a random value between 0 and that delay. + +
+ BACKOFF_ALGORITHM_EQUAL_JITTER +	+ Equal jitter - half the exponential delay plus a random amount up to the other half. + +
+ BACKOFF_ALGORITHM_DECORRELATED_JITTER +	+ Decorrelated jitter - pick a random delay between `base` and 3x the previous delay. + +
+ OPT_BACKOFF_BASE +	+ Backoff base - minimum delay in milliseconds that algorithms start from. + +
+ OPT_BACKOFF_CAP +	+ Backoff cap - maximum delay in milliseconds that any algorithm can reach. + +

+ +Redis::expire +	For a description of the mode argument.
+ https://redis.io/docs/latest/commands/pexpireat/ +	@param string $key The key to set an expiration on. +@param int $timestamp The unix timestamp to expire at. +@param string\|null $mode A two character modifier that changes how the + command works. + +@return Redis\|bool True if an expiration was set on the key, false otherwise.

string	$subcmd
string	...$args		$value	The value which has been serialized and compressed.

string	$key	The key in question	$subcmd
mixed	$value	The data to append to the key.	string	...$args

- https://redis.io/commands/decr + https://redis.io/docs/latest/commands/decr/
- https://redis.io/commands/decrby + https://redis.io/docs/latest/commands/decrby/

- https://redis.io/commands/del + https://redis.io/docs/latest/commands/del/

string	$key	The key to delete
mixed	$value	The value to compare against the key's value.

string	$script	A string containing the LUA script
array	$args	An array of arguments to pass to this script
int	$num_keys	How many of the arguments are keys. This is needed -as redis distinguishes between key name arguments -and other data.	$key	The key to dump.

- https://redis.io/commands/exec + https://redis.io/docs/latest/commands/exec/
- https://redis.io/commands/multi + https://redis.io/docs/latest/commands/multi/

- https://redis.io/commands/exists + https://redis.io/docs/latest/commands/exists/
int	$timeout	The number of seconds after which key will be automatically deleted.
string\|null

- https://redis.io/commands/expireat + https://redis.io/docs/latest/commands/expireat/
- https://redis.io/commands/expire + https://redis.io/docs/latest/commands/expire/

bool\|null	$sync	Whether to perform the task in a blocking or non-blocking way.	string	$fn	The name of the function
array	$keys	Optional list of keys
array	$args	Optional list of args

string	$key	The sorted set to add data to.	bool\|null	$sync	Whether to perform the task in a blocking or non-blocking way.
float

- https://redis.io/commands/hmget + https://redis.io/docs/latest/commands/hmget/
string	$key	The hash to create/update	The hash to query.
array	$fieldvals	An associative array with fields and their values.	$fields	One or more fields to query in the hash.
string\|array\|null	$expiry	Info about the expiration

$redis->hrandfield('settings');
$redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]);	$redis->hsetex('profiles', ['token' => 'abc123'], ['EX' => 60]);

$redis->hvals('player:1');	$redis->hSet('player:1', 'name', 'Kim', 'score', 78);
$redis->hSet('player:1', ['name' => 'Kim', 'score' => 78]);

- https://redis.io/commands/hscan -
- https://redis.io/commands/scan + https://redis.io/docs/latest/commands/hsetnx/

- https://redis.io/commands/incr -
- https://redis.io/commands/incrby + https://redis.io/docs/latest/commands/hstrlen/

string	...$sections	Optional section(s) you wish Redis server to return.	$key	The hash to update.
int	$ttl	The time to live in milliseconds.
array	$fields	The fields to set the expiration on.
string\|null	$mode	An optional mode (NX, XX, ETC)

string	$src	The source list.
string	$dst	The destination list
string	$wherefrom	Where in the source list to retrieve the element. This can be either -`Redis::LEFT`, or `Redis::RIGHT`.	$key	The hash to query.
string	$whereto	Where in the destination list to put the element. This can be either -`Redis::LEFT`, or `Redis::RIGHT`.	array	$fields	The fields to query.

$redis->lpop('mylist');
$redis->lpop('mylist', 4);	$redis->hexpiretime('profiles', ['token']);

- https://redis.io/commands/rpush + https://redis.io/docs/latest/commands/hscan/ +
+ https://redis.io/docs/latest/commands/scan/

Redis class - Redis (View source) + Redis (View source) @@ -92,6 +481,511 @@

Redis +

Constants

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Methods

Details

Redis
class - Redis (View source) + Redis (View source)
@@ -92,6 +481,511 @@

-
at line 66
- `Redis - __construct(array $options = null) -` + +

+
at line 611
+ `Redis __construct(array|null $options = null)`

-
at line 68
- `- __destruct() -` + +

+
at line 620
+ `__destruct()`

-
at line 80
- `string - _compress(string $value) -` + +

+
at line 635
+ `string _compress(string $value)`

-
at line 92
- `string - _uncompress(string $value) -` + +

+
at line 650
+ `string _uncompress(string $value)`

-
at line 102
- `string - _prefix(string $key) -` + +

+
at line 663
+ `string _prefix(string $key)`

-
at line 114
- `string - _serialize(mixed $value) -` + +

+
at line 678
+ `string _serialize(mixed $value)`

-
at line 126
- `mixed - _unserialize(string $value) -` + +

+
at line 693
+ `mixed _unserialize(string $value)`

-
at line 136
- `string - _pack(mixed $value) -` + +

+
at line 708
+ `string _pack(mixed $value)`

-
at line 146
- `mixed - _unpack(string $value) -` + +

+
at line 727
+ `string _digest(mixed $value)`

-
at line 148
- `mixed - acl(string $subcmd, string ...$args) -` + +

+
at line 741
+ `mixed _unpack(string $value)`

+ https://docs.keydb.dev/docs/commands/#expiremember +
+ https://redis.io/docs/latest/commands/expiremember/ +

- https://redis.io/commands/lset + https://redis.io/docs/latest/commands/incr/ +
+ https://redis.io/docs/latest/commands/incrby/

string	$key	The key to increment.
int	$value	The amount to increment.

string	$key	The list to query.
int	$start	The beginning index to retrieve. This number can be negative -meaning start from the end of the list.
int	$end	The end index to retrieve. This can also be negative to start -from the end of the list.	+ https://redis.io/docs/latest/commands/incrbyfloat/ +

$redis->lrange('mylist', 0, -1); // the whole list
$redis->lrange('mylist', -2, -1); // the last two elements in the list.	$redis->incrbyfloat('tau', 3.1415926); +$redis->incrbyfloat('tau', 3.1415926);

string	$key	The list to truncate.
mixed	$value	The value to remove.
int	$count	How many elements matching the value to remove.	...$sections	Optional section(s) you wish Redis server to return.

string	$key	The list to trim
int	$start	The starting index to keep
int	$end	The ending index to keep.

string	$key	The key to move
int	$index	+ https://redis.io/docs/latest/commands/linsert/ +

array	$key_values	An array of keys with their values.	string	$src	The source list.
string	$dst	The destination list
string	$wherefrom	Where in the source list to retrieve the element. This can be either + + `Redis::LEFT`, or `Redis::RIGHT`. +
string	$whereto	Where in the destination list to put the element. This can be either + + `Redis::LEFT`, or `Redis::RIGHT`. +

string	$key	The list to pop from.
int	$count	Optional number of elements to remove. By default one element is popped.