From ef4699c726300a631fc9e1439b1c2aaa2004a3e6 Mon Sep 17 00:00:00 2001 From: michael-grunder Date: Thu, 10 Nov 2022 19:31:38 -0800 Subject: Documentation: Rework more formatting and add example sections. [skip ci] --- docs/Redis.html | 1345 +++++++++++++++++++++++------------------------ docs/doc-index.html | 8 +- docs/doctum-search.json | 2 +- docs/renderer.index | 2 +- redis.stub.php | 574 +++++++++----------- redis_arginfo.h | 2 +- redis_legacy_arginfo.h | 2 +- 7 files changed, 919 insertions(+), 1016 deletions(-) diff --git a/docs/Redis.html b/docs/Redis.html index 05d15dcd..575df3d2 100644 --- a/docs/Redis.html +++ b/docs/Redis.html @@ -425,8 +425,7 @@ no elements are available.

config(string $operation, array|string|null $key_or_settings = NULL, string|null $value = NULL) -

Execute the Redis CONFIG command in a variety of ways. What the command does in particular depends -on the $operation qualifier.

+

Execute the Redis CONFIG command in a variety of ways.

@@ -624,8 +623,7 @@ modifies how the command will execute.

expireAt(string $key, int $timestamp, string|null $mode = NULL) -

Set a key's expiration to a specific Unix timestamp in seconds. If -connected to Redis >= 7.0.0 you can pass an optional 'mode' argument.

+

Set a key to expire at an exact unix timestamp.

@@ -839,8 +837,7 @@ connected to Redis >= 7.0.0 you can pass an optional 'mode' argument.

getDBNum() -

No description

-
+

Get the database number PhpRedis thinks we're connected to.

@@ -3603,7 +3600,7 @@ was 0 and end was 2, Redis would only search the first two bits.

-
at line 259
+
at line 255
Redis|array|null|false blPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed ...$extra_args) @@ -3614,11 +3611,7 @@ was 0 and end was 2, Redis would only search the first two bits.

Pop an element off the beginning of a Redis list or lists, potentially blocking up to a specified -timeout. This method may be called in two distinct ways, of which examples are provided below.

// Variadic, with the final argument a timeout.
-$redis->blPop('list1', 'list2', 'list3', 1.5);
-
-// Alternatively, you can send an array of keys
-$relay->blPop(['list1', 'list2', 'list3'], 1.5);

+timeout. This method may be called in two distinct ways, of which examples are provided below.

Parameters

@@ -3668,13 +3661,22 @@ the command.

+

Examples

+ + + + + + 
$redis->blPop('list1', 'list2', 'list3', 1.5);

+$relay->blPop(['list1', 'list2', 'list3'], 1.5);
+

-
at line 269
+
at line 265
Redis|array|null|false brPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed ...$extra_args) @@ -3744,7 +3746,7 @@ Redis::blPop

-
at line 283
+
at line 279
Redis|string|false brpoplpush(string $src, string $dst, int|float $timeout) @@ -3809,7 +3811,7 @@ to Redis >= 6.0.0 to send a floating point timeout.

-
at line 313
+
at line 305
Redis|array|false bzPopMax(string|array $key, string|int $timeout_or_key, mixed ...$extra_args) @@ -3821,11 +3823,6 @@ to Redis >= 6.0.0 to send a floating point timeout.

POP the maximum scoring element off of one or more sorted sets, blocking up to a specified timeout if no elements are available.

Following are examples of the two main ways to call this method.

-
// Method 1 - Variadic, with the last argument being our timeout
-$redis->bzPopMax('key1', 'key2', 'key3', 1.5);
-
-// Method 2 - A single array of keys, followed by the timeout
-$redis->bzPopMax(['key1', 'key2', 'key3'], 1.5);

NOTE: We reccomend calling this function with an array and a timeout as the other strategy may be deprecated in future versions of PhpRedis

@@ -3877,13 +3874,22 @@ which needs to be a timeout.

+

Examples

+ + + + + + 
$redis->bzPopMax('key1', 'key2', 'key3', 1.5);

+$redis->bzPopMax(['key1', 'key2', 'key3'], 1.5);
+

-
at line 325
+
at line 317
Redis|array|false bzPopMin(string|array $key, string|int $timeout_or_key, mixed ...$extra_args) @@ -3954,7 +3960,7 @@ Redis::bzPopMax

-
at line 344
+
at line 336
Redis|array|null|false bzmpop(float $timeout, array $keys, string $from, int $count = 1) @@ -4017,7 +4023,7 @@ instead return NULL when Redis doesn't pop any elements.

-
at line 358
+
at line 350
Redis|array|null|false zmpop(array $keys, string $from, int $count = 1) @@ -4081,7 +4087,7 @@ pop the lowest or highest scoring elements.

-
at line 375
+
at line 367
Redis|array|null|false blmpop(float $timeout, array $keys, string $from, int $count = 1) @@ -4152,7 +4158,7 @@ were empty.

-
at line 391
+
at line 383
Redis|array|null|false lmpop(array $keys, string $from, int $count = 1) @@ -4217,7 +4223,7 @@ were empty.

-
at line 410
+
at line 399
bool clearLastError() @@ -4227,14 +4233,7 @@ were empty.

-

Reset any last error on the connection to NULL

$redis = new Redis(['host' => 'localhost']);
-
-$redis->set('string', 'this_is_a_string');
-$redis->smembers('string');
-
-var_dump($redis->getLastError());
-$redis->clearLastError();
-var_dump($redis->getLastError());

+

Reset any last error on the connection to NULL

@@ -4262,13 +4261,26 @@ Redis::getLastError +

Examples

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

+$redis->set('string', 'this_is_a_string');

+$redis->smembers('string');

+var_dump($redis->getLastError());

+$redis->clearLastError();

+var_dump($redis->getLastError());
+

-
at line 412
+
at line 401
mixed client(string $opt, mixed ...$args) @@ -4316,7 +4328,7 @@ Redis::getLastError

-
at line 414
+
at line 403
bool close() @@ -4349,7 +4361,7 @@ Redis::getLastError

-
at line 416
+
at line 405
mixed command(string $opt = null, string|array $arg) @@ -4397,7 +4409,7 @@ Redis::getLastError

-
at line 443
+
at line 424
mixed config(string $operation, array|string|null $key_or_settings = NULL, string|null $value = NULL) @@ -4407,13 +4419,8 @@ Redis::getLastError
-

Execute the Redis CONFIG command in a variety of ways. What the command does in particular depends -on the $operation qualifier.

Operations that PhpRedis supports are: RESETSTAT, REWRITE, GET, and SET.

-
$redis->config('GET', 'timeout');
-$redis->config('GET', ['timeout', 'databases']);
-
-$redis->config('SET', 'timeout', 30);
-$redis->config('SET', ['timeout' => 30, 'loglevel' => 'warning']);

+

Execute the Redis CONFIG command in a variety of ways.

What the command does in particular depends on the $operation qualifier. +Operations that PhpRedis supports are: RESETSTAT, REWRITE, GET, and SET.

Parameters

@@ -4422,23 +4429,17 @@ $redis->config('SET', ['timeout' => 30, 'loglevel' => 'warning']); string $operation -

The CONFIG subcommand to execute -@param array|string|null $key_or_setting Can either be a setting string for the GET/SET operation or -an array of settings or settings and values. -Note: Redis 7.0.0 is required to send an array of settings. -@param string $value The setting value when the operation is SET.

-

@return mixed Can return various things depending on arguments sent.

-

https://redis.io/commands/config

+

The CONFIG operation to execute (e.g. GET, SET, REWRITE).

array|string|null $key_or_settings - +

One or more keys or values.

string|null $value - +

The value if this is a CONFIG SET operation.

@@ -4454,14 +4455,36 @@ Note: Redis 7.0.0 is required to send an array of settings. +

See also

+ + + + + + +
+ https://redis.io/commands/config +
+ +

Examples

+ + + + + + 
$redis->config('GET', 'timeout');

+$redis->config('GET', ['timeout', 'databases']);

+$redis->config('SET', 'timeout', 30);

+$redis->config('SET', ['timeout' => 30, 'loglevel' => 'warning']);
+

-
at line 445
+
at line 426
bool connect(string $host, int $port = 6379, float $timeout = 0, string $persistent_id = null, int $retry_interval = 0, float $read_timeout = 0, array $context = null) @@ -4534,7 +4557,7 @@ Note: Redis 7.0.0 is required to send an array of settings.

-
at line 495
+
at line 462
Redis|bool copy(string $src, string $dst, array $options = null) @@ -4544,44 +4567,7 @@ Note: Redis 7.0.0 is required to send an array of settings.
-

Make a copy of a key.

$redis = new Redis(['host' => 'localhost']);
-
-$redis->pipeline()
-      ->select(1)
-      ->del('newkey')
-      ->select(0)
-      ->del('newkey')
-      ->mset(['source1' => 'value1', 'exists' => 'old_value'])
-      ->exec();
-
-// Will succeed, as 'newkey' doesn't exist
-var_dump($redis->copy('source1', 'newkey'));
-
-// Will succeed, because 'newkey' doesn't exist in DB 1
-var_dump($redis->copy('source1', 'newkey', ['db' => 1]));
-
-// Will fail, because 'exists' does exist
-var_dump($redis->copy('source1', 'exists'));
-
-// Will succeed, because even though 'exists' is a key, we sent the REPLACE option.
-var_dump($redis->copy('source1', 'exists', ['REPLACE' => true]));
-

Available Options

- - - - - - - - - - - - - - - -
OPTIONTYPEDESCRIPTION
OPT_MAX_RETRIESintfoo

+

Make a copy of a key.

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

Parameters

@@ -4632,13 +4618,32 @@ var_dump($redis->copy('source1', 'exists', ['REPLACE' => true])); +

Examples

+ + + + + + 
$redis->pipeline()

+      ->select(1)

+      ->del('newkey')

+      ->select(0)

+      ->del('newkey')

+      ->mset(['source1' => 'value1', 'exists' => 'old_value'])

+      ->exec();

+

+var_dump($redis->copy('source1', 'newkey'));

+var_dump($redis->copy('source1', 'newkey', ['db' => 1]));

+var_dump($redis->copy('source1', 'exists'));

+var_dump($redis->copy('source1', 'exists', ['REPLACE' => true]));
+

-
at line 516
+
at line 479
Redis|int|false dbSize() @@ -4648,15 +4653,7 @@ var_dump($redis->copy('source1', 'exists', ['REPLACE' => true])); -

Return the number of keys in the currently selected Redis database.

$redis = new Redis(['host' => 'localhost']);
-
-$redis->flushdb();
-
-$redis->set('foo', 'bar');
-var_dump($redis->dbsize());
-
-$redis->mset(['a' => 'a', 'b' => 'b', 'c' => 'c', 'd' => 'd']);
-var_dump($redis->dbsize());

+

Return the number of keys in the currently selected Redis database.

@@ -4683,13 +4680,26 @@ var_dump($redis->dbsize());

+

Examples

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

+$redis->flushdb();

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

+var_dump($redis->dbsize());

+$redis->mset(['a' => 'a', 'b' => 'b', 'c' => 'c', 'd' => 'd']);

+var_dump($redis->dbsize());
+

-
at line 518
+
at line 481
Redis|string debug(string $key) @@ -4732,7 +4742,7 @@ var_dump($redis->dbsize());

-
at line 544
+
at line 507
Redis|int|false decr(string $key, int $by = 1) @@ -4804,7 +4814,7 @@ PhpRedis will actually send the DECRBY command.

-
at line 570
+
at line 528
Redis|int|false decrBy(string $key, int $value) @@ -4814,7 +4824,11 @@ PhpRedis will actually send the DECRBY command.

-

Decrement a redis integer by a value

+

Decrement a redis integer by a value

$redis = new Redis(['host' => 'localhost');
+
+$redis->set('counter', 3);
+var_dump($redis->decrby('counter', 1));
+var_dump($redis->decrby('counter', 2));

Parameters

@@ -4838,18 +4852,7 @@ PhpRedis will actually send the DECRBY command.

- +
Redis|int|false

The new value of the key or false on failure.

-
<?php
-$redis = new Redis(['host' => 'localhost');
-
-$redis->set('counter', 3);
-var_dump($redis->decrby('counter', 1));
-var_dump($redis->decrby('counter', 2));
-
-// --- OUTPUT ---
-// int(2)
-// int(0)
-?>

The new value of the key or false on failure.
@@ -4873,7 +4876,7 @@ var_dump($redis->decrby('counter', 2));

-
at line 602
+
at line 557
Redis|int|false del(array|string $key, string ...$other_keys) @@ -4883,7 +4886,17 @@ var_dump($redis->decrby('counter', 2));
-

Delete one or more keys from Redis.

+

Delete one or more keys from Redis.

This method can be called in two distinct ways. The first is to pass a single array +of keys to delete, and the second is to pass N arguments, all names of keys. See +below for an example of both strategies.

+
$redis = new Redis(['host' => 'localhost']);
+
+for ($i = 0; $i < 5; $i++) {
+    $redis->set("key:$i", "val:$i");
+}
+
+var_dump($redis->del('key:0', 'key:1'));
+var_dump($redis->del(['key:2', 'key:3', 'key:4']));

Parameters

@@ -4897,24 +4910,7 @@ var_dump($redis->decrby('counter', 2)); string ...$other_keys -

One or more additional keys passed in a variadic fashion.

-

This method can be called in two distinct ways. The first is to pass a single array -of keys to delete, and the second is to pass N arguments, all names of keys. See -below for an example of both strategies.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-for ($i = 0; $i < 5; $i++) {
-    $redis->set("key:$i", "val:$i");
-}
-
-var_dump($redis->del('key:0', 'key:1'));
-var_dump($redis->del(['key:2', 'key:3', 'key:4']));
-
-// --- OUTPUT ---
-// int(2)
-// int(3)
-?>
+

One or more additional keys passed in a variadic fashion.

@@ -4924,7 +4920,7 @@ var_dump($redis->del(['key:2', 'key:3', 'key:4'])); - +
Redis|int|false

The number of keys that were deleted
@@ -4948,7 +4944,7 @@ var_dump($redis->del(['key:2', 'key:3', 'key:4']));

-
at line 608
+
at line 563
Redis|int|false delete(array|string $key, string ...$other_keys) deprecated @@ -5003,7 +4999,7 @@ var_dump($redis->del(['key:2', 'key:3', 'key:4']));

-
at line 633
+
at line 586
Redis|bool discard() @@ -5013,18 +5009,7 @@ var_dump($redis->del(['key:2', 'key:3', 'key:4']));
-

Discard a transaction currently in progress.

-
-
- -

Return Value

- - - - - +
Redis|bool

True if we could discard the transaction.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
+                            
Discard a transaction currently in progress.
                
$redis = new Redis(['host' => 'localhost']);
 
 $redis->multi()->set('foo', 'bar')->get('foo');
 
@@ -5035,9 +5020,16 @@ $redis->getMode();
 $redis->discard();
 
 // Redis::ATOMIC
-$redis->getMode();
+$redis->getMode();
        
+        
+        

+            
+                            
Return Value

 
-?>
+ + +
Redis|bool

True if we could discard the transaction.
@@ -5050,7 +5042,7 @@ $redis->getMode();

-
at line 669
+
at line 614
Redis|string dump(string $key) @@ -5060,7 +5052,19 @@ $redis->getMode();
-

Dump Redis' internal binary representation of a key.

+

Dump Redis' internal binary representation of a key.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('zset');
+
+$redis->zadd('zset', 0, 'zero', 1, 'one', 2, 'two');
+
+// Retrieve the binary representation of the zset
+$binary = $redis->dump('zset');
+
+// Retore it to a different name
+$redis->restore('new-zset', 0, $binary);
+
+$redis->zRange('new-zset', 0, -1, true);

Parameters

@@ -5079,28 +5083,7 @@ $redis->getMode(); - +
Redis|string

A binary string representing the key's value.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('zset');
-
-$redis->zadd('zset', 0, 'zero', 1, 'one', 2, 'two');
-
-// Retrieve the binary representation of the zset
-$binary = $redis->dump('zset');
-
-// Retore it to a different name
-$redis->restore('new-zset', 0, $binary);
-
-// Array
-// (
-//     [zero] => 0
-//     [one] => 1
-//     [two] => 2
-// )
-$redis->zRange('new-zset', 0, -1, true);
-?>

A binary string representing the key's value.
@@ -5124,7 +5107,7 @@ $redis->zRange('new-zset', 0, -1, true);

-
at line 692
+
at line 631
Redis|string|false echo(string $str) @@ -5134,7 +5117,9 @@ $redis->zRange('new-zset', 0, -1, true);
-

Have Redis repeat back an arbitrary string to the client.

+

Have Redis repeat back an arbitrary string to the client.

$redis = new Redis(['host' => 'localhost']);
+
+var_dump($redis->echo('Hello, World'));

Parameters

@@ -5153,16 +5138,7 @@ $redis->zRange('new-zset', 0, -1, true); - +
Redis|string|false

The string sent to Redis or false on failure.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-var_dump($redis->echo('Hello, World'));
-
-// --- OUTPUT ---
-// string(12) "Hello, World"
-
-?>

The string sent to Redis or false on failure.
@@ -5186,7 +5162,7 @@ var_dump($redis->echo('Hello, World'));

-
at line 708
+
at line 647
mixed eval(string $script, array $args = [], int $num_keys = 0) @@ -5252,7 +5228,7 @@ strings, arrays, nested arrays, etc.

-
at line 716
+
at line 655
mixed eval_ro(string $script_sha, array $args = [], int $num_keys = 0) @@ -5317,7 +5293,7 @@ Redis::eval

-
at line 732
+
at line 674
mixed evalsha(string $sha1, array $args = [], int $num_keys = 0) @@ -5357,7 +5333,7 @@ the SHA1 hash of the script.

- +
mixed

Returns whatever the specific script does.
@@ -5388,7 +5364,7 @@ Redis::eval

-
at line 740
+
at line 682
mixed evalsha_ro(string $sha1, array $args = [], int $num_keys = 0) @@ -5453,7 +5429,7 @@ Redis::evalsha

-
at line 778
+
at line 708
Redis|array|false exec() @@ -5463,17 +5439,7 @@ Redis::evalsha
-

Execute either a MULTI or PIPELINE block and return the array of replies.

-
-
- -

Return Value

- - - - - +
Redis|array|false

The array of pipeline'd or multi replies or false on failure.

-
$redis = new Redis(['host' => 'localhost']);
+                            
Execute either a MULTI or PIPELINE block and return the array of replies.
                
$redis = new Redis(['host' => 'localhost']);
 
 $res = $redis->multi()
              ->set('foo', 'bar')
@@ -5482,20 +5448,16 @@ $res = $redis->multi()
              ->rpush('list', 'one', 'two', 'three')
              ->exec();
 
-var_dump($res);
+var_dump($res);
        
+        
+        

+            
+                            
Return Value

 
-// --- OUTPUT ---
-// array(4) {
-//   [0]=>
-//   bool(true)           // set('foo', 'bar')
-//   [1]=>
-//   string(3) "bar"      // get('foo')
-//   [2]=>
-//   int(1)               // del('list')
-//   [3]=>
-//   int(3)               // rpush('list', 'one', 'two', 'three')
-// }
-?>
+ + +
Redis|array|false

The array of pipeline'd or multi replies or false on failure.
@@ -5539,7 +5501,7 @@ Redis::multi

-
at line 811
+
at line 739
Redis|int|bool exists(mixed $key, mixed ...$other_keys) @@ -5549,7 +5511,21 @@ Redis::multi
-

Test if one or more keys exist.

+

Test if one or more keys exist.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->multi()
+      ->mset(['k1' => 'v1', 'k2' => 'v2', 'k3' => 'v3', 'k4' => 'v4'])
+      ->exec();
+
+// Using a single array of keys
+var_dump($redis->exists(['k1', 'k2', 'k3']));
+
+// Calling via variadic arguments
+var_dump($redis->exists('k4', 'k5', 'notakey'));
+
+// --- OUTPUT ---
+// int(3)
+// int(1)

Parameters

@@ -5574,24 +5550,7 @@ additional keys to test.

- +
Redis|int|bool

The number of keys that do exist and false on failure

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->multi()
-      ->mset(['k1' => 'v1', 'k2' => 'v2', 'k3' => 'v3', 'k4' => 'v4'])
-      ->exec();
-
-// Using a single array of keys
-var_dump($redis->exists(['k1', 'k2', 'k3']));
-
-// Calling via variadic arguments
-var_dump($redis->exists('k4', 'k5', 'notakey'));
-
-// --- OUTPUT ---
-// int(3)
-// int(1)
-?>

The number of keys that do exist and false on failure
@@ -5615,7 +5574,7 @@ var_dump($redis->exists('k4', 'k5', 'notakey'));

-
at line 828
+
at line 760
Redis|bool expire(string $key, int $timeout, string|null $mode = NULL) @@ -5647,11 +5606,11 @@ modifies how the command will execute.

string|null $mode

A two character modifier that changes how the -command works. -NX - Set expiry only if key has no expiry +command works.

+
NX - Set expiry only if key has no expiry
 XX - Set expiry only if key has an expiry
 LT - Set expiry only when new expiry is < current expiry
-GT - Set expiry only when new expiry is > current expiry

+GT - Set expiry only when new expiry is > current expiry
@@ -5661,7 +5620,7 @@ GT - Set expiry only when new expiry is > current expiry

- +
Redis|bool

True if an expiration was set and false otherwise.
@@ -5685,7 +5644,7 @@ GT - Set expiry only when new expiry is > current expiry

-
at line 840
+
at line 786
Redis|bool expireAt(string $key, int $timestamp, string|null $mode = NULL) @@ -5695,8 +5654,7 @@ GT - Set expiry only when new expiry is > current expiry

-

Set a key's expiration to a specific Unix timestamp in seconds. If -connected to Redis >= 7.0.0 you can pass an optional 'mode' argument.

+

Set a key to expire at an exact unix timestamp.

Parameters

@@ -5705,17 +5663,17 @@ connected to Redis >= 7.0.0 you can pass an optional 'mode' argument.

string $key - +

The key to set an expiration on.

int $timestamp - +

The unix timestamp to expire at.

string|null $mode - +

An option 'mode' that modifies how the command acts (see Redis::expire).

@@ -5725,7 +5683,7 @@ connected to Redis >= 7.0.0 you can pass an optional 'mode' argument.

- +
Redis|bool

True if an expiration was set, false if not.
@@ -5735,15 +5693,23 @@ connected to Redis >= 7.0.0 you can pass an optional 'mode' argument.

+ + + + + + + + - +
+ https://redis.io/commands/expireat +
+ https://redis.io/commands/expire +
Redis::expire For a description of the mode argument. - -@param string $key The key to set an expiration on. -@param string $mode A two character modifier that changes how the - command works.
@@ -5754,7 +5720,7 @@ Redis::expire

-
at line 842
+
at line 788
Redis|bool failover(array|null $to = null, bool $abort = false, int $timeout = 0) @@ -5807,7 +5773,7 @@ Redis::expire

-
at line 871
+
at line 812
Redis|int|false expiretime(string $key) @@ -5817,7 +5783,14 @@ Redis::expire
-

Get the expiration of a given key as a unix timestamp

+

Get the expiration of a given key as a unix timestamp

$redis = new Redis(['host' => 'localhost']);
+
+$redis->set('expiry-key', 'this will last a very long time');
+
+// Expire this key at 2222/02/22 02:22:22 GMT
+$redis->expireAt('expiry-key', 7955144542);
+
+var_dump($redis->expiretime('expiry-key'));

Parameters

@@ -5837,21 +5810,7 @@ Redis::expire Redis|int|false

The timestamp when the key expires, or -1 if the key has no expiry -and -2 if the key doesn't exist.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->set('expiry-key', 'this will last a very long time');
-
-// Expire this key at 2222/02/22 02:22:22 GMT
-$redis->expireAt('expiry-key', 7955144542);
-
-var_dump($redis->expiretime('expiry-key'));
-
-// --- OUTPUT ---
-// int(7955144542)
-
-?>php
+and -2 if the key doesn't exist.

@@ -5875,7 +5834,7 @@ var_dump($redis->expiretime('expiry-key'));

-
at line 884
+
at line 825
Redis|int|false pexpiretime(string $key) @@ -5936,7 +5895,7 @@ Redis::expiretime

-
at line 896
+
at line 835
Redis|bool flushAll(bool|null $sync = null) @@ -5955,11 +5914,7 @@ Redis::expiretime bool|null $sync -

Whether to perform the task in a blocking or non-blocking way. -when TRUE, PhpRedis will execute FLUSHALL SYNC, and when FALSE we -will execute FLUSHALL ASYNC. If the argument is omitted, we -simply execute FLUSHALL and whether it is SYNC or ASYNC depends -on Redis' lazyfree-lazy-user-flush config setting.

+

Whether to perform the task in a blocking or non-blocking way.

@@ -5975,6 +5930,17 @@ on Redis' lazyfree-lazy-user-flush config setting.

+

See also

+ + + + + + +
+ https://redis.io/commands/flushall +
+

@@ -5982,7 +5948,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 908
+
at line 845
Redis|bool flushDB(bool|null $sync = null) @@ -6001,11 +5967,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

bool|null $sync -

Whether to perform the task in a blocking or non-blocking way. -when TRUE, PhpRedis will execute FLUSHDB SYNC, and when FALSE we -will execute FLUSHDB ASYNC. If the argument is omitted, we -simply execute FLUSHDB and whether it is SYNC or ASYNC depends -on Redis' lazyfree-lazy-user-flush config setting.

+

Whether to perform the task in a blocking or non-blocking way.

@@ -6021,6 +5983,17 @@ on Redis' lazyfree-lazy-user-flush config setting.

+

See also

+ + + + + + +
+ https://redis.io/commands/flush +
+

@@ -6028,7 +6001,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 910
+
at line 847
Redis|int|false geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples_and_options) @@ -6091,7 +6064,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 912
+
at line 849
Redis|float|false geodist(string $key, string $src, string $dst, string|null $unit = null) @@ -6149,7 +6122,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 914
+
at line 851
Redis|array|false geohash(string $key, string $member, string ...$other_members) @@ -6202,7 +6175,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 916
+
at line 853
Redis|array|false geopos(string $key, string $member, string ...$other_members) @@ -6255,7 +6228,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 918
+
at line 855
mixed georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = []) @@ -6323,7 +6296,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 920
+
at line 857
mixed georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = []) @@ -6391,7 +6364,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 922
+
at line 859
mixed georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = []) @@ -6454,7 +6427,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 924
+
at line 861
mixed georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = []) @@ -6517,7 +6490,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 926
+
at line 863
array geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = []) @@ -6580,7 +6553,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 928
+
at line 865
Redis|array|int|false geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = []) @@ -6648,7 +6621,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 930
+
at line 867
mixed get(string $key) @@ -6691,7 +6664,7 @@ on Redis' lazyfree-lazy-user-flush config setting.

-
at line 939
+
at line 876
mixed getAuth() @@ -6735,7 +6708,7 @@ Redis::auth

-
at line 941
+
at line 878
Redis|int|false getBit(string $key, int $idx) @@ -6783,7 +6756,7 @@ Redis::auth

-
at line 943
+
at line 880
Redis|string|bool getEx(string $key, array $options = []) @@ -6831,7 +6804,7 @@ Redis::auth

-
at line 945
+
at line 892
int getDBNum() @@ -6841,8 +6814,7 @@ Redis::auth
-

No description

- +

Get the database number PhpRedis thinks we're connected to.

This value is updated internally in PhpRedis each time Redis::select is called.

@@ -6851,12 +6823,30 @@ Redis::auth - +
int

database we're connected to.
+

See also

+ + + + + + + + + + +
+ +Redis::select +
+ https://redis.io/commands/select +
+

@@ -6864,7 +6854,7 @@ Redis::auth

-
at line 947
+
at line 894
Redis|string|bool getDel(string $key) @@ -6907,7 +6897,7 @@ Redis::auth

-
at line 954
+
at line 901
string getHost() @@ -6939,7 +6929,7 @@ Redis::auth

-
at line 961
+
at line 908
string|null getLastError() @@ -6971,7 +6961,7 @@ Redis::auth

-
at line 969
+
at line 916
int getMode() @@ -7003,7 +6993,7 @@ Redis::auth

-
at line 978
+
at line 925
mixed getOption(int $option) @@ -7057,7 +7047,7 @@ Redis::setOption

-
at line 985
+
at line 932
string|null getPersistentID() @@ -7089,7 +7079,7 @@ Redis::setOption

-
at line 992
+
at line 939
int getPort() @@ -7121,7 +7111,7 @@ Redis::setOption

-
at line 1017
+
at line 965
Redis|string|false getRange(string $key, int $start, int $end) @@ -7131,7 +7121,16 @@ Redis::setOption
-

Retrieve a substring of a string by index.

+

Retrieve a substring of a string by index.

$redis = new Redis(['host' => 'localhost']);
+
+$word = 'Supercalifragilisticexpialidocious';
+$redis->set('silly-word', $word);
+
+// string "super"
+var_dump($redis->getRange('silly-word', 0, 4));
+
+// string(7) "docious"
+var_dump($redis->getRange('silly-word', -7, -1));

Parameters

@@ -7160,25 +7159,23 @@ Redis::setOption - +
Redis|string|false

The substring or false on failure.

-

-<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$word = 'Supercalifragilisticexpialidocious';
-$redis->set('silly-word', $word);
-
-// string "super"
-var_dump($redis->getRange('silly-word', 0, 4));
-
-// string(7) "docious"
-var_dump($redis->getRange('silly-word', -7, -1));
-?>

The substring or false on failure.
+

See also

+ + + + + + +
+ https://redis.io/commands/getrange +
+

@@ -7186,7 +7183,7 @@ var_dump($redis->getRange('silly-word', -7, -1));

-
at line 1057
+
at line 1003
Redis|string|array|int|false lcs(string $key1, string $key2, array|null $options = NULL) @@ -7196,7 +7193,13 @@ var_dump($redis->getRange('silly-word', -7, -1));
-

Get the longest common subsequence between two string keys.

+

Get the longest common subsequence between two string keys.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->set('seq1', 'gtaggcccgcacggtctttaatgtatccctgtttaccatgccatacctgagcgcatacgc');
+$redis->set('seq2', 'aactcggcgcgagtaccaggccaaggtcgttccagagcaaagactcgtgccccgctgagc');
+
+// string(37) "acccgcacggcaagtcgttccagcaactggcgctagc"
+var_dump($redis->lcs('seq1', 'seq2'));

Parameters

@@ -7236,32 +7239,31 @@ var_dump($redis->getRange('silly-word', -7, -1)); - +
Redis|string|array|int|false

Various reply types depending on options.

-

-<?php
-<?php
-
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->set('seq1', 'gtaggcccgcacggtctttaatgtatccctgtttaccatgccatacctgagcgcatacgc');
-$redis->set('seq2', 'aactcggcgcgagtaccaggccaaggtcgttccagagcaaagactcgtgccccgctgagc');
-
-// string(37) "acccgcacggcaagtcgttccagcaactggcgctagc"
-var_dump($redis->lcs('seq1', 'seq2'));
-?>

Various reply types depending on options.
- - + +

See also

+ + + + + + +
+ https://redis.io/commands/lcs +
+ +

-
at line 1064
+
at line 1010
float getReadTimeout() @@ -7293,7 +7295,7 @@ var_dump($redis->lcs('seq1', 'seq2'));

-
at line 1088
+
at line 1034
Redis|string|false getset(string $key, mixed $value) @@ -7303,7 +7305,15 @@ var_dump($redis->lcs('seq1', 'seq2'));
-

Sets a key and returns any previously set value, if the key already existed.

+

Sets a key and returns any previously set value, if the key already existed.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('captain');
+
+// bool(false)
+var_dump($redis->getset('captain', 'Pike'));
+
+// string(4) "Pike"
+var_dump($redis->getset('captain', 'Kirk'));

Parameters

@@ -7327,23 +7337,23 @@ var_dump($redis->lcs('seq1', 'seq2')); - +
Redis|string|false

The old value of the key or false if it didn't exist.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('captain');
-
-// bool(false)
-var_dump($redis->getset('captain', 'Pike'));
-
-// string(4) "Pike"
-var_dump($redis->getset('captain', 'Kirk'));
-?>

The old value of the key or false if it didn't exist.
+

See also

+ + + + + + +
+ https://redis.io/commands/getset +
+

@@ -7351,7 +7361,7 @@ var_dump($redis->getset('captain', 'Kirk'));

-
at line 1095
+
at line 1041
float|false getTimeout() @@ -7383,7 +7393,7 @@ var_dump($redis->getset('captain', 'Kirk'));

-
at line 1097
+
at line 1043
int|false getTransferredBytes() @@ -7416,7 +7426,7 @@ var_dump($redis->getset('captain', 'Kirk'));

-
at line 1123
+
at line 1067
Redis|int|false hDel(string $key, string $field, string ...$other_fields) @@ -7426,7 +7436,14 @@ var_dump($redis->getset('captain', 'Kirk'));
-

Remove one or more fields from a hash.

+

Remove one or more fields from a hash.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('people');
+
+$redis->hmset('comms', ['Alice' => 'ecc', 'Bob' => 'rsa', 'Mallory' => 'haxx00r']);
+
+// int(1)
+$redis->hDel('comms', 'Mallory', 'Archibald');

Parameters

@@ -7455,17 +7472,7 @@ var_dump($redis->getset('captain', 'Kirk')); - +
Redis|int|false

The number of fields actually removed.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('people');
-
-$redis->hmset('comms', ['Alice' => 'ecc', 'Bob' => 'rsa', 'Mallory' => 'haxx00r']);
-
-// int(1)
-$redis->hDel('comms', 'Mallory', 'Archibald');
-?>

The number of fields actually removed.
@@ -7489,7 +7496,7 @@ $redis->hDel('comms', 'Mallory', 'Archibald');

-
at line 1151
+
at line 1091
Redis|bool hExists(string $key, string $field) @@ -7499,7 +7506,14 @@ $redis->hDel('comms', 'Mallory', 'Archibald');
-

Checks whether a field exists in a hash.

+

Checks whether a field exists in a hash.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('captains');
+
+$redis->hmset('captains', ['Kirk' => 'Enterprise', 'Picard' => 'Enterprise-D', 'Sisko' => 'Defiant']);
+
+$redis->hExists('captains', 'Pike');
+$redis->hExists('captains', 'Picard');

Parameters

@@ -7523,20 +7537,7 @@ $redis->hDel('comms', 'Mallory', 'Archibald'); - +
Redis|bool

True if it exists, false if not.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('captains');
-
-$redis->hmset('captains', ['Kirk' => 'Enterprise', 'Picard' => 'Enterprise-D', 'Sisko' => 'Defiant']);
-
-bool(false)
-$redis->hExists('captains', 'Pike');
-
-bool(true)
-$redis->hExists('captains', 'Picard');
-?>

True if it exists, false if not.
@@ -7560,7 +7561,7 @@ $redis->hExists('captains', 'Picard');

-
at line 1153
+
at line 1093
mixed hGet(string $key, string $member) @@ -7608,7 +7609,7 @@ $redis->hExists('captains', 'Picard');

-
at line 1184
+
at line 1122
Redis|array|false hGetAll(string $key) @@ -7618,7 +7619,21 @@ $redis->hExists('captains', 'Picard');
-

Read every field and value from a hash.

+

Read every field and value from a hash.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('comms');
+
+$redis->hmset('comms', ['Alice' => 'ecc', 'Bob' => 'rsa', 'Mallory' => 'haxx00r']);
+
+// array(3) {
+//   ["Alice"]=>
+//   string(3) "ecc"
+//   ["Bob"]=>
+//   string(3) "rsa"
+//   ["Mallory"]=>
+//   string(7) "haxx00r"
+// }
+$redis->hGetAll('comms');

Parameters

@@ -7637,24 +7652,7 @@ $redis->hExists('captains', 'Picard'); - +
Redis|array|false

All fields and values or false if the key didn't exist.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('comms');
-
-$redis->hmset('comms', ['Alice' => 'ecc', 'Bob' => 'rsa', 'Mallory' => 'haxx00r']);
-
-// array(3) {
-//   ["Alice"]=>
-//   string(3) "ecc"
-//   ["Bob"]=>
-//   string(3) "rsa"
-//   ["Mallory"]=>
-//   string(7) "haxx00r"
-// }
-$redis->hGetAll('comms');
-?>

All fields and values or false if the key didn't exist.
@@ -7678,7 +7676,7 @@ $redis->hGetAll('comms');

-
at line 1214
+
at line 1150
Redis|int|false hIncrBy(string $key, string $field, int $value) @@ -7688,7 +7686,17 @@ $redis->hGetAll('comms');
-

Increment a hash field's value by an integer

+

Increment a hash field's value by an integer

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('player');
+
+$redis->hmset('player', ['name' => 'Bob', 'level' => 1]);
+
+// int(2)
+$redis->hIncrBy('player', 'level', 1);
+
+// int(5)
+$redis->hIncrBy('player', 'level', 3);

Parameters

@@ -7717,20 +7725,7 @@ $redis->hGetAll('comms'); - +
Redis|int|false

The new value of the field.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('player');
-
-$redis->hmset('player', ['name' => 'Bob', 'level' => 1]);
-
-// int(2)
-$redis->hIncrBy('player', 'level', 1);
-
-// int(5)
-$redis->hIncrBy('player', 'level', 3);
-?>

The new value of the field.
@@ -7754,7 +7749,7 @@ $redis->hIncrBy('player', 'level', 3);

-
at line 1239
+
at line 1175
Redis|float|false hIncrByFloat(string $key, string $field, float $value) @@ -7764,7 +7759,15 @@ $redis->hIncrBy('player', 'level', 3);
-

Increment a hash field by a floating point value

+

Increment a hash field by a floating point value

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('trig-numbers')
+
+// float(3.1415926)
+$pi = $redis->hIncrByFloat('trig-numbers', 'pi', 3.1415926);
+
+// float(6.2831852)
+$redis->hIncrByFloat('trig-numbers', 'tau', 2 * $pi);

Parameters

@@ -7793,17 +7796,7 @@ $redis->hIncrBy('player', 'level', 3); - +
Redis|float|false

The field value after incremented.

-
$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('trig-numbers')
-
-// float(3.1415926)
-$pi = $redis->hIncrByFloat('trig-numbers', 'pi', 3.1415926);
-
-// float(6.2831852)
-$redis->hIncrByFloat('trig-numbers', 'tau', 2 * $pi);
-?>

The field value after incremented.
@@ -7827,7 +7820,7 @@ $redis->hIncrByFloat('trig-numbers', 'tau', 2 * $pi);

-
at line 1270
+
at line 1204
Redis|array|false hKeys(string $key) @@ -7837,7 +7830,21 @@ $redis->hIncrByFloat('trig-numbers', 'tau', 2 * $pi);
-

Retrieve all of the fields of a hash.

+

Retrieve all of the fields of a hash.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('ships');
+
+$redis->hmset('ships', ['Enterprise' => 'NCC-1701D', 'Defiant' => 'NX-74205', 'Voyager' => 'NCC-74656']);
+
+// array(3) {
+//   [0]=>
+//   string(10) "Enterprise"
+//   [1]=>
+//   string(7) "Defiant"
+//   [2]=>
+//   string(7) "Voyager"
+// }
+$redis->hKeys('ships');

Parameters

@@ -7856,24 +7863,7 @@ $redis->hIncrByFloat('trig-numbers', 'tau', 2 * $pi); - +
Redis|array|false

The fields in the hash or false if the hash doesn't exist.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('ships');
-
-$redis->hmset('ships', ['Enterprise' => 'NCC-1701D', 'Defiant' => 'NX-74205', 'Voyager' => 'NCC-74656']);
-
-// array(3) {
-//   [0]=>
-//   string(10) "Enterprise"
-//   [1]=>
-//   string(7) "Defiant"
-//   [2]=>
-//   string(7) "Voyager"
-// }
-$redis->hKeys('ships');
-?>

The fields in the hash or false if the hash doesn't exist.
@@ -7897,7 +7887,7 @@ $redis->hKeys('ships');

-
at line 1281
+
at line 1215
Redis|int|false hLen(string $key) @@ -7950,7 +7940,7 @@ $redis->hKeys('ships');

-
at line 1311
+
at line 1244
Redis|array|false hMget(string $key, array $fields) @@ -7960,7 +7950,19 @@ $redis->hKeys('ships');
-

Get one or more fields from a hash.

+

Get one or more fields from a hash.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('player:1');
+
+$redis->hmset('player:1', ['name' => 'Alice', 'age' => '26', 'score' => '1337']);
+
+// array(2) {
+//   ["name"]=>
+//   string(5) "Alice"
+//   ["score"]=>
+//   string(4) "1337"
+// }
+$redis->hmget('player:1', ['name', 'score']);

Parameters

@@ -7984,22 +7986,7 @@ $redis->hKeys('ships'); - +
Redis|array|false

The fields and values or false if the key didn't exist.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('player:1');
-
-$redis->hmset('player:1', ['name' => 'Alice', 'age' => '26', 'score' => '1337']);
-
-// array(2) {
-//   ["name"]=>
-//   string(5) "Alice"
-//   ["score"]=>
-//   string(4) "1337"
-// }
-$redis->hmget('player:1', ['name', 'score']);
-?>

The fields and values or false if the key didn't exist.
@@ -8023,7 +8010,7 @@ $redis->hmget('player:1', ['name', 'score']);

-
at line 1331
+
at line 1263
Redis|bool hMset(string $key, array $fieldvals) @@ -8033,7 +8020,9 @@ $redis->hmget('player:1', ['name', 'score']);
-

Add or update one or more hash fields and values

+

Add or update one or more hash fields and values

$redis = new Redis(['host' => 'localhost']);
+
+$redis->hmset('updates', ['status' => 'starting', 'elapsed' => 0]);

Parameters

@@ -8057,12 +8046,7 @@ $redis->hmget('player:1', ['name', 'score']); - +
Redis|bool

True if the operation was successful

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->hmset('updates', ['status' => 'starting', 'elapsed' => 0]);
-?>

True if the operation was successful
@@ -8086,7 +8070,7 @@ $redis->hmset('updates', ['status' => 'starting', 'elapsed' => 0]);

-
at line 1364
+
at line 1294
Redis|string|array hRandField(string $key, array $options = null) @@ -8096,7 +8080,14 @@ $redis->hmset('updates', ['status' => 'starting', 'elapsed' => 0]);
-

Get one or more random field from a hash.

+

Get one or more random field from a hash.

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('settings');
+
+$redis->hmset('settings', ['path' => '/', 'state' => 'active', 'jobs' => 15]);
+
+$redis->hrandfield('settings');
+$redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]);

Parameters

@@ -8124,18 +8115,7 @@ $redis->hmset('updates', ['status' => 'starting', 'elapsed' => 0]); - +
Redis|string|array

One or more random fields (and possibly values).

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('settings');
-
-$redis->hmset('settings', ['path' => '/', 'state' => 'active', 'jobs' => 15]);
-
-$redis->hrandfield('settings');
-
-$redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]);
-?>

One or more random fields (and possibly values).
@@ -8159,7 +8139,7 @@ $redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]);

-
at line 1366
+
at line 1296
Redis|int|false hSet(string $key, string $member, mixed $value) @@ -8212,7 +8192,7 @@ $redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]);

-
at line 1392
+
at line 1322
Redis|bool hSetNx(string $key, string $field, string $value) @@ -8222,7 +8202,17 @@ $redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]);
-

Set a hash field and value, but only if that field does not exist

+

Set a hash field and value, but only if that field does not exist

$redis = new Redis(['host' => 'localhost']);
+
+$redis->del('player:1');
+
+$redis->hmset('player:1', ['name' => 'bob', 'score' => 0]);
+
+// bool(true)
+var_dump($redis->hsetnx('player:1', 'lock', 'enabled'));
+
+// bool(false)
+var_dump($redis->hsetnx('player:1', 'lock', 'enabled'));

Parameters

@@ -8251,18 +8241,7 @@ $redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]); - +
Redis|bool

True if the field was set and false if not.

-
$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('player:1');
-
-$redis->hmset('player:1', ['name' => 'bob', 'score' => 0]);
-
-// bool(true)
-var_dump($redis->hsetnx('player:1', 'lock', 'enabled'));
-
-// bool(false)
-var_dump($redis->hsetnx('player:1', 'lock', 'enabled'));

True if the field was set and false if not.
@@ -8286,7 +8265,7 @@ var_dump($redis->hsetnx('player:1', 'lock', 'enabled'));

-
at line 1416
+
at line 1340
Redis|int|false hStrLen(string $key, string $field) @@ -8320,16 +8299,7 @@ var_dump($redis->hsetnx('player:1', 'lock', 'enabled')); - +
Redis|int|false

The string length of the field or false.

-
<?php
-$redis = new Redis(['host' => 'localhost']);
-
-$redis->del('hash');
-$redis->hmset('hash', ['50bytes' => str_repeat('a', 50)]);
-
-// int(50)
-$redis->hstrlen('hash', '50bytes');
-

The string length of the field or false.
@@ -8347,13 +8317,24 @@ $redis->hstrlen('hash', '50bytes'); +

Examples

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

+$redis->del('hash');

+$redis->hmset('hash', ['50bytes' => str_repeat('a', 50)]);

+$redis->hstrlen('hash', '50bytes');
+

-
at line 1445
+
at line 1369
Redis|array|false hVals(string $key) @@ -8421,7 +8402,7 @@ $redis->hgetall('player');

-
at line 1500
+
at line 1424
Redis|array|bool hscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) @@ -8531,7 +8512,7 @@ do {

-
at line 1527
+
at line 1451
Redis|int|false incr(string $key, int $by = 1) @@ -8606,7 +8587,7 @@ $redis->incr('counter', 2);

-
at line 1558
+
at line 1482
Redis|int|false incrBy(string $key, int $value) @@ -8682,7 +8663,7 @@ $redis->incrby('primes', 4);

-
at line 1582
+
at line 1506
Redis|float|false incrByFloat(string $key, float $value) @@ -8740,7 +8721,7 @@ var_dump($redis->incrByFloat('tau', 3.1415926));

-
at line 1598
+
at line 1522
Redis|array|false info(string ...$sections) @@ -8796,7 +8777,7 @@ to that section.

If connected to Redis server >=

-
at line 1605
+
at line 1529
bool isConnected() @@ -8828,7 +8809,7 @@ to that section.

If connected to Redis server >=

-
at line 1608
+
at line 1532
Redis|array|false keys(string $pattern) @@ -8871,7 +8852,7 @@ to that section.

If connected to Redis server >=

-
at line 1614
+
at line 1538
Redis|int|false lInsert(string $key, string $pos, mixed $pivot, mixed $value) @@ -8929,7 +8910,7 @@ to that section.

If connected to Redis server >=

-
at line 1616
+
at line 1540
Redis|int|false lLen(string $key) @@ -8972,7 +8953,7 @@ to that section.

If connected to Redis server >=

-
at line 1618
+
at line 1542
Redis|string|false lMove(string $src, string $dst, string $wherefrom, string $whereto) @@ -9030,7 +9011,7 @@ to that section.

If connected to Redis server >=

-
at line 1620
+
at line 1544
Redis|bool|string|array lPop(string $key, int $count = 0) @@ -9078,7 +9059,7 @@ to that section.

If connected to Redis server >=

-
at line 1622
+
at line 1546
Redis|null|bool|int|array lPos(string $key, mixed $value, array $options = null) @@ -9131,7 +9112,7 @@ to that section.

If connected to Redis server >=

-
at line 1628
+
at line 1552
int|Redis lPush(string $key, mixed ...$elements) @@ -9179,7 +9160,7 @@ to that section.

If connected to Redis server >=

-
at line 1634
+
at line 1558
Redis|int|false rPush(string $key, mixed ...$elements) @@ -9227,7 +9208,7 @@ to that section.

If connected to Redis server >=

-
at line 1637
+
at line 1561
Redis|int|false lPushx(string $key, mixed $value) @@ -9275,7 +9256,7 @@ to that section.

If connected to Redis server >=

-
at line 1640
+
at line 1564
Redis|int|false rPushx(string $key, mixed $value) @@ -9323,7 +9304,7 @@ to that section.

If connected to Redis server >=

-
at line 1642
+
at line 1566
Redis|bool lSet(string $key, int $index, mixed $value) @@ -9376,7 +9357,7 @@ to that section.

If connected to Redis server >=

-
at line 1644
+
at line 1568
int lastSave() @@ -9409,7 +9390,7 @@ to that section.

If connected to Redis server >=

-
at line 1646
+
at line 1570
mixed lindex(string $key, int $index) @@ -9457,7 +9438,7 @@ to that section.

If connected to Redis server >=

-
at line 1648
+
at line 1572
Redis|array|false lrange(string $key, int $start, int $end) @@ -9510,7 +9491,7 @@ to that section.

If connected to Redis server >=

-
at line 1653
+
at line 1577
int|Redis|false lrem(string $key, mixed $value, int $count = 0) @@ -9563,7 +9544,7 @@ to that section.

If connected to Redis server >=

-
at line 1655
+
at line 1579
Redis|bool ltrim(string $key, int $start, int $end) @@ -9616,7 +9597,7 @@ to that section.

If connected to Redis server >=

-
at line 1658
+
at line 1582
array|Redis mget(array $keys) @@ -9659,7 +9640,7 @@ to that section.

If connected to Redis server >=

-
at line 1660
+
at line 1584
Redis|bool migrate(string $host, int $port, string|array $key, int $dstdb, int $timeout, bool $copy = false, bool $replace = false, mixed $credentials = NULL) @@ -9737,7 +9718,7 @@ to that section.

If connected to Redis server >=

-
at line 1664
+
at line 1588
bool move(string $key, int $index) @@ -9785,7 +9766,7 @@ to that section.

If connected to Redis server >=

-
at line 1666
+
at line 1590
Redis|bool mset(array $key_values) @@ -9828,7 +9809,7 @@ to that section.

If connected to Redis server >=

-
at line 1668
+
at line 1592
Redis|bool msetnx(array $key_values) @@ -9871,7 +9852,7 @@ to that section.

If connected to Redis server >=

-
at line 1670
+
at line 1594
bool|Redis multi(int $value = Redis::MULTI) @@ -9914,7 +9895,7 @@ to that section.

If connected to Redis server >=

-
at line 1672
+
at line 1596
Redis|int|string|false object(string $subcommand, string $key) @@ -9962,7 +9943,7 @@ to that section.

If connected to Redis server >=

-
at line 1678
+
at line 1602
bool open(string $host, int $port = 6379, float $timeout = 0, string $persistent_id = NULL, int $retry_interval = 0, float $read_timeout = 0, array $context = NULL) deprecated @@ -10042,7 +10023,7 @@ to that section.

If connected to Redis server >=

-
at line 1680
+
at line 1604
bool pconnect(string $host, int $port = 6379, float $timeout = 0, string $persistent_id = NULL, int $retry_interval = 0, float $read_timeout = 0, array $context = NULL) @@ -10115,7 +10096,7 @@ to that section.

If connected to Redis server >=

-
at line 1682
+
at line 1606
bool persist(string $key) @@ -10158,7 +10139,7 @@ to that section.

If connected to Redis server >=

-
at line 1696
+
at line 1620
bool pexpire(string $key, int $timeout, string|null $mode = NULL) @@ -10214,7 +10195,7 @@ command works.

-
at line 1710
+
at line 1634
Redis|bool pexpireAt(string $key, int $timestamp, string|null $mode = NULL) @@ -10285,7 +10266,7 @@ Redis::expire

-
at line 1723
+
at line 1647
Redis|int pfadd(string $key, array $elements) @@ -10343,7 +10324,7 @@ Redis::expire

-
at line 1734
+
at line 1658
Redis|int pfcount(string $key) @@ -10396,7 +10377,7 @@ Redis::expire

-
at line 1746
+
at line 1670
Redis|bool pfmerge(string $dst, array $srckeys) @@ -10454,7 +10435,7 @@ Redis::expire

-
at line 1770
+
at line 1694
Redis|string|bool ping(string $message = NULL) @@ -10517,7 +10498,7 @@ $redis->ping('beep boop');

-
at line 1804
+
at line 1728
bool|Redis pipeline() @@ -10569,7 +10550,7 @@ $redis->pipeline()

-
at line 1810
+
at line 1734
bool popen(string $host, int $port = 6379, float $timeout = 0, string $persistent_id = NULL, int $retry_interval = 0, float $read_timeout = 0, array $context = NULL) deprecated @@ -10649,7 +10630,7 @@ $redis->pipeline()

-
at line 1813
+
at line 1737
bool|Redis psetex(string $key, int $expire, mixed $value) @@ -10702,7 +10683,7 @@ $redis->pipeline()

-
at line 1829
+
at line 1753
bool psubscribe(array $patterns, callable $cb) @@ -10761,7 +10742,7 @@ $redis->pipeline()

-
at line 1854
+
at line 1778
Redis|int|false pttl(string $key) @@ -10824,7 +10805,7 @@ var_dump($redis->pttl('ttl-key'));

-
at line 1866
+
at line 1790
Redis|int|false publish(string $channel, string $message) @@ -10882,7 +10863,7 @@ var_dump($redis->pttl('ttl-key'));

-
at line 1868
+
at line 1792
mixed pubsub(string $command, mixed $arg = null) @@ -10930,7 +10911,7 @@ var_dump($redis->pttl('ttl-key'));

-
at line 1881
+
at line 1805
Redis|array|bool punsubscribe(array $patterns) @@ -10996,7 +10977,7 @@ Redis::subscribe

-
at line 1914
+
at line 1838
Redis|array|string|bool rPop(string $key, int $count = 0) @@ -11071,7 +11052,7 @@ $redis->rPop('mylist');

-
at line 1924
+
at line 1848
Redis|string|false randomKey() @@ -11114,7 +11095,7 @@ $redis->rPop('mylist');

-
at line 1956
+
at line 1880
mixed rawcommand(string $command, mixed ...$args) @@ -11182,7 +11163,7 @@ $redis->rawCommand('lrange', 'mylist', 0, -1);

-
at line 1968
+
at line 1892
Redis|bool rename(string $old_name, string $new_name) @@ -11240,7 +11221,7 @@ $redis->rawCommand('lrange', 'mylist', 0, -1);

-
at line 1997
+
at line 1921
Redis|bool renameNx(string $key_src, string $key_dst) @@ -11312,7 +11293,7 @@ $redis->renamenx('dst', 'existing-dst');

-
at line 2004
+
at line 1928
Redis|bool reset() @@ -11344,7 +11325,7 @@ $redis->renamenx('dst', 'existing-dst');

-
at line 2065
+
at line 1989
Redis|bool restore(string $key, int $ttl, string $value, array|null $options = NULL) @@ -11464,7 +11445,7 @@ Redis::dump

-
at line 2073
+
at line 1997
mixed role() @@ -11497,7 +11478,7 @@ an error.

-
at line 2113
+
at line 2037
Redis|string|false rpoplpush(string $srckey, string $dstkey) @@ -11580,7 +11561,7 @@ var_dump($redis->lrange('list1', 0, -1));

-
at line 2141
+
at line 2065
Redis|int|false sAdd(string $key, mixed $value, mixed ...$other_values) @@ -11655,7 +11636,7 @@ var_dump($redis->sadd('myset', 'foo', 'new'));

-
at line 2169
+
at line 2093
int sAddArray(string $key, array $values) @@ -11732,7 +11713,7 @@ var_dump($redis->sAddArray('myset', ['foo', 'new']));

-
at line 2206
+
at line 2130
Redis|array|false sDiff(string $key, string ...$other_keys) @@ -11814,7 +11795,7 @@ array(2) {

-
at line 2221
+
at line 2145
Redis|int|false sDiffStore(string $dst, string $key, string ...$other_keys) @@ -11884,7 +11865,7 @@ values in a specified destination key.

-
at line 2255
+
at line 2179
Redis|array|false sInter(array|string $key, string ...$other_keys) @@ -11963,7 +11944,7 @@ var_dump($redis->sinter('alice_likes', 'bob_likes', 'bill_likes'));

-
at line 2283
+
at line 2207
Redis|int|false sintercard(array $keys, int $limit = -1) @@ -12034,7 +12015,7 @@ var_dump($redis->sInterCard(['set1', 'set2', 'set3']));

-
at line 2312
+
at line 2236
Redis|int|false sInterStore(array|string $key, string ...$other_keys) @@ -12109,7 +12090,7 @@ $redis->sInterStore('dst', 'src1', 'src'2', 'src3');

-
at line 2344
+
at line 2268
Redis|array|false sMembers(string $key) @@ -12180,7 +12161,7 @@ $redis->sMembers('tng-crew');

-
at line 2384
+
at line 2308
Redis|array|false sMisMember(string $key, string $member, string ...$other_members) @@ -12277,7 +12258,7 @@ var_dump(array_combine($names, $members));

-
at line 2430
+
at line 2354
Redis|bool sMove(string $src, string $dst, mixed $value) @@ -12370,7 +12351,7 @@ var_dump($redis->sMembers('evens'));

-
at line 2476
+
at line 2400
Redis|string|array|false sPop(string $key, int $count = 0) @@ -12461,7 +12442,7 @@ var_dump($redis->sMembers('evens'));

-
at line 2513
+
at line 2437
Redis|string|array|false sRandMember(string $key, int $count = 0) @@ -12529,7 +12510,7 @@ $rng3 = $redis->sRandMember('elder-gods', -9999);

-
at line 2553
+
at line 2477
Redis|array|false sUnion(string $key, string ...$other_keys) @@ -12612,7 +12593,7 @@ var_dump($redis->sunion('set1', 'set2', 'set3'));

-
at line 2568
+
at line 2492
Redis|int|false sUnionStore(string $dst, string $key, string ...$other_keys) @@ -12682,7 +12663,7 @@ false on failure.

-
at line 2579
+
at line 2503
Redis|bool save() @@ -12732,7 +12713,7 @@ completed. For a nonblocking alternative, see Redis::bgsave().

-
at line 2645
+
at line 2569
array|false scan(int|null $iterator, string|null $pattern = null, int $count = 0, string $type = NULL) @@ -12850,7 +12831,7 @@ Redis::setOption

-
at line 2669
+
at line 2593
Redis|int|false scard(string $key) @@ -12913,7 +12894,7 @@ $redis->scard('set');

-
at line 2703
+
at line 2627
mixed script(string $command, mixed ...$args) @@ -12990,7 +12971,7 @@ var_dump($redis->script('exists', sha1($lua)));

-
at line 2731
+
at line 2655
Redis|bool select(int $db) @@ -13048,7 +13029,7 @@ var_dump($redis->exists('this_is_db_1'));

-
at line 2774
+
at line 2698
Redis|string|bool set(string $key, mixed $value, mixed $options = NULL) @@ -13142,7 +13123,7 @@ $redis->set('key', 'options_set', ['XX']);

-
at line 2800
+
at line 2724
Redis|int|false setBit(string $key, int $idx, bool $value) @@ -13216,7 +13197,7 @@ $redis->get('foo');

-
at line 2824
+
at line 2748
Redis|int|false setRange(string $key, int $index, string $value) @@ -13287,7 +13268,7 @@ $redis->setRange('message', 6, 'Redis');

-
at line 2856
+
at line 2780
bool setOption(int $option, mixed $value) @@ -13429,7 +13410,7 @@ Redis::__construct

-
at line 2877
+
at line 2801
Redis|bool setex(string $key, int $expire, mixed $value) @@ -13488,7 +13469,7 @@ $redis->set('some_key', 60, 'some_value');

-
at line 2905
+
at line 2829
Redis|bool setnx(string $key, mixed $value) @@ -13558,7 +13539,7 @@ $redis->setnx('existing-key', 'new-value');

-
at line 2932
+
at line 2856
Redis|bool sismember(string $key, mixed $value) @@ -13619,7 +13600,7 @@ $redis->sismember('myset', 'not-in-set');

-
at line 2948
+
at line 2872
Redis|bool slaveof(string $host = NULL, int $port = 6379) deprecated @@ -13702,7 +13683,7 @@ Redis::slaveof

-
at line 2977
+
at line 2901
Redis|bool replicaof(string $host = NULL, int $port = 6379) @@ -13785,7 +13766,7 @@ Redis::slaveof

-
at line 2991
+
at line 2915
Redis|int|false touch(array|string $key_or_array, string ...$more_keys) @@ -13844,7 +13825,7 @@ had their last modified time reset

-
at line 3022
+
at line 2946
mixed slowlog(string $operation, int $length = 0) @@ -13916,7 +13897,7 @@ entries, which is configurable.

-
at line 3055
+
at line 2979
mixed sort(string $key, array|null $options = null) @@ -13991,7 +13972,7 @@ $options = [

-
at line 3062
+
at line 2986
mixed sort_ro(string $key, array|null $options = null) @@ -14050,7 +14031,7 @@ Redis::sort

-
at line 3067
+
at line 2991
array sortAsc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) deprecated @@ -14125,7 +14106,7 @@ Redis::sort

-
at line 3072
+
at line 2996
array sortAscAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) deprecated @@ -14200,7 +14181,7 @@ Redis::sort

-
at line 3077
+
at line 3001
array sortDesc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) deprecated @@ -14275,7 +14256,7 @@ Redis::sort

-
at line 3082
+
at line 3006
array sortDescAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null) deprecated @@ -14350,7 +14331,7 @@ Redis::sort

-
at line 3110
+
at line 3034
Redis|int|false srem(string $key, mixed $value, mixed ...$other_values) @@ -14425,7 +14406,7 @@ var_dump($redis->sRem('set1', 'foo', 'bar', 'not-in-the-set'));

-
at line 3173
+
at line 3097
array|false sscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) @@ -14551,7 +14532,7 @@ Redis::setOption

-
at line 3202
+
at line 3126
Redis|int|false strlen(string $key) @@ -14610,7 +14591,7 @@ $redis->strlen('string');

-
at line 3234
+
at line 3158
bool subscribe(array $channels, callable $cb) @@ -14676,7 +14657,7 @@ echo "Subscribe loop ended\n";

-
at line 3291
+
at line 3215
Redis|bool swapdb(int $src, int $dst) @@ -14780,7 +14761,7 @@ Redis::del

-
at line 3312
+
at line 3236
Redis|array time() @@ -14834,7 +14815,7 @@ print_r($redis->time());

-
at line 3344
+
at line 3268
Redis|int|false ttl(string $key) @@ -14897,7 +14878,7 @@ $redis->ttl('not_a_key');

-
at line 3364
+
at line 3288
Redis|int|false type(string $key) @@ -14958,7 +14939,7 @@ Redis::REDIS_STREAM

-
at line 3403
+
at line 3327
Redis|array|bool unsubscribe(array $channels) @@ -15101,7 +15082,7 @@ Redis::subscribe

-
at line 3414
+
at line 3338
Redis|bool unwatch() @@ -15157,7 +15138,7 @@ Redis::watch

-
at line 3419
+
at line 3343
bool|Redis watch(array|string $key, string ...$other_keys) @@ -15205,7 +15186,7 @@ Redis::watch

-
at line 3433
+
at line 3357
int|false wait(int $numreplicas, int $timeout) @@ -15264,7 +15245,7 @@ recieving them.

-
at line 3435
+
at line 3359
int|false xack(string $key, string $group, array $ids) @@ -15317,7 +15298,7 @@ recieving them.

-
at line 3485
+
at line 3409
Redis|string|false xadd(string $key, string $id, array $values, int $maxlen = 0, bool $approx = false, bool $nomkstream = false) @@ -15429,7 +15410,7 @@ $redis->xRange('ds9-season-1', '1-1', '1-2');

-
at line 3487
+
at line 3411
Redis|bool|array xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = -1, bool $justid = false) @@ -15502,7 +15483,7 @@ $redis->xRange('ds9-season-1', '1-1', '1-2');

-
at line 3489
+
at line 3413
Redis|bool|array xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options) @@ -15570,7 +15551,7 @@ $redis->xRange('ds9-season-1', '1-1', '1-2');

-
at line 3535
+
at line 3459
Redis|int|false xdel(string $key, array $ids) @@ -15650,7 +15631,7 @@ $redis->xRange('stream', '-', '+');

-
at line 3573
+
at line 3497
mixed xgroup(string $operation, string $key = null, string $group = null, string $id_or_consumer = null, bool $mkstream = false, int $entries_read = -2) @@ -15745,7 +15726,7 @@ cause Redis to also create the STREAM if it doesn't currently exist.

-
at line 3607
+
at line 3531
mixed xinfo(string $operation, string|null $arg1 = null, string|null $arg2 = null, int $count = -1) @@ -15820,7 +15801,7 @@ $redis->xInfo('STREAM', 'stream');

-
at line 3632
+
at line 3556
Redis|int|false xlen(string $key) @@ -15883,7 +15864,7 @@ $redis->xLen('stream');

-
at line 3651
+
at line 3575
Redis|array|false xpending(string $key, string $group, string|null $start = null, string|null $end = null, int $count = -1, string|null $consumer = null) @@ -15968,7 +15949,7 @@ acknowledged with XACK.

-
at line 3698
+
at line 3622
Redis|array|bool xrange(string $key, string $start, string $end, int $count = -1) @@ -16066,7 +16047,7 @@ $redis->xRange('stream', '-', '+');

-
at line 3752
+
at line 3676
Redis|array|bool xread(array $streams, int $count = -1, int $block = -1) @@ -16169,7 +16150,7 @@ print_r($redis->xRead(['s03' => '3-2', 's04' => '4-1']));<

-
at line 3808
+
at line 3732
Redis|array|bool xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1) @@ -16271,7 +16252,7 @@ var_dump($msgs);

-
at line 3857
+
at line 3781
Redis|array|bool xrevrange(string $key, string $end, string $start, int $count = -1) @@ -16375,7 +16356,7 @@ $redis->xRevRange('stream', '+', '-');

-
at line 3927
+
at line 3851
Redis|int|false xtrim(string $key, string $threshold, bool $approx = false, bool $minid = false, int $limit = -1) @@ -16502,7 +16483,7 @@ print_r($redis->xRange('stream', '-', '+'));

-
at line 3990
+
at line 3914
Redis|int|false zAdd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems) @@ -16608,7 +16589,7 @@ print_r($redis->zRange('zs', 0, -1, true));

-
at line 4013
+
at line 3937
Redis|int|false zCard(string $key) @@ -16670,7 +16651,7 @@ $redis->zCard('zs');

-
at line 4045
+
at line 3969
Redis|int|false zCount(string $key, string $start, string $end) @@ -16733,7 +16714,7 @@ $redis->zCard('zs');

-
at line 4072
+
at line 3996
Redis|float|false zIncrBy(string $key, float $value, mixed $member) @@ -16808,7 +16789,7 @@ print_r($redis->zIncrBy('zs', 2.0, 'eggplants'));

-
at line 4102
+
at line 4026
Redis|int|false zLexCount(string $key, string $min, string $max) @@ -16884,7 +16865,7 @@ $redis->zRangeByLex('captains', '[A', '[S', 2, 2);

-
at line 4141
+
at line 4065
Redis|array|false zMscore(string $key, mixed $member, mixed ...$other_members) @@ -16970,7 +16951,7 @@ $redis->zMScore('zs', 'one', 'not-a-member');

-
at line 4175
+
at line 4099
Redis|array|false zPopMax(string $key, int $count = null) @@ -17047,7 +17028,7 @@ print_r($redis->zPopMax('zs', 2));

-
at line 4209
+
at line 4133
Redis|array|false zPopMin(string $key, int $count = null) @@ -17124,7 +17105,7 @@ $redis->zPopMin('zs', 2);

-
at line 4246
+
at line 4170
Redis|array|false zRange(string $key, mixed $start, mixed $end, array|bool|null $options = null) @@ -17206,7 +17187,7 @@ $options = [

-
at line 4286
+
at line 4210
Redis|array|false zRangeByLex(string $key, string $min, string $max, int $offset = -1, int $count = -1) @@ -17301,7 +17282,7 @@ $redis->zRangeByLex('captains', '[A', '[S', 2, 2);

-
at line 4352
+
at line 4276
Redis|array|false zRangeByScore(string $key, string $start, string $end, array $options = []) @@ -17417,7 +17398,7 @@ $redis->zRangeByScore('zs', 20, 30, ['WITHSCORES' => true, 'LIMIT' => [

-
at line 4372
+
at line 4296
Redis|int|false zrangestore(string $dstkey, string $srckey, string $start, string $end, array|bool|null $options = NULL) @@ -17498,7 +17479,7 @@ it will store them in a destination key provided by the user

-
at line 4399
+
at line 4323
Redis|string|array zRandMember(string $key, array $options = null) @@ -17569,7 +17550,7 @@ $redis->zRandMember('zs', ['COUNT' => 2, 'WITHSCORES' => true]);

-
at line 4425
+
at line 4349
Redis|int|false zRank(string $key, mixed $member) @@ -17627,7 +17608,7 @@ $redis->zRandMember('zs', ['COUNT' => 2, 'WITHSCORES' => true]);

-
at line 4460
+
at line 4384
Redis|int|false zRem(mixed $key, mixed $member, mixed ...$other_members) @@ -17711,7 +17692,7 @@ $redis->zRange('zs', 0, -1);

-
at line 4507
+
at line 4431
Redis|int|false zRemRangeByLex(string $key, string $min, string $max) @@ -17809,7 +17790,7 @@ print_r($redis->zRange('zs', 0, -1));

-
at line 4538
+
at line 4462
Redis|int|false zRemRangeByRank(string $key, int $start, int $end) @@ -17887,7 +17868,7 @@ $redis->zRange('zs', 0, -1);

-
at line 4571
+
at line 4495
Redis|int|false zRemRangeByScore(string $key, string $start, string $end) @@ -17967,7 +17948,7 @@ $redis->zRange('zs', 0, -1);

-
at line 4613
+
at line 4537
Redis|array|false zRevRange(string $key, int $start, int $end, mixed $scores = null) @@ -18048,7 +18029,7 @@ $redis->zRevRange('zs', 0, -1, ['withscores' => true]);

-
at line 4654
+
at line 4578
Redis|array|false zRevRangeByLex(string $key, string $max, string $min, int $offset = -1, int $count = -1) @@ -18149,7 +18130,7 @@ $redis->zRevRangeByLex('captains', '[Q', '[J', 1, 2);

-
at line 4713
+
at line 4637
Redis|array|false zRevRangeByScore(string $key, string $max, string $min, array|bool $options = []) @@ -18245,7 +18226,7 @@ $redis->zRevRangeByScore('oldest-people', '117.5', '-inf', ['LIMIT' => [0,

-
at line 4742
+
at line 4666
Redis|int|false zRevRank(string $key, mixed $member) @@ -18317,7 +18298,7 @@ $redis->zrevrank('ds9-characters', 'Garak');

-
at line 4771
+
at line 4695
Redis|float|false zScore(string $key, mixed $member) @@ -18389,7 +18370,7 @@ foreach ($redis->zRange('telescopes', 0, -1) as $name) {

-
at line 4805
+
at line 4729
Redis|array|false zdiff(array $keys, array $options = null) @@ -18465,7 +18446,7 @@ print_r($redis->zDiff(['primes', 'evens', 'mod3']));

-
at line 4822
+
at line 4746
Redis|int|false zdiffstore(string $dst, array $keys) @@ -18532,7 +18513,7 @@ Redis::zdiff

-
at line 4869
+
at line 4793
Redis|array|false zinter(array $keys, array|null $weights = null, array|null $options = null) @@ -18625,7 +18606,7 @@ $redis->zInter(['TNG', 'DS9'], NULL, ['withscores' => true, 'aggregate' =&

-
at line 4900
+
at line 4824
Redis|int|false zintercard(array $keys, int $limit = -1) @@ -18710,7 +18691,7 @@ Redis::zinter

-
at line 4946
+
at line 4870
Redis|int|false zinterstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null) @@ -18813,7 +18794,7 @@ print_r($redis->zRange('fruit-max', 0, -1, true));

-
at line 4970
+
at line 4894
Redis|array|false zscan(string $key, int|null $iterator, string|null $pattern = null, int $count = 0) @@ -18900,7 +18881,7 @@ Redis::scan

-
at line 5034
+
at line 4958
Redis|array|false zunion(array $keys, array|null $weights = null, array|null $options = null) @@ -18999,7 +18980,7 @@ $redis->zUnion(['store1', 'store3'], [2, .5], ['withscores' => true, 'aggr

-
at line 5076
+
at line 5000
Redis|int|false zunionstore(string $dst, array $keys, array|null $weights = NULL, string|null $aggregate = NULL) diff --git a/docs/doc-index.html b/docs/doc-index.html index 5f71012f..792d88cd 100644 --- a/docs/doc-index.html +++ b/docs/doc-index.html @@ -188,8 +188,7 @@ Redis::close() — Method in class Redis() — Method in class Redis
Redis::config() — Method in class Redis
-

Execute the Redis CONFIG command in a variety of ways. What the command does in particular depends -on the $operation qualifier.

+

Execute the Redis CONFIG command in a variety of ways.

Redis::connect() — Method in class Redis
Redis::copy() — Method in class Redis
@@ -266,8 +265,7 @@ Redis::expire() — Method in class Redis
Redis::expireAt() — Method in class Redis
-

Set a key's expiration to a specific Unix timestamp in seconds. If -connected to Redis >= 7.0.0 you can pass an optional 'mode' argument.

+

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

RedisArray::exec() — Method in class RedisArray
@@ -341,7 +339,7 @@ Redis::getBit() — Method in class Redis() — Method in class Redis
Redis::getDBNum() — Method in class Redis
-
+

Get the database number PhpRedis thinks we're connected to.

Redis::getDel() — Method in class Redis
Redis::getHost() — Method in class Redis
diff --git a/docs/doctum-search.json b/docs/doctum-search.json index f2cb7669..7929cf10 100644 --- a/docs/doctum-search.json +++ b/docs/doctum-search.json @@ -1 +1 @@ -{"items":[{"t":"C","n":"Redis","p":"Redis.html","d":"","f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisArray","p":"RedisArray.html","d":"","f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisCluster","p":"RedisCluster.html","d":"","f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisClusterException","p":"RedisClusterException.html","d":null,"f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisException","p":"RedisException.html","d":null,"f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisSentinel","p":"RedisSentinel.html","d":"","f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"M","n":"Redis::__construct","p":"Redis.html#method___construct","d":"

Create a new Redis instance. If passed sufficient information in the\noptions array it is also possible to connect to an instance at the same\ntime.

"},{"t":"M","n":"Redis::__destruct","p":"Redis.html#method___destruct","d":null},{"t":"M","n":"Redis::_compress","p":"Redis.html#method__compress","d":"

Compress a value with the currently configured compressor as set with\nRedis::setOption().

"},{"t":"M","n":"Redis::_uncompress","p":"Redis.html#method__uncompress","d":"

Uncompress the provided argument that has been compressed with the\ncurrently configured compressor as set with Redis::setOption().

"},{"t":"M","n":"Redis::_prefix","p":"Redis.html#method__prefix","d":"

Prefix the passed argument with the currently set key prefix as set\nwith Redis::setOption().

"},{"t":"M","n":"Redis::_serialize","p":"Redis.html#method__serialize","d":"

Serialize the provided value with the currently set serializer as set\nwith Redis::setOption().

"},{"t":"M","n":"Redis::_unserialize","p":"Redis.html#method__unserialize","d":"

Unserialize the passed argument with the currently set serializer as set\nwith Redis::setOption().

"},{"t":"M","n":"Redis::_pack","p":"Redis.html#method__pack","d":"

Pack the provided value with the configured serializer and compressor\nas set with Redis::setOption().

"},{"t":"M","n":"Redis::_unpack","p":"Redis.html#method__unpack","d":"

Unpack the provided value with the configured compressor and serializer\nas set with Redis::setOption().

"},{"t":"M","n":"Redis::acl","p":"Redis.html#method_acl","d":null},{"t":"M","n":"Redis::append","p":"Redis.html#method_append","d":"

Append data to a Redis STRING key.

"},{"t":"M","n":"Redis::auth","p":"Redis.html#method_auth","d":"

Authenticate a Redis connection after its been established.

"},{"t":"M","n":"Redis::bgSave","p":"Redis.html#method_bgSave","d":"

Execute a save of the Redis database in the background.

"},{"t":"M","n":"Redis::bgrewriteaof","p":"Redis.html#method_bgrewriteaof","d":"

Asynchronously rewrite Redis' append-only file

"},{"t":"M","n":"Redis::bitcount","p":"Redis.html#method_bitcount","d":"

Count the number of set bits in a Redis string.

"},{"t":"M","n":"Redis::bitop","p":"Redis.html#method_bitop","d":null},{"t":"M","n":"Redis::bitpos","p":"Redis.html#method_bitpos","d":"

Return the position of the first bit set to 0 or 1 in a string.

"},{"t":"M","n":"Redis::blPop","p":"Redis.html#method_blPop","d":"

Pop an element off the beginning of a Redis list or lists, potentially blocking up to a specified\ntimeout. This method may be called in two distinct ways, of which examples are provided below.

"},{"t":"M","n":"Redis::brPop","p":"Redis.html#method_brPop","d":"

Pop an element off of the end of a Redis list or lists, potentially blocking up to a specified timeout.

"},{"t":"M","n":"Redis::brpoplpush","p":"Redis.html#method_brpoplpush","d":"

Pop an element from the end of a Redis list, pushing it to the beginning of another Redis list,\noptionally blocking up to a specified timeout.

"},{"t":"M","n":"Redis::bzPopMax","p":"Redis.html#method_bzPopMax","d":"

POP the maximum scoring element off of one or more sorted sets, blocking up to a specified\ntimeout if no elements are available.

"},{"t":"M","n":"Redis::bzPopMin","p":"Redis.html#method_bzPopMin","d":"

POP the minimum scoring element off of one or more sorted sets, blocking up to a specified timeout\nif no elements are available

"},{"t":"M","n":"Redis::bzmpop","p":"Redis.html#method_bzmpop","d":"

POP one or more elements from one or more sorted sets, blocking up to a specified amount of time\nwhen no elements are available.

"},{"t":"M","n":"Redis::zmpop","p":"Redis.html#method_zmpop","d":"

POP one or more of the highest or lowest scoring elements from one or more sorted sets.

"},{"t":"M","n":"Redis::blmpop","p":"Redis.html#method_blmpop","d":"

Pop one or more elements from one or more Redis LISTs, blocking up to a specified timeout when\nno elements are available.

"},{"t":"M","n":"Redis::lmpop","p":"Redis.html#method_lmpop","d":"

Pop one or more elements off of one or more Redis LISTs.

"},{"t":"M","n":"Redis::clearLastError","p":"Redis.html#method_clearLastError","d":"

Reset any last error on the connection to NULL

"},{"t":"M","n":"Redis::client","p":"Redis.html#method_client","d":null},{"t":"M","n":"Redis::close","p":"Redis.html#method_close","d":null},{"t":"M","n":"Redis::command","p":"Redis.html#method_command","d":null},{"t":"M","n":"Redis::config","p":"Redis.html#method_config","d":"

Execute the Redis CONFIG command in a variety of ways. What the command does in particular depends\non the $operation qualifier.

"},{"t":"M","n":"Redis::connect","p":"Redis.html#method_connect","d":null},{"t":"M","n":"Redis::copy","p":"Redis.html#method_copy","d":"

Make a copy of a key.

"},{"t":"M","n":"Redis::dbSize","p":"Redis.html#method_dbSize","d":"

Return the number of keys in the currently selected Redis database.

"},{"t":"M","n":"Redis::debug","p":"Redis.html#method_debug","d":null},{"t":"M","n":"Redis::decr","p":"Redis.html#method_decr","d":"

Decrement a Redis integer by 1 or a provided value.

"},{"t":"M","n":"Redis::decrBy","p":"Redis.html#method_decrBy","d":"

Decrement a redis integer by a value

"},{"t":"M","n":"Redis::del","p":"Redis.html#method_del","d":"

Delete one or more keys from Redis.

"},{"t":"M","n":"Redis::delete","p":"Redis.html#method_delete","d":""},{"t":"M","n":"Redis::discard","p":"Redis.html#method_discard","d":"

Discard a transaction currently in progress.

"},{"t":"M","n":"Redis::dump","p":"Redis.html#method_dump","d":"

Dump Redis' internal binary representation of a key.

"},{"t":"M","n":"Redis::echo","p":"Redis.html#method_echo","d":"

Have Redis repeat back an arbitrary string to the client.

"},{"t":"M","n":"Redis::eval","p":"Redis.html#method_eval","d":"

Execute a LUA script on the redis server.

"},{"t":"M","n":"Redis::eval_ro","p":"Redis.html#method_eval_ro","d":"

This is simply the read-only variant of eval, meaning the underlying script\nmay not modify data in redis.

"},{"t":"M","n":"Redis::evalsha","p":"Redis.html#method_evalsha","d":"

Execute a LUA script on the server but instead of sending the script, send\nthe SHA1 hash of the script.

"},{"t":"M","n":"Redis::evalsha_ro","p":"Redis.html#method_evalsha_ro","d":"

This is simply the read-only variant of evalsha, meaning the underlying script\nmay not modify data in redis.

"},{"t":"M","n":"Redis::exec","p":"Redis.html#method_exec","d":"

Execute either a MULTI or PIPELINE block and return the array of replies.

"},{"t":"M","n":"Redis::exists","p":"Redis.html#method_exists","d":"

Test if one or more keys exist.

"},{"t":"M","n":"Redis::expire","p":"Redis.html#method_expire","d":"

Sets an expiration in seconds on the key in question. If connected to\nredis-server >= 7.0.0 you may send an additional "mode" argument which\nmodifies how the command will execute.

"},{"t":"M","n":"Redis::expireAt","p":"Redis.html#method_expireAt","d":"

Set a key's expiration to a specific Unix timestamp in seconds. If\nconnected to Redis >= 7.0.0 you can pass an optional 'mode' argument.

"},{"t":"M","n":"Redis::failover","p":"Redis.html#method_failover","d":null},{"t":"M","n":"Redis::expiretime","p":"Redis.html#method_expiretime","d":"

Get the expiration of a given key as a unix timestamp

"},{"t":"M","n":"Redis::pexpiretime","p":"Redis.html#method_pexpiretime","d":"

Get the expriation timestamp of a given Redis key but in milliseconds.

"},{"t":"M","n":"Redis::flushAll","p":"Redis.html#method_flushAll","d":"

Deletes every key in all Redis databases

"},{"t":"M","n":"Redis::flushDB","p":"Redis.html#method_flushDB","d":"

Deletes all the keys of the currently selected database.

"},{"t":"M","n":"Redis::geoadd","p":"Redis.html#method_geoadd","d":null},{"t":"M","n":"Redis::geodist","p":"Redis.html#method_geodist","d":null},{"t":"M","n":"Redis::geohash","p":"Redis.html#method_geohash","d":null},{"t":"M","n":"Redis::geopos","p":"Redis.html#method_geopos","d":null},{"t":"M","n":"Redis::georadius","p":"Redis.html#method_georadius","d":null},{"t":"M","n":"Redis::georadius_ro","p":"Redis.html#method_georadius_ro","d":null},{"t":"M","n":"Redis::georadiusbymember","p":"Redis.html#method_georadiusbymember","d":null},{"t":"M","n":"Redis::georadiusbymember_ro","p":"Redis.html#method_georadiusbymember_ro","d":null},{"t":"M","n":"Redis::geosearch","p":"Redis.html#method_geosearch","d":null},{"t":"M","n":"Redis::geosearchstore","p":"Redis.html#method_geosearchstore","d":null},{"t":"M","n":"Redis::get","p":"Redis.html#method_get","d":null},{"t":"M","n":"Redis::getAuth","p":"Redis.html#method_getAuth","d":"

Get the authentication information on the connection, if any.

"},{"t":"M","n":"Redis::getBit","p":"Redis.html#method_getBit","d":null},{"t":"M","n":"Redis::getEx","p":"Redis.html#method_getEx","d":null},{"t":"M","n":"Redis::getDBNum","p":"Redis.html#method_getDBNum","d":null},{"t":"M","n":"Redis::getDel","p":"Redis.html#method_getDel","d":null},{"t":"M","n":"Redis::getHost","p":"Redis.html#method_getHost","d":"

Return the host or Unix socket we are connected to.

"},{"t":"M","n":"Redis::getLastError","p":"Redis.html#method_getLastError","d":"

Get the last error returned to us from Redis, if any.

"},{"t":"M","n":"Redis::getMode","p":"Redis.html#method_getMode","d":"

Returns whether the connection is in ATOMIC, MULTI, or PIPELINE mode

"},{"t":"M","n":"Redis::getOption","p":"Redis.html#method_getOption","d":"

Retrieve the value of a configuration setting as set by Redis::setOption()

"},{"t":"M","n":"Redis::getPersistentID","p":"Redis.html#method_getPersistentID","d":"

Get the persistent connection ID, if there is one.

"},{"t":"M","n":"Redis::getPort","p":"Redis.html#method_getPort","d":"

Get the port we are connected to. This number will be zero if we are connected to a unix socket.

"},{"t":"M","n":"Redis::getRange","p":"Redis.html#method_getRange","d":"

Retrieve a substring of a string by index.

"},{"t":"M","n":"Redis::lcs","p":"Redis.html#method_lcs","d":"

Get the longest common subsequence between two string keys.

"},{"t":"M","n":"Redis::getReadTimeout","p":"Redis.html#method_getReadTimeout","d":"

Get the currently set read timeout on the connection.

"},{"t":"M","n":"Redis::getset","p":"Redis.html#method_getset","d":"

Sets a key and returns any previously set value, if the key already existed.

"},{"t":"M","n":"Redis::getTimeout","p":"Redis.html#method_getTimeout","d":"

Retrieve any set connection timeout

"},{"t":"M","n":"Redis::getTransferredBytes","p":"Redis.html#method_getTransferredBytes","d":null},{"t":"M","n":"Redis::hDel","p":"Redis.html#method_hDel","d":"

Remove one or more fields from a hash.

"},{"t":"M","n":"Redis::hExists","p":"Redis.html#method_hExists","d":"

Checks whether a field exists in a hash.

"},{"t":"M","n":"Redis::hGet","p":"Redis.html#method_hGet","d":null},{"t":"M","n":"Redis::hGetAll","p":"Redis.html#method_hGetAll","d":"

Read every field and value from a hash.

"},{"t":"M","n":"Redis::hIncrBy","p":"Redis.html#method_hIncrBy","d":"

Increment a hash field's value by an integer

"},{"t":"M","n":"Redis::hIncrByFloat","p":"Redis.html#method_hIncrByFloat","d":"

Increment a hash field by a floating point value

"},{"t":"M","n":"Redis::hKeys","p":"Redis.html#method_hKeys","d":"

Retrieve all of the fields of a hash.

"},{"t":"M","n":"Redis::hLen","p":"Redis.html#method_hLen","d":"

Get the number of fields in a hash.

"},{"t":"M","n":"Redis::hMget","p":"Redis.html#method_hMget","d":"

Get one or more fields from a hash.

"},{"t":"M","n":"Redis::hMset","p":"Redis.html#method_hMset","d":"

Add or update one or more hash fields and values

"},{"t":"M","n":"Redis::hRandField","p":"Redis.html#method_hRandField","d":"

Get one or more random field from a hash.

"},{"t":"M","n":"Redis::hSet","p":"Redis.html#method_hSet","d":null},{"t":"M","n":"Redis::hSetNx","p":"Redis.html#method_hSetNx","d":"

Set a hash field and value, but only if that field does not exist

"},{"t":"M","n":"Redis::hStrLen","p":"Redis.html#method_hStrLen","d":"

Get the string length of a hash field

"},{"t":"M","n":"Redis::hVals","p":"Redis.html#method_hVals","d":"

Get all of the values from a hash.

"},{"t":"M","n":"Redis::hscan","p":"Redis.html#method_hscan","d":"

Iterate over the fields and values of a hash in an incremental fashion.

"},{"t":"M","n":"Redis::incr","p":"Redis.html#method_incr","d":"

Increment a key's value, optionally by a specifc amount.

"},{"t":"M","n":"Redis::incrBy","p":"Redis.html#method_incrBy","d":"

Increment a key by a specific integer value

"},{"t":"M","n":"Redis::incrByFloat","p":"Redis.html#method_incrByFloat","d":"

Increment a numeric key by a floating point value.

"},{"t":"M","n":"Redis::info","p":"Redis.html#method_info","d":"

Retrieve information about the connected redis-server. If no arguments are passed to\nthis function, redis will return every info field. Alternatively you may pass a specific\nsection you want returned (e.g. 'server', or 'memory') to receive only information pertaining\nto that section.

"},{"t":"M","n":"Redis::isConnected","p":"Redis.html#method_isConnected","d":"

Check if we are currently connected to a Redis instance.

"},{"t":"M","n":"Redis::keys","p":"Redis.html#method_keys","d":""},{"t":"M","n":"Redis::lInsert","p":"Redis.html#method_lInsert","d":""},{"t":"M","n":"Redis::lLen","p":"Redis.html#method_lLen","d":null},{"t":"M","n":"Redis::lMove","p":"Redis.html#method_lMove","d":null},{"t":"M","n":"Redis::lPop","p":"Redis.html#method_lPop","d":null},{"t":"M","n":"Redis::lPos","p":"Redis.html#method_lPos","d":null},{"t":"M","n":"Redis::lPush","p":"Redis.html#method_lPush","d":""},{"t":"M","n":"Redis::rPush","p":"Redis.html#method_rPush","d":""},{"t":"M","n":"Redis::lPushx","p":"Redis.html#method_lPushx","d":""},{"t":"M","n":"Redis::rPushx","p":"Redis.html#method_rPushx","d":""},{"t":"M","n":"Redis::lSet","p":"Redis.html#method_lSet","d":null},{"t":"M","n":"Redis::lastSave","p":"Redis.html#method_lastSave","d":null},{"t":"M","n":"Redis::lindex","p":"Redis.html#method_lindex","d":null},{"t":"M","n":"Redis::lrange","p":"Redis.html#method_lrange","d":null},{"t":"M","n":"Redis::lrem","p":"Redis.html#method_lrem","d":""},{"t":"M","n":"Redis::ltrim","p":"Redis.html#method_ltrim","d":null},{"t":"M","n":"Redis::mget","p":"Redis.html#method_mget","d":""},{"t":"M","n":"Redis::migrate","p":"Redis.html#method_migrate","d":null},{"t":"M","n":"Redis::move","p":"Redis.html#method_move","d":null},{"t":"M","n":"Redis::mset","p":"Redis.html#method_mset","d":null},{"t":"M","n":"Redis::msetnx","p":"Redis.html#method_msetnx","d":null},{"t":"M","n":"Redis::multi","p":"Redis.html#method_multi","d":null},{"t":"M","n":"Redis::object","p":"Redis.html#method_object","d":null},{"t":"M","n":"Redis::open","p":"Redis.html#method_open","d":""},{"t":"M","n":"Redis::pconnect","p":"Redis.html#method_pconnect","d":null},{"t":"M","n":"Redis::persist","p":"Redis.html#method_persist","d":null},{"t":"M","n":"Redis::pexpire","p":"Redis.html#method_pexpire","d":"

Sets an expiration in milliseconds on a given key. If connected to Redis >= 7.0.0\nyou can pass an optional mode argument that modifies how the command will execute.

"},{"t":"M","n":"Redis::pexpireAt","p":"Redis.html#method_pexpireAt","d":"

Set a key's expiration to a specific Unix Timestamp in milliseconds. If connected to\nRedis >= 7.0.0 you can pass an optional 'mode' argument.

"},{"t":"M","n":"Redis::pfadd","p":"Redis.html#method_pfadd","d":"

Add one or more elements to a Redis HyperLogLog key

"},{"t":"M","n":"Redis::pfcount","p":"Redis.html#method_pfcount","d":"

Retrieve the cardinality of a Redis HyperLogLog key.

"},{"t":"M","n":"Redis::pfmerge","p":"Redis.html#method_pfmerge","d":"

Merge one or more source HyperLogLog sets into a destination set.

"},{"t":"M","n":"Redis::ping","p":"Redis.html#method_ping","d":"

PING the redis server with an optional string argument.

"},{"t":"M","n":"Redis::pipeline","p":"Redis.html#method_pipeline","d":"

Enter into pipeline mode.

"},{"t":"M","n":"Redis::popen","p":"Redis.html#method_popen","d":""},{"t":"M","n":"Redis::psetex","p":"Redis.html#method_psetex","d":""},{"t":"M","n":"Redis::psubscribe","p":"Redis.html#method_psubscribe","d":"

Subscribe to one or more glob-style patterns

"},{"t":"M","n":"Redis::pttl","p":"Redis.html#method_pttl","d":"

Get a keys time to live in milliseconds.

"},{"t":"M","n":"Redis::publish","p":"Redis.html#method_publish","d":"

Publish a message to a pubsub channel

"},{"t":"M","n":"Redis::pubsub","p":"Redis.html#method_pubsub","d":null},{"t":"M","n":"Redis::punsubscribe","p":"Redis.html#method_punsubscribe","d":"

Unsubscribe from one or more channels by pattern

"},{"t":"M","n":"Redis::rPop","p":"Redis.html#method_rPop","d":"

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

"},{"t":"M","n":"Redis::randomKey","p":"Redis.html#method_randomKey","d":"

Return a random key from the current database

"},{"t":"M","n":"Redis::rawcommand","p":"Redis.html#method_rawcommand","d":"

Execute any arbitrary Redis command by name.

"},{"t":"M","n":"Redis::rename","p":"Redis.html#method_rename","d":"

Unconditionally rename a key from $old_name to $new_name

"},{"t":"M","n":"Redis::renameNx","p":"Redis.html#method_renameNx","d":"

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

"},{"t":"M","n":"Redis::reset","p":"Redis.html#method_reset","d":"

Reset the state of the connection.

"},{"t":"M","n":"Redis::restore","p":"Redis.html#method_restore","d":"

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

"},{"t":"M","n":"Redis::role","p":"Redis.html#method_role","d":"

Query whether the connected instance is a primary or replica

"},{"t":"M","n":"Redis::rpoplpush","p":"Redis.html#method_rpoplpush","d":"

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

"},{"t":"M","n":"Redis::sAdd","p":"Redis.html#method_sAdd","d":"

Add one or more values to a Redis SET key.

"},{"t":"M","n":"Redis::sAddArray","p":"Redis.html#method_sAddArray","d":"

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

"},{"t":"M","n":"Redis::sDiff","p":"Redis.html#method_sDiff","d":"

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

"},{"t":"M","n":"Redis::sDiffStore","p":"Redis.html#method_sDiffStore","d":"

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

"},{"t":"M","n":"Redis::sInter","p":"Redis.html#method_sInter","d":"

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

"},{"t":"M","n":"Redis::sintercard","p":"Redis.html#method_sintercard","d":"

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

"},{"t":"M","n":"Redis::sInterStore","p":"Redis.html#method_sInterStore","d":"

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

"},{"t":"M","n":"Redis::sMembers","p":"Redis.html#method_sMembers","d":"

Retrieve every member from a set key.

"},{"t":"M","n":"Redis::sMisMember","p":"Redis.html#method_sMisMember","d":"

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

"},{"t":"M","n":"Redis::sMove","p":"Redis.html#method_sMove","d":"

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

"},{"t":"M","n":"Redis::sPop","p":"Redis.html#method_sPop","d":"

Remove one or more elements from a set.

"},{"t":"M","n":"Redis::sRandMember","p":"Redis.html#method_sRandMember","d":"

Retrieve one or more random members of a set.

"},{"t":"M","n":"Redis::sUnion","p":"Redis.html#method_sUnion","d":"

Returns the union of one or more Redis SET keys.

"},{"t":"M","n":"Redis::sUnionStore","p":"Redis.html#method_sUnionStore","d":"

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

"},{"t":"M","n":"Redis::save","p":"Redis.html#method_save","d":"

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

"},{"t":"M","n":"Redis::scan","p":"Redis.html#method_scan","d":"

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

"},{"t":"M","n":"Redis::scard","p":"Redis.html#method_scard","d":"

Retrieve the number of members in a Redis set.

"},{"t":"M","n":"Redis::script","p":"Redis.html#method_script","d":"

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

"},{"t":"M","n":"Redis::select","p":"Redis.html#method_select","d":"

Select a specific Redis database.

"},{"t":"M","n":"Redis::set","p":"Redis.html#method_set","d":"

Create or set a Redis STRING key to a value.

"},{"t":"M","n":"Redis::setBit","p":"Redis.html#method_setBit","d":"

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

"},{"t":"M","n":"Redis::setRange","p":"Redis.html#method_setRange","d":"

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

"},{"t":"M","n":"Redis::setOption","p":"Redis.html#method_setOption","d":"

Set a configurable option on the Redis object.

"},{"t":"M","n":"Redis::setex","p":"Redis.html#method_setex","d":"

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

"},{"t":"M","n":"Redis::setnx","p":"Redis.html#method_setnx","d":"

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

"},{"t":"M","n":"Redis::sismember","p":"Redis.html#method_sismember","d":"

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

"},{"t":"M","n":"Redis::slaveof","p":"Redis.html#method_slaveof","d":"

Turn a redis instance into a replica of another or promote a replica\nto a primary.

"},{"t":"M","n":"Redis::replicaof","p":"Redis.html#method_replicaof","d":"

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

"},{"t":"M","n":"Redis::touch","p":"Redis.html#method_touch","d":"

Update one or more keys last modified metadata.

"},{"t":"M","n":"Redis::slowlog","p":"Redis.html#method_slowlog","d":"

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

"},{"t":"M","n":"Redis::sort","p":"Redis.html#method_sort","d":"

Sort the contents of a Redis key in various ways.

"},{"t":"M","n":"Redis::sort_ro","p":"Redis.html#method_sort_ro","d":"

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

"},{"t":"M","n":"Redis::sortAsc","p":"Redis.html#method_sortAsc","d":""},{"t":"M","n":"Redis::sortAscAlpha","p":"Redis.html#method_sortAscAlpha","d":""},{"t":"M","n":"Redis::sortDesc","p":"Redis.html#method_sortDesc","d":""},{"t":"M","n":"Redis::sortDescAlpha","p":"Redis.html#method_sortDescAlpha","d":""},{"t":"M","n":"Redis::srem","p":"Redis.html#method_srem","d":"

Remove one or more values from a Redis SET key.

"},{"t":"M","n":"Redis::sscan","p":"Redis.html#method_sscan","d":"

Scan the members of a redis SET key.

"},{"t":"M","n":"Redis::strlen","p":"Redis.html#method_strlen","d":"

Retrieve the length of a Redis STRING key.

"},{"t":"M","n":"Redis::subscribe","p":"Redis.html#method_subscribe","d":"

Subscribe to one or more Redis pubsub channels.

"},{"t":"M","n":"Redis::swapdb","p":"Redis.html#method_swapdb","d":"

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

"},{"t":"M","n":"Redis::time","p":"Redis.html#method_time","d":"

Retrieve the server time from the connected Redis instance.

"},{"t":"M","n":"Redis::ttl","p":"Redis.html#method_ttl","d":"

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

"},{"t":"M","n":"Redis::type","p":"Redis.html#method_type","d":"

Get the type of a given Redis key.

"},{"t":"M","n":"Redis::unlink","p":"Redis.html#method_unlink","d":"

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

"},{"t":"M","n":"Redis::unsubscribe","p":"Redis.html#method_unsubscribe","d":"

Unsubscribe from one or more subscribed channels.

"},{"t":"M","n":"Redis::unwatch","p":"Redis.html#method_unwatch","d":"

Remove any previously WATCH'ed keys in a transaction.

"},{"t":"M","n":"Redis::watch","p":"Redis.html#method_watch","d":""},{"t":"M","n":"Redis::wait","p":"Redis.html#method_wait","d":"

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

"},{"t":"M","n":"Redis::xack","p":"Redis.html#method_xack","d":null},{"t":"M","n":"Redis::xadd","p":"Redis.html#method_xadd","d":"

Append a message to a stream.

"},{"t":"M","n":"Redis::xautoclaim","p":"Redis.html#method_xautoclaim","d":null},{"t":"M","n":"Redis::xclaim","p":"Redis.html#method_xclaim","d":null},{"t":"M","n":"Redis::xdel","p":"Redis.html#method_xdel","d":"

Remove one or more specific IDs from a stream.

"},{"t":"M","n":"Redis::xgroup","p":"Redis.html#method_xgroup","d":"XGROUP"},{"t":"M","n":"Redis::xinfo","p":"Redis.html#method_xinfo","d":"

Retrieve information about a stream key.

"},{"t":"M","n":"Redis::xlen","p":"Redis.html#method_xlen","d":"

Get the number of messages in a Redis STREAM key.

"},{"t":"M","n":"Redis::xpending","p":"Redis.html#method_xpending","d":"

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

"},{"t":"M","n":"Redis::xrange","p":"Redis.html#method_xrange","d":"

Get a range of entries from a STREAM key.

"},{"t":"M","n":"Redis::xread","p":"Redis.html#method_xread","d":"

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

"},{"t":"M","n":"Redis::xreadgroup","p":"Redis.html#method_xreadgroup","d":"

Read one or more messages using a consumer group.

"},{"t":"M","n":"Redis::xrevrange","p":"Redis.html#method_xrevrange","d":"

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

"},{"t":"M","n":"Redis::xtrim","p":"Redis.html#method_xtrim","d":"

Truncate a STREAM key in various ways.

"},{"t":"M","n":"Redis::zAdd","p":"Redis.html#method_zAdd","d":"

Add one or more elements and scores to a Redis sorted set.

"},{"t":"M","n":"Redis::zCard","p":"Redis.html#method_zCard","d":"

Return the number of elements in a sorted set.

"},{"t":"M","n":"Redis::zCount","p":"Redis.html#method_zCount","d":"

Count the number of members in a sorted set with scores inside a provided range.

"},{"t":"M","n":"Redis::zIncrBy","p":"Redis.html#method_zIncrBy","d":"

Create or increment the score of a member in a Redis sorted set

"},{"t":"M","n":"Redis::zLexCount","p":"Redis.html#method_zLexCount","d":"

Count the number of elements in a sorted set whos members fall within the provided\nlexographical range.

"},{"t":"M","n":"Redis::zMscore","p":"Redis.html#method_zMscore","d":"

Retrieve the score of one or more members in a sorted set.

"},{"t":"M","n":"Redis::zPopMax","p":"Redis.html#method_zPopMax","d":"

Pop one or more of the highest scoring elements from a sorted set.

"},{"t":"M","n":"Redis::zPopMin","p":"Redis.html#method_zPopMin","d":"

Pop one or more of the lowest scoring elements from a sorted set.

"},{"t":"M","n":"Redis::zRange","p":"Redis.html#method_zRange","d":"

Retrieve a range of elements of a sorted set between a start and end point.

"},{"t":"M","n":"Redis::zRangeByLex","p":"Redis.html#method_zRangeByLex","d":"

Retrieve a range of elements from a sorted set by legographical range.

"},{"t":"M","n":"Redis::zRangeByScore","p":"Redis.html#method_zRangeByScore","d":"

Retrieve a range of members from a sorted set by their score.

"},{"t":"M","n":"Redis::zrangestore","p":"Redis.html#method_zrangestore","d":"

This command is similar to ZRANGE except that instead of returning the values directly\nit will store them in a destination key provided by the user

"},{"t":"M","n":"Redis::zRandMember","p":"Redis.html#method_zRandMember","d":"

Retrieve one or more random members from a Redis sorted set.

"},{"t":"M","n":"Redis::zRank","p":"Redis.html#method_zRank","d":"

Get the rank of a member of a sorted set, by score.

"},{"t":"M","n":"Redis::zRem","p":"Redis.html#method_zRem","d":"

Remove one or more members from a Redis sorted set.

"},{"t":"M","n":"Redis::zRemRangeByLex","p":"Redis.html#method_zRemRangeByLex","d":"

Remove zero or more elements from a Redis sorted set by legographical range.

"},{"t":"M","n":"Redis::zRemRangeByRank","p":"Redis.html#method_zRemRangeByRank","d":"

Remove one or more members of a sorted set by their rank.

"},{"t":"M","n":"Redis::zRemRangeByScore","p":"Redis.html#method_zRemRangeByScore","d":"

Remove one or more members of a sorted set by their score.

"},{"t":"M","n":"Redis::zRevRange","p":"Redis.html#method_zRevRange","d":"

List the members of a Redis sorted set in reverse order

"},{"t":"M","n":"Redis::zRevRangeByLex","p":"Redis.html#method_zRevRangeByLex","d":"

List members of a Redis sorted set within a legographical range, in reverse order.

"},{"t":"M","n":"Redis::zRevRangeByScore","p":"Redis.html#method_zRevRangeByScore","d":"

List elements from a Redis sorted set by score, highest to lowest

"},{"t":"M","n":"Redis::zRevRank","p":"Redis.html#method_zRevRank","d":"

Retrieve a member of a sorted set by reverse rank.

"},{"t":"M","n":"Redis::zScore","p":"Redis.html#method_zScore","d":"

Get the score of a member of a sorted set.

"},{"t":"M","n":"Redis::zdiff","p":"Redis.html#method_zdiff","d":"

Given one or more sorted set key names, return every element that is in the first\nset but not any of the others.

"},{"t":"M","n":"Redis::zdiffstore","p":"Redis.html#method_zdiffstore","d":"

Store the difference of one or more sorted sets in a destination sorted set.

"},{"t":"M","n":"Redis::zinter","p":"Redis.html#method_zinter","d":"

Compute the intersection of one or more sorted sets and return the members

"},{"t":"M","n":"Redis::zintercard","p":"Redis.html#method_zintercard","d":"

Similar to ZINTER but instead of returning the intersected values, this command returns the\ncardinality of the intersected set.

"},{"t":"M","n":"Redis::zinterstore","p":"Redis.html#method_zinterstore","d":"

Compute the intersection of one ore more sorted sets storing the result in a new sorted set.

"},{"t":"M","n":"Redis::zscan","p":"Redis.html#method_zscan","d":"

Scan the members of a sorted set incrementally, using a cursor

"},{"t":"M","n":"Redis::zunion","p":"Redis.html#method_zunion","d":"

Retrieve the union of one or more sorted sets

"},{"t":"M","n":"Redis::zunionstore","p":"Redis.html#method_zunionstore","d":"

Perform a union on one or more Redis sets and store the result in a destination sorted set.

"},{"t":"M","n":"RedisArray::__call","p":"RedisArray.html#method___call","d":null},{"t":"M","n":"RedisArray::__construct","p":"RedisArray.html#method___construct","d":null},{"t":"M","n":"RedisArray::_continuum","p":"RedisArray.html#method__continuum","d":null},{"t":"M","n":"RedisArray::_distributor","p":"RedisArray.html#method__distributor","d":null},{"t":"M","n":"RedisArray::_function","p":"RedisArray.html#method__function","d":null},{"t":"M","n":"RedisArray::_hosts","p":"RedisArray.html#method__hosts","d":null},{"t":"M","n":"RedisArray::_instance","p":"RedisArray.html#method__instance","d":null},{"t":"M","n":"RedisArray::_rehash","p":"RedisArray.html#method__rehash","d":null},{"t":"M","n":"RedisArray::_target","p":"RedisArray.html#method__target","d":null},{"t":"M","n":"RedisArray::bgsave","p":"RedisArray.html#method_bgsave","d":null},{"t":"M","n":"RedisArray::del","p":"RedisArray.html#method_del","d":null},{"t":"M","n":"RedisArray::discard","p":"RedisArray.html#method_discard","d":null},{"t":"M","n":"RedisArray::exec","p":"RedisArray.html#method_exec","d":null},{"t":"M","n":"RedisArray::flushall","p":"RedisArray.html#method_flushall","d":null},{"t":"M","n":"RedisArray::flushdb","p":"RedisArray.html#method_flushdb","d":null},{"t":"M","n":"RedisArray::getOption","p":"RedisArray.html#method_getOption","d":null},{"t":"M","n":"RedisArray::hscan","p":"RedisArray.html#method_hscan","d":null},{"t":"M","n":"RedisArray::info","p":"RedisArray.html#method_info","d":null},{"t":"M","n":"RedisArray::keys","p":"RedisArray.html#method_keys","d":null},{"t":"M","n":"RedisArray::mget","p":"RedisArray.html#method_mget","d":null},{"t":"M","n":"RedisArray::mset","p":"RedisArray.html#method_mset","d":null},{"t":"M","n":"RedisArray::multi","p":"RedisArray.html#method_multi","d":null},{"t":"M","n":"RedisArray::ping","p":"RedisArray.html#method_ping","d":null},{"t":"M","n":"RedisArray::save","p":"RedisArray.html#method_save","d":null},{"t":"M","n":"RedisArray::scan","p":"RedisArray.html#method_scan","d":null},{"t":"M","n":"RedisArray::select","p":"RedisArray.html#method_select","d":null},{"t":"M","n":"RedisArray::setOption","p":"RedisArray.html#method_setOption","d":null},{"t":"M","n":"RedisArray::sscan","p":"RedisArray.html#method_sscan","d":null},{"t":"M","n":"RedisArray::unlink","p":"RedisArray.html#method_unlink","d":null},{"t":"M","n":"RedisArray::unwatch","p":"RedisArray.html#method_unwatch","d":null},{"t":"M","n":"RedisArray::zscan","p":"RedisArray.html#method_zscan","d":null},{"t":"M","n":"RedisCluster::__construct","p":"RedisCluster.html#method___construct","d":null},{"t":"M","n":"RedisCluster::_compress","p":"RedisCluster.html#method__compress","d":""},{"t":"M","n":"RedisCluster::_uncompress","p":"RedisCluster.html#method__uncompress","d":""},{"t":"M","n":"RedisCluster::_serialize","p":"RedisCluster.html#method__serialize","d":""},{"t":"M","n":"RedisCluster::_unserialize","p":"RedisCluster.html#method__unserialize","d":""},{"t":"M","n":"RedisCluster::_pack","p":"RedisCluster.html#method__pack","d":""},{"t":"M","n":"RedisCluster::_unpack","p":"RedisCluster.html#method__unpack","d":""},{"t":"M","n":"RedisCluster::_prefix","p":"RedisCluster.html#method__prefix","d":""},{"t":"M","n":"RedisCluster::_masters","p":"RedisCluster.html#method__masters","d":null},{"t":"M","n":"RedisCluster::_redir","p":"RedisCluster.html#method__redir","d":null},{"t":"M","n":"RedisCluster::acl","p":"RedisCluster.html#method_acl","d":""},{"t":"M","n":"RedisCluster::append","p":"RedisCluster.html#method_append","d":""},{"t":"M","n":"RedisCluster::bgrewriteaof","p":"RedisCluster.html#method_bgrewriteaof","d":""},{"t":"M","n":"RedisCluster::bgsave","p":"RedisCluster.html#method_bgsave","d":""},{"t":"M","n":"RedisCluster::bitcount","p":"RedisCluster.html#method_bitcount","d":""},{"t":"M","n":"RedisCluster::bitop","p":"RedisCluster.html#method_bitop","d":""},{"t":"M","n":"RedisCluster::bitpos","p":"RedisCluster.html#method_bitpos","d":"

Return the position of the first bit set to 0 or 1 in a string.

"},{"t":"M","n":"RedisCluster::blpop","p":"RedisCluster.html#method_blpop","d":"

See Redis::blpop()

"},{"t":"M","n":"RedisCluster::brpop","p":"RedisCluster.html#method_brpop","d":"

See Redis::brpop()

"},{"t":"M","n":"RedisCluster::brpoplpush","p":"RedisCluster.html#method_brpoplpush","d":"

See Redis::brpoplpush()

"},{"t":"M","n":"RedisCluster::bzpopmax","p":"RedisCluster.html#method_bzpopmax","d":""},{"t":"M","n":"RedisCluster::bzpopmin","p":"RedisCluster.html#method_bzpopmin","d":""},{"t":"M","n":"RedisCluster::bzmpop","p":"RedisCluster.html#method_bzmpop","d":""},{"t":"M","n":"RedisCluster::zmpop","p":"RedisCluster.html#method_zmpop","d":""},{"t":"M","n":"RedisCluster::blmpop","p":"RedisCluster.html#method_blmpop","d":""},{"t":"M","n":"RedisCluster::lmpop","p":"RedisCluster.html#method_lmpop","d":""},{"t":"M","n":"RedisCluster::clearlasterror","p":"RedisCluster.html#method_clearlasterror","d":""},{"t":"M","n":"RedisCluster::client","p":"RedisCluster.html#method_client","d":""},{"t":"M","n":"RedisCluster::close","p":"RedisCluster.html#method_close","d":""},{"t":"M","n":"RedisCluster::cluster","p":"RedisCluster.html#method_cluster","d":""},{"t":"M","n":"RedisCluster::command","p":"RedisCluster.html#method_command","d":""},{"t":"M","n":"RedisCluster::config","p":"RedisCluster.html#method_config","d":""},{"t":"M","n":"RedisCluster::dbsize","p":"RedisCluster.html#method_dbsize","d":""},{"t":"M","n":"RedisCluster::decr","p":"RedisCluster.html#method_decr","d":""},{"t":"M","n":"RedisCluster::decrby","p":"RedisCluster.html#method_decrby","d":""},{"t":"M","n":"RedisCluster::decrbyfloat","p":"RedisCluster.html#method_decrbyfloat","d":""},{"t":"M","n":"RedisCluster::del","p":"RedisCluster.html#method_del","d":""},{"t":"M","n":"RedisCluster::discard","p":"RedisCluster.html#method_discard","d":""},{"t":"M","n":"RedisCluster::dump","p":"RedisCluster.html#method_dump","d":""},{"t":"M","n":"RedisCluster::echo","p":"RedisCluster.html#method_echo","d":""},{"t":"M","n":"RedisCluster::eval","p":"RedisCluster.html#method_eval","d":""},{"t":"M","n":"RedisCluster::eval_ro","p":"RedisCluster.html#method_eval_ro","d":""},{"t":"M","n":"RedisCluster::evalsha","p":"RedisCluster.html#method_evalsha","d":""},{"t":"M","n":"RedisCluster::evalsha_ro","p":"RedisCluster.html#method_evalsha_ro","d":""},{"t":"M","n":"RedisCluster::exec","p":"RedisCluster.html#method_exec","d":""},{"t":"M","n":"RedisCluster::exists","p":"RedisCluster.html#method_exists","d":""},{"t":"M","n":"RedisCluster::touch","p":"RedisCluster.html#method_touch","d":""},{"t":"M","n":"RedisCluster::expire","p":"RedisCluster.html#method_expire","d":""},{"t":"M","n":"RedisCluster::expireat","p":"RedisCluster.html#method_expireat","d":""},{"t":"M","n":"RedisCluster::expiretime","p":"RedisCluster.html#method_expiretime","d":""},{"t":"M","n":"RedisCluster::pexpiretime","p":"RedisCluster.html#method_pexpiretime","d":""},{"t":"M","n":"RedisCluster::flushall","p":"RedisCluster.html#method_flushall","d":""},{"t":"M","n":"RedisCluster::flushdb","p":"RedisCluster.html#method_flushdb","d":""},{"t":"M","n":"RedisCluster::geoadd","p":"RedisCluster.html#method_geoadd","d":""},{"t":"M","n":"RedisCluster::geodist","p":"RedisCluster.html#method_geodist","d":""},{"t":"M","n":"RedisCluster::geohash","p":"RedisCluster.html#method_geohash","d":""},{"t":"M","n":"RedisCluster::geopos","p":"RedisCluster.html#method_geopos","d":""},{"t":"M","n":"RedisCluster::georadius","p":"RedisCluster.html#method_georadius","d":""},{"t":"M","n":"RedisCluster::georadius_ro","p":"RedisCluster.html#method_georadius_ro","d":""},{"t":"M","n":"RedisCluster::georadiusbymember","p":"RedisCluster.html#method_georadiusbymember","d":""},{"t":"M","n":"RedisCluster::georadiusbymember_ro","p":"RedisCluster.html#method_georadiusbymember_ro","d":""},{"t":"M","n":"RedisCluster::get","p":"RedisCluster.html#method_get","d":""},{"t":"M","n":"RedisCluster::getbit","p":"RedisCluster.html#method_getbit","d":""},{"t":"M","n":"RedisCluster::getlasterror","p":"RedisCluster.html#method_getlasterror","d":""},{"t":"M","n":"RedisCluster::getmode","p":"RedisCluster.html#method_getmode","d":""},{"t":"M","n":"RedisCluster::getoption","p":"RedisCluster.html#method_getoption","d":""},{"t":"M","n":"RedisCluster::getrange","p":"RedisCluster.html#method_getrange","d":""},{"t":"M","n":"RedisCluster::lcs","p":"RedisCluster.html#method_lcs","d":""},{"t":"M","n":"RedisCluster::getset","p":"RedisCluster.html#method_getset","d":""},{"t":"M","n":"RedisCluster::gettransferredbytes","p":"RedisCluster.html#method_gettransferredbytes","d":""},{"t":"M","n":"RedisCluster::hdel","p":"RedisCluster.html#method_hdel","d":""},{"t":"M","n":"RedisCluster::hexists","p":"RedisCluster.html#method_hexists","d":""},{"t":"M","n":"RedisCluster::hget","p":"RedisCluster.html#method_hget","d":""},{"t":"M","n":"RedisCluster::hgetall","p":"RedisCluster.html#method_hgetall","d":""},{"t":"M","n":"RedisCluster::hincrby","p":"RedisCluster.html#method_hincrby","d":""},{"t":"M","n":"RedisCluster::hincrbyfloat","p":"RedisCluster.html#method_hincrbyfloat","d":""},{"t":"M","n":"RedisCluster::hkeys","p":"RedisCluster.html#method_hkeys","d":""},{"t":"M","n":"RedisCluster::hlen","p":"RedisCluster.html#method_hlen","d":""},{"t":"M","n":"RedisCluster::hmget","p":"RedisCluster.html#method_hmget","d":""},{"t":"M","n":"RedisCluster::hmset","p":"RedisCluster.html#method_hmset","d":""},{"t":"M","n":"RedisCluster::hscan","p":"RedisCluster.html#method_hscan","d":""},{"t":"M","n":"RedisCluster::hset","p":"RedisCluster.html#method_hset","d":""},{"t":"M","n":"RedisCluster::hsetnx","p":"RedisCluster.html#method_hsetnx","d":""},{"t":"M","n":"RedisCluster::hstrlen","p":"RedisCluster.html#method_hstrlen","d":""},{"t":"M","n":"RedisCluster::hvals","p":"RedisCluster.html#method_hvals","d":""},{"t":"M","n":"RedisCluster::incr","p":"RedisCluster.html#method_incr","d":""},{"t":"M","n":"RedisCluster::incrby","p":"RedisCluster.html#method_incrby","d":""},{"t":"M","n":"RedisCluster::incrbyfloat","p":"RedisCluster.html#method_incrbyfloat","d":""},{"t":"M","n":"RedisCluster::info","p":"RedisCluster.html#method_info","d":"

Retrieve information about the connected redis-server. If no arguments are passed to\nthis function, redis will return every info field. Alternatively you may pass a specific\nsection you want returned (e.g. 'server', or 'memory') to receive only information pertaining\nto that section.

"},{"t":"M","n":"RedisCluster::keys","p":"RedisCluster.html#method_keys","d":""},{"t":"M","n":"RedisCluster::lastsave","p":"RedisCluster.html#method_lastsave","d":""},{"t":"M","n":"RedisCluster::lget","p":"RedisCluster.html#method_lget","d":""},{"t":"M","n":"RedisCluster::lindex","p":"RedisCluster.html#method_lindex","d":""},{"t":"M","n":"RedisCluster::linsert","p":"RedisCluster.html#method_linsert","d":""},{"t":"M","n":"RedisCluster::llen","p":"RedisCluster.html#method_llen","d":""},{"t":"M","n":"RedisCluster::lpop","p":"RedisCluster.html#method_lpop","d":""},{"t":"M","n":"RedisCluster::lpush","p":"RedisCluster.html#method_lpush","d":""},{"t":"M","n":"RedisCluster::lpushx","p":"RedisCluster.html#method_lpushx","d":""},{"t":"M","n":"RedisCluster::lrange","p":"RedisCluster.html#method_lrange","d":""},{"t":"M","n":"RedisCluster::lrem","p":"RedisCluster.html#method_lrem","d":""},{"t":"M","n":"RedisCluster::lset","p":"RedisCluster.html#method_lset","d":""},{"t":"M","n":"RedisCluster::ltrim","p":"RedisCluster.html#method_ltrim","d":""},{"t":"M","n":"RedisCluster::mget","p":"RedisCluster.html#method_mget","d":""},{"t":"M","n":"RedisCluster::mset","p":"RedisCluster.html#method_mset","d":""},{"t":"M","n":"RedisCluster::msetnx","p":"RedisCluster.html#method_msetnx","d":""},{"t":"M","n":"RedisCluster::multi","p":"RedisCluster.html#method_multi","d":null},{"t":"M","n":"RedisCluster::object","p":"RedisCluster.html#method_object","d":""},{"t":"M","n":"RedisCluster::persist","p":"RedisCluster.html#method_persist","d":""},{"t":"M","n":"RedisCluster::pexpire","p":"RedisCluster.html#method_pexpire","d":""},{"t":"M","n":"RedisCluster::pexpireat","p":"RedisCluster.html#method_pexpireat","d":""},{"t":"M","n":"RedisCluster::pfadd","p":"RedisCluster.html#method_pfadd","d":""},{"t":"M","n":"RedisCluster::pfcount","p":"RedisCluster.html#method_pfcount","d":""},{"t":"M","n":"RedisCluster::pfmerge","p":"RedisCluster.html#method_pfmerge","d":""},{"t":"M","n":"RedisCluster::ping","p":"RedisCluster.html#method_ping","d":"

PING an instance in the redis cluster.

"},{"t":"M","n":"RedisCluster::psetex","p":"RedisCluster.html#method_psetex","d":""},{"t":"M","n":"RedisCluster::psubscribe","p":"RedisCluster.html#method_psubscribe","d":""},{"t":"M","n":"RedisCluster::pttl","p":"RedisCluster.html#method_pttl","d":""},{"t":"M","n":"RedisCluster::publish","p":"RedisCluster.html#method_publish","d":""},{"t":"M","n":"RedisCluster::pubsub","p":"RedisCluster.html#method_pubsub","d":""},{"t":"M","n":"RedisCluster::punsubscribe","p":"RedisCluster.html#method_punsubscribe","d":""},{"t":"M","n":"RedisCluster::randomkey","p":"RedisCluster.html#method_randomkey","d":""},{"t":"M","n":"RedisCluster::rawcommand","p":"RedisCluster.html#method_rawcommand","d":""},{"t":"M","n":"RedisCluster::rename","p":"RedisCluster.html#method_rename","d":""},{"t":"M","n":"RedisCluster::renamenx","p":"RedisCluster.html#method_renamenx","d":""},{"t":"M","n":"RedisCluster::restore","p":"RedisCluster.html#method_restore","d":""},{"t":"M","n":"RedisCluster::role","p":"RedisCluster.html#method_role","d":""},{"t":"M","n":"RedisCluster::rpop","p":"RedisCluster.html#method_rpop","d":""},{"t":"M","n":"RedisCluster::rpoplpush","p":"RedisCluster.html#method_rpoplpush","d":""},{"t":"M","n":"RedisCluster::rpush","p":"RedisCluster.html#method_rpush","d":""},{"t":"M","n":"RedisCluster::rpushx","p":"RedisCluster.html#method_rpushx","d":""},{"t":"M","n":"RedisCluster::sadd","p":"RedisCluster.html#method_sadd","d":""},{"t":"M","n":"RedisCluster::saddarray","p":"RedisCluster.html#method_saddarray","d":""},{"t":"M","n":"RedisCluster::save","p":"RedisCluster.html#method_save","d":""},{"t":"M","n":"RedisCluster::scan","p":"RedisCluster.html#method_scan","d":""},{"t":"M","n":"RedisCluster::scard","p":"RedisCluster.html#method_scard","d":""},{"t":"M","n":"RedisCluster::script","p":"RedisCluster.html#method_script","d":""},{"t":"M","n":"RedisCluster::sdiff","p":"RedisCluster.html#method_sdiff","d":""},{"t":"M","n":"RedisCluster::sdiffstore","p":"RedisCluster.html#method_sdiffstore","d":""},{"t":"M","n":"RedisCluster::set","p":"RedisCluster.html#method_set","d":""},{"t":"M","n":"RedisCluster::setbit","p":"RedisCluster.html#method_setbit","d":""},{"t":"M","n":"RedisCluster::setex","p":"RedisCluster.html#method_setex","d":""},{"t":"M","n":"RedisCluster::setnx","p":"RedisCluster.html#method_setnx","d":""},{"t":"M","n":"RedisCluster::setoption","p":"RedisCluster.html#method_setoption","d":""},{"t":"M","n":"RedisCluster::setrange","p":"RedisCluster.html#method_setrange","d":""},{"t":"M","n":"RedisCluster::sinter","p":"RedisCluster.html#method_sinter","d":""},{"t":"M","n":"RedisCluster::sintercard","p":"RedisCluster.html#method_sintercard","d":""},{"t":"M","n":"RedisCluster::sinterstore","p":"RedisCluster.html#method_sinterstore","d":""},{"t":"M","n":"RedisCluster::sismember","p":"RedisCluster.html#method_sismember","d":""},{"t":"M","n":"RedisCluster::slowlog","p":"RedisCluster.html#method_slowlog","d":""},{"t":"M","n":"RedisCluster::smembers","p":"RedisCluster.html#method_smembers","d":""},{"t":"M","n":"RedisCluster::smove","p":"RedisCluster.html#method_smove","d":""},{"t":"M","n":"RedisCluster::sort","p":"RedisCluster.html#method_sort","d":""},{"t":"M","n":"RedisCluster::sort_ro","p":"RedisCluster.html#method_sort_ro","d":""},{"t":"M","n":"RedisCluster::spop","p":"RedisCluster.html#method_spop","d":""},{"t":"M","n":"RedisCluster::srandmember","p":"RedisCluster.html#method_srandmember","d":""},{"t":"M","n":"RedisCluster::srem","p":"RedisCluster.html#method_srem","d":""},{"t":"M","n":"RedisCluster::sscan","p":"RedisCluster.html#method_sscan","d":""},{"t":"M","n":"RedisCluster::strlen","p":"RedisCluster.html#method_strlen","d":""},{"t":"M","n":"RedisCluster::subscribe","p":"RedisCluster.html#method_subscribe","d":""},{"t":"M","n":"RedisCluster::sunion","p":"RedisCluster.html#method_sunion","d":""},{"t":"M","n":"RedisCluster::sunionstore","p":"RedisCluster.html#method_sunionstore","d":""},{"t":"M","n":"RedisCluster::time","p":"RedisCluster.html#method_time","d":""},{"t":"M","n":"RedisCluster::ttl","p":"RedisCluster.html#method_ttl","d":""},{"t":"M","n":"RedisCluster::type","p":"RedisCluster.html#method_type","d":""},{"t":"M","n":"RedisCluster::unsubscribe","p":"RedisCluster.html#method_unsubscribe","d":""},{"t":"M","n":"RedisCluster::unlink","p":"RedisCluster.html#method_unlink","d":""},{"t":"M","n":"RedisCluster::unwatch","p":"RedisCluster.html#method_unwatch","d":""},{"t":"M","n":"RedisCluster::watch","p":"RedisCluster.html#method_watch","d":""},{"t":"M","n":"RedisCluster::xack","p":"RedisCluster.html#method_xack","d":""},{"t":"M","n":"RedisCluster::xadd","p":"RedisCluster.html#method_xadd","d":""},{"t":"M","n":"RedisCluster::xclaim","p":"RedisCluster.html#method_xclaim","d":""},{"t":"M","n":"RedisCluster::xdel","p":"RedisCluster.html#method_xdel","d":""},{"t":"M","n":"RedisCluster::xgroup","p":"RedisCluster.html#method_xgroup","d":""},{"t":"M","n":"RedisCluster::xinfo","p":"RedisCluster.html#method_xinfo","d":""},{"t":"M","n":"RedisCluster::xlen","p":"RedisCluster.html#method_xlen","d":""},{"t":"M","n":"RedisCluster::xpending","p":"RedisCluster.html#method_xpending","d":""},{"t":"M","n":"RedisCluster::xrange","p":"RedisCluster.html#method_xrange","d":""},{"t":"M","n":"RedisCluster::xread","p":"RedisCluster.html#method_xread","d":""},{"t":"M","n":"RedisCluster::xreadgroup","p":"RedisCluster.html#method_xreadgroup","d":""},{"t":"M","n":"RedisCluster::xrevrange","p":"RedisCluster.html#method_xrevrange","d":""},{"t":"M","n":"RedisCluster::xtrim","p":"RedisCluster.html#method_xtrim","d":""},{"t":"M","n":"RedisCluster::zadd","p":"RedisCluster.html#method_zadd","d":""},{"t":"M","n":"RedisCluster::zcard","p":"RedisCluster.html#method_zcard","d":""},{"t":"M","n":"RedisCluster::zcount","p":"RedisCluster.html#method_zcount","d":""},{"t":"M","n":"RedisCluster::zincrby","p":"RedisCluster.html#method_zincrby","d":""},{"t":"M","n":"RedisCluster::zinterstore","p":"RedisCluster.html#method_zinterstore","d":""},{"t":"M","n":"RedisCluster::zintercard","p":"RedisCluster.html#method_zintercard","d":""},{"t":"M","n":"RedisCluster::zlexcount","p":"RedisCluster.html#method_zlexcount","d":""},{"t":"M","n":"RedisCluster::zpopmax","p":"RedisCluster.html#method_zpopmax","d":""},{"t":"M","n":"RedisCluster::zpopmin","p":"RedisCluster.html#method_zpopmin","d":""},{"t":"M","n":"RedisCluster::zrange","p":"RedisCluster.html#method_zrange","d":""},{"t":"M","n":"RedisCluster::zrangestore","p":"RedisCluster.html#method_zrangestore","d":""},{"t":"M","n":"RedisCluster::zrangebylex","p":"RedisCluster.html#method_zrangebylex","d":""},{"t":"M","n":"RedisCluster::zrangebyscore","p":"RedisCluster.html#method_zrangebyscore","d":""},{"t":"M","n":"RedisCluster::zrank","p":"RedisCluster.html#method_zrank","d":""},{"t":"M","n":"RedisCluster::zrem","p":"RedisCluster.html#method_zrem","d":""},{"t":"M","n":"RedisCluster::zremrangebylex","p":"RedisCluster.html#method_zremrangebylex","d":""},{"t":"M","n":"RedisCluster::zremrangebyrank","p":"RedisCluster.html#method_zremrangebyrank","d":""},{"t":"M","n":"RedisCluster::zremrangebyscore","p":"RedisCluster.html#method_zremrangebyscore","d":""},{"t":"M","n":"RedisCluster::zrevrange","p":"RedisCluster.html#method_zrevrange","d":""},{"t":"M","n":"RedisCluster::zrevrangebylex","p":"RedisCluster.html#method_zrevrangebylex","d":""},{"t":"M","n":"RedisCluster::zrevrangebyscore","p":"RedisCluster.html#method_zrevrangebyscore","d":""},{"t":"M","n":"RedisCluster::zrevrank","p":"RedisCluster.html#method_zrevrank","d":""},{"t":"M","n":"RedisCluster::zscan","p":"RedisCluster.html#method_zscan","d":""},{"t":"M","n":"RedisCluster::zscore","p":"RedisCluster.html#method_zscore","d":""},{"t":"M","n":"RedisCluster::zunionstore","p":"RedisCluster.html#method_zunionstore","d":""},{"t":"M","n":"RedisSentinel::__construct","p":"RedisSentinel.html#method___construct","d":null},{"t":"M","n":"RedisSentinel::ckquorum","p":"RedisSentinel.html#method_ckquorum","d":""},{"t":"M","n":"RedisSentinel::failover","p":"RedisSentinel.html#method_failover","d":""},{"t":"M","n":"RedisSentinel::flushconfig","p":"RedisSentinel.html#method_flushconfig","d":""},{"t":"M","n":"RedisSentinel::getMasterAddrByName","p":"RedisSentinel.html#method_getMasterAddrByName","d":""},{"t":"M","n":"RedisSentinel::master","p":"RedisSentinel.html#method_master","d":""},{"t":"M","n":"RedisSentinel::masters","p":"RedisSentinel.html#method_masters","d":""},{"t":"M","n":"RedisSentinel::myid","p":"RedisSentinel.html#method_myid","d":null},{"t":"M","n":"RedisSentinel::ping","p":"RedisSentinel.html#method_ping","d":""},{"t":"M","n":"RedisSentinel::reset","p":"RedisSentinel.html#method_reset","d":""},{"t":"M","n":"RedisSentinel::sentinels","p":"RedisSentinel.html#method_sentinels","d":""},{"t":"M","n":"RedisSentinel::slaves","p":"RedisSentinel.html#method_slaves","d":""},{"t":"N","n":"","p":"[Global_Namespace].html"}]} +{"items":[{"t":"C","n":"Redis","p":"Redis.html","d":"","f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisArray","p":"RedisArray.html","d":"","f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisCluster","p":"RedisCluster.html","d":"","f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisClusterException","p":"RedisClusterException.html","d":null,"f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisException","p":"RedisException.html","d":null,"f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"C","n":"RedisSentinel","p":"RedisSentinel.html","d":"","f":{"n":"[Global Namespace]","p":"[Global_Namespace].html"}},{"t":"M","n":"Redis::__construct","p":"Redis.html#method___construct","d":"

Create a new Redis instance. If passed sufficient information in the\noptions array it is also possible to connect to an instance at the same\ntime.

"},{"t":"M","n":"Redis::__destruct","p":"Redis.html#method___destruct","d":null},{"t":"M","n":"Redis::_compress","p":"Redis.html#method__compress","d":"

Compress a value with the currently configured compressor as set with\nRedis::setOption().

"},{"t":"M","n":"Redis::_uncompress","p":"Redis.html#method__uncompress","d":"

Uncompress the provided argument that has been compressed with the\ncurrently configured compressor as set with Redis::setOption().

"},{"t":"M","n":"Redis::_prefix","p":"Redis.html#method__prefix","d":"

Prefix the passed argument with the currently set key prefix as set\nwith Redis::setOption().

"},{"t":"M","n":"Redis::_serialize","p":"Redis.html#method__serialize","d":"

Serialize the provided value with the currently set serializer as set\nwith Redis::setOption().

"},{"t":"M","n":"Redis::_unserialize","p":"Redis.html#method__unserialize","d":"

Unserialize the passed argument with the currently set serializer as set\nwith Redis::setOption().

"},{"t":"M","n":"Redis::_pack","p":"Redis.html#method__pack","d":"

Pack the provided value with the configured serializer and compressor\nas set with Redis::setOption().

"},{"t":"M","n":"Redis::_unpack","p":"Redis.html#method__unpack","d":"

Unpack the provided value with the configured compressor and serializer\nas set with Redis::setOption().

"},{"t":"M","n":"Redis::acl","p":"Redis.html#method_acl","d":null},{"t":"M","n":"Redis::append","p":"Redis.html#method_append","d":"

Append data to a Redis STRING key.

"},{"t":"M","n":"Redis::auth","p":"Redis.html#method_auth","d":"

Authenticate a Redis connection after its been established.

"},{"t":"M","n":"Redis::bgSave","p":"Redis.html#method_bgSave","d":"

Execute a save of the Redis database in the background.

"},{"t":"M","n":"Redis::bgrewriteaof","p":"Redis.html#method_bgrewriteaof","d":"

Asynchronously rewrite Redis' append-only file

"},{"t":"M","n":"Redis::bitcount","p":"Redis.html#method_bitcount","d":"

Count the number of set bits in a Redis string.

"},{"t":"M","n":"Redis::bitop","p":"Redis.html#method_bitop","d":null},{"t":"M","n":"Redis::bitpos","p":"Redis.html#method_bitpos","d":"

Return the position of the first bit set to 0 or 1 in a string.

"},{"t":"M","n":"Redis::blPop","p":"Redis.html#method_blPop","d":"

Pop an element off the beginning of a Redis list or lists, potentially blocking up to a specified\ntimeout. This method may be called in two distinct ways, of which examples are provided below.

"},{"t":"M","n":"Redis::brPop","p":"Redis.html#method_brPop","d":"

Pop an element off of the end of a Redis list or lists, potentially blocking up to a specified timeout.

"},{"t":"M","n":"Redis::brpoplpush","p":"Redis.html#method_brpoplpush","d":"

Pop an element from the end of a Redis list, pushing it to the beginning of another Redis list,\noptionally blocking up to a specified timeout.

"},{"t":"M","n":"Redis::bzPopMax","p":"Redis.html#method_bzPopMax","d":"

POP the maximum scoring element off of one or more sorted sets, blocking up to a specified\ntimeout if no elements are available.

"},{"t":"M","n":"Redis::bzPopMin","p":"Redis.html#method_bzPopMin","d":"

POP the minimum scoring element off of one or more sorted sets, blocking up to a specified timeout\nif no elements are available

"},{"t":"M","n":"Redis::bzmpop","p":"Redis.html#method_bzmpop","d":"

POP one or more elements from one or more sorted sets, blocking up to a specified amount of time\nwhen no elements are available.

"},{"t":"M","n":"Redis::zmpop","p":"Redis.html#method_zmpop","d":"

POP one or more of the highest or lowest scoring elements from one or more sorted sets.

"},{"t":"M","n":"Redis::blmpop","p":"Redis.html#method_blmpop","d":"

Pop one or more elements from one or more Redis LISTs, blocking up to a specified timeout when\nno elements are available.

"},{"t":"M","n":"Redis::lmpop","p":"Redis.html#method_lmpop","d":"

Pop one or more elements off of one or more Redis LISTs.

"},{"t":"M","n":"Redis::clearLastError","p":"Redis.html#method_clearLastError","d":"

Reset any last error on the connection to NULL

"},{"t":"M","n":"Redis::client","p":"Redis.html#method_client","d":null},{"t":"M","n":"Redis::close","p":"Redis.html#method_close","d":null},{"t":"M","n":"Redis::command","p":"Redis.html#method_command","d":null},{"t":"M","n":"Redis::config","p":"Redis.html#method_config","d":"

Execute the Redis CONFIG command in a variety of ways.

"},{"t":"M","n":"Redis::connect","p":"Redis.html#method_connect","d":null},{"t":"M","n":"Redis::copy","p":"Redis.html#method_copy","d":"

Make a copy of a key.

"},{"t":"M","n":"Redis::dbSize","p":"Redis.html#method_dbSize","d":"

Return the number of keys in the currently selected Redis database.

"},{"t":"M","n":"Redis::debug","p":"Redis.html#method_debug","d":null},{"t":"M","n":"Redis::decr","p":"Redis.html#method_decr","d":"

Decrement a Redis integer by 1 or a provided value.

"},{"t":"M","n":"Redis::decrBy","p":"Redis.html#method_decrBy","d":"

Decrement a redis integer by a value

"},{"t":"M","n":"Redis::del","p":"Redis.html#method_del","d":"

Delete one or more keys from Redis.

"},{"t":"M","n":"Redis::delete","p":"Redis.html#method_delete","d":""},{"t":"M","n":"Redis::discard","p":"Redis.html#method_discard","d":"

Discard a transaction currently in progress.

"},{"t":"M","n":"Redis::dump","p":"Redis.html#method_dump","d":"

Dump Redis' internal binary representation of a key.

"},{"t":"M","n":"Redis::echo","p":"Redis.html#method_echo","d":"

Have Redis repeat back an arbitrary string to the client.

"},{"t":"M","n":"Redis::eval","p":"Redis.html#method_eval","d":"

Execute a LUA script on the redis server.

"},{"t":"M","n":"Redis::eval_ro","p":"Redis.html#method_eval_ro","d":"

This is simply the read-only variant of eval, meaning the underlying script\nmay not modify data in redis.

"},{"t":"M","n":"Redis::evalsha","p":"Redis.html#method_evalsha","d":"

Execute a LUA script on the server but instead of sending the script, send\nthe SHA1 hash of the script.

"},{"t":"M","n":"Redis::evalsha_ro","p":"Redis.html#method_evalsha_ro","d":"

This is simply the read-only variant of evalsha, meaning the underlying script\nmay not modify data in redis.

"},{"t":"M","n":"Redis::exec","p":"Redis.html#method_exec","d":"

Execute either a MULTI or PIPELINE block and return the array of replies.

"},{"t":"M","n":"Redis::exists","p":"Redis.html#method_exists","d":"

Test if one or more keys exist.

"},{"t":"M","n":"Redis::expire","p":"Redis.html#method_expire","d":"

Sets an expiration in seconds on the key in question. If connected to\nredis-server >= 7.0.0 you may send an additional "mode" argument which\nmodifies how the command will execute.

"},{"t":"M","n":"Redis::expireAt","p":"Redis.html#method_expireAt","d":"

Set a key to expire at an exact unix timestamp.

"},{"t":"M","n":"Redis::failover","p":"Redis.html#method_failover","d":null},{"t":"M","n":"Redis::expiretime","p":"Redis.html#method_expiretime","d":"

Get the expiration of a given key as a unix timestamp

"},{"t":"M","n":"Redis::pexpiretime","p":"Redis.html#method_pexpiretime","d":"

Get the expriation timestamp of a given Redis key but in milliseconds.

"},{"t":"M","n":"Redis::flushAll","p":"Redis.html#method_flushAll","d":"

Deletes every key in all Redis databases

"},{"t":"M","n":"Redis::flushDB","p":"Redis.html#method_flushDB","d":"

Deletes all the keys of the currently selected database.

"},{"t":"M","n":"Redis::geoadd","p":"Redis.html#method_geoadd","d":null},{"t":"M","n":"Redis::geodist","p":"Redis.html#method_geodist","d":null},{"t":"M","n":"Redis::geohash","p":"Redis.html#method_geohash","d":null},{"t":"M","n":"Redis::geopos","p":"Redis.html#method_geopos","d":null},{"t":"M","n":"Redis::georadius","p":"Redis.html#method_georadius","d":null},{"t":"M","n":"Redis::georadius_ro","p":"Redis.html#method_georadius_ro","d":null},{"t":"M","n":"Redis::georadiusbymember","p":"Redis.html#method_georadiusbymember","d":null},{"t":"M","n":"Redis::georadiusbymember_ro","p":"Redis.html#method_georadiusbymember_ro","d":null},{"t":"M","n":"Redis::geosearch","p":"Redis.html#method_geosearch","d":null},{"t":"M","n":"Redis::geosearchstore","p":"Redis.html#method_geosearchstore","d":null},{"t":"M","n":"Redis::get","p":"Redis.html#method_get","d":null},{"t":"M","n":"Redis::getAuth","p":"Redis.html#method_getAuth","d":"

Get the authentication information on the connection, if any.

"},{"t":"M","n":"Redis::getBit","p":"Redis.html#method_getBit","d":null},{"t":"M","n":"Redis::getEx","p":"Redis.html#method_getEx","d":null},{"t":"M","n":"Redis::getDBNum","p":"Redis.html#method_getDBNum","d":"

Get the database number PhpRedis thinks we're connected to.

"},{"t":"M","n":"Redis::getDel","p":"Redis.html#method_getDel","d":null},{"t":"M","n":"Redis::getHost","p":"Redis.html#method_getHost","d":"

Return the host or Unix socket we are connected to.

"},{"t":"M","n":"Redis::getLastError","p":"Redis.html#method_getLastError","d":"

Get the last error returned to us from Redis, if any.

"},{"t":"M","n":"Redis::getMode","p":"Redis.html#method_getMode","d":"

Returns whether the connection is in ATOMIC, MULTI, or PIPELINE mode

"},{"t":"M","n":"Redis::getOption","p":"Redis.html#method_getOption","d":"

Retrieve the value of a configuration setting as set by Redis::setOption()

"},{"t":"M","n":"Redis::getPersistentID","p":"Redis.html#method_getPersistentID","d":"

Get the persistent connection ID, if there is one.

"},{"t":"M","n":"Redis::getPort","p":"Redis.html#method_getPort","d":"

Get the port we are connected to. This number will be zero if we are connected to a unix socket.

"},{"t":"M","n":"Redis::getRange","p":"Redis.html#method_getRange","d":"

Retrieve a substring of a string by index.

"},{"t":"M","n":"Redis::lcs","p":"Redis.html#method_lcs","d":"

Get the longest common subsequence between two string keys.

"},{"t":"M","n":"Redis::getReadTimeout","p":"Redis.html#method_getReadTimeout","d":"

Get the currently set read timeout on the connection.

"},{"t":"M","n":"Redis::getset","p":"Redis.html#method_getset","d":"

Sets a key and returns any previously set value, if the key already existed.

"},{"t":"M","n":"Redis::getTimeout","p":"Redis.html#method_getTimeout","d":"

Retrieve any set connection timeout

"},{"t":"M","n":"Redis::getTransferredBytes","p":"Redis.html#method_getTransferredBytes","d":null},{"t":"M","n":"Redis::hDel","p":"Redis.html#method_hDel","d":"

Remove one or more fields from a hash.

"},{"t":"M","n":"Redis::hExists","p":"Redis.html#method_hExists","d":"

Checks whether a field exists in a hash.

"},{"t":"M","n":"Redis::hGet","p":"Redis.html#method_hGet","d":null},{"t":"M","n":"Redis::hGetAll","p":"Redis.html#method_hGetAll","d":"

Read every field and value from a hash.

"},{"t":"M","n":"Redis::hIncrBy","p":"Redis.html#method_hIncrBy","d":"

Increment a hash field's value by an integer

"},{"t":"M","n":"Redis::hIncrByFloat","p":"Redis.html#method_hIncrByFloat","d":"

Increment a hash field by a floating point value

"},{"t":"M","n":"Redis::hKeys","p":"Redis.html#method_hKeys","d":"

Retrieve all of the fields of a hash.

"},{"t":"M","n":"Redis::hLen","p":"Redis.html#method_hLen","d":"

Get the number of fields in a hash.

"},{"t":"M","n":"Redis::hMget","p":"Redis.html#method_hMget","d":"

Get one or more fields from a hash.

"},{"t":"M","n":"Redis::hMset","p":"Redis.html#method_hMset","d":"

Add or update one or more hash fields and values

"},{"t":"M","n":"Redis::hRandField","p":"Redis.html#method_hRandField","d":"

Get one or more random field from a hash.

"},{"t":"M","n":"Redis::hSet","p":"Redis.html#method_hSet","d":null},{"t":"M","n":"Redis::hSetNx","p":"Redis.html#method_hSetNx","d":"

Set a hash field and value, but only if that field does not exist

"},{"t":"M","n":"Redis::hStrLen","p":"Redis.html#method_hStrLen","d":"

Get the string length of a hash field

"},{"t":"M","n":"Redis::hVals","p":"Redis.html#method_hVals","d":"

Get all of the values from a hash.

"},{"t":"M","n":"Redis::hscan","p":"Redis.html#method_hscan","d":"

Iterate over the fields and values of a hash in an incremental fashion.

"},{"t":"M","n":"Redis::incr","p":"Redis.html#method_incr","d":"

Increment a key's value, optionally by a specifc amount.

"},{"t":"M","n":"Redis::incrBy","p":"Redis.html#method_incrBy","d":"

Increment a key by a specific integer value

"},{"t":"M","n":"Redis::incrByFloat","p":"Redis.html#method_incrByFloat","d":"

Increment a numeric key by a floating point value.

"},{"t":"M","n":"Redis::info","p":"Redis.html#method_info","d":"

Retrieve information about the connected redis-server. If no arguments are passed to\nthis function, redis will return every info field. Alternatively you may pass a specific\nsection you want returned (e.g. 'server', or 'memory') to receive only information pertaining\nto that section.

"},{"t":"M","n":"Redis::isConnected","p":"Redis.html#method_isConnected","d":"

Check if we are currently connected to a Redis instance.

"},{"t":"M","n":"Redis::keys","p":"Redis.html#method_keys","d":""},{"t":"M","n":"Redis::lInsert","p":"Redis.html#method_lInsert","d":""},{"t":"M","n":"Redis::lLen","p":"Redis.html#method_lLen","d":null},{"t":"M","n":"Redis::lMove","p":"Redis.html#method_lMove","d":null},{"t":"M","n":"Redis::lPop","p":"Redis.html#method_lPop","d":null},{"t":"M","n":"Redis::lPos","p":"Redis.html#method_lPos","d":null},{"t":"M","n":"Redis::lPush","p":"Redis.html#method_lPush","d":""},{"t":"M","n":"Redis::rPush","p":"Redis.html#method_rPush","d":""},{"t":"M","n":"Redis::lPushx","p":"Redis.html#method_lPushx","d":""},{"t":"M","n":"Redis::rPushx","p":"Redis.html#method_rPushx","d":""},{"t":"M","n":"Redis::lSet","p":"Redis.html#method_lSet","d":null},{"t":"M","n":"Redis::lastSave","p":"Redis.html#method_lastSave","d":null},{"t":"M","n":"Redis::lindex","p":"Redis.html#method_lindex","d":null},{"t":"M","n":"Redis::lrange","p":"Redis.html#method_lrange","d":null},{"t":"M","n":"Redis::lrem","p":"Redis.html#method_lrem","d":""},{"t":"M","n":"Redis::ltrim","p":"Redis.html#method_ltrim","d":null},{"t":"M","n":"Redis::mget","p":"Redis.html#method_mget","d":""},{"t":"M","n":"Redis::migrate","p":"Redis.html#method_migrate","d":null},{"t":"M","n":"Redis::move","p":"Redis.html#method_move","d":null},{"t":"M","n":"Redis::mset","p":"Redis.html#method_mset","d":null},{"t":"M","n":"Redis::msetnx","p":"Redis.html#method_msetnx","d":null},{"t":"M","n":"Redis::multi","p":"Redis.html#method_multi","d":null},{"t":"M","n":"Redis::object","p":"Redis.html#method_object","d":null},{"t":"M","n":"Redis::open","p":"Redis.html#method_open","d":""},{"t":"M","n":"Redis::pconnect","p":"Redis.html#method_pconnect","d":null},{"t":"M","n":"Redis::persist","p":"Redis.html#method_persist","d":null},{"t":"M","n":"Redis::pexpire","p":"Redis.html#method_pexpire","d":"

Sets an expiration in milliseconds on a given key. If connected to Redis >= 7.0.0\nyou can pass an optional mode argument that modifies how the command will execute.

"},{"t":"M","n":"Redis::pexpireAt","p":"Redis.html#method_pexpireAt","d":"

Set a key's expiration to a specific Unix Timestamp in milliseconds. If connected to\nRedis >= 7.0.0 you can pass an optional 'mode' argument.

"},{"t":"M","n":"Redis::pfadd","p":"Redis.html#method_pfadd","d":"

Add one or more elements to a Redis HyperLogLog key

"},{"t":"M","n":"Redis::pfcount","p":"Redis.html#method_pfcount","d":"

Retrieve the cardinality of a Redis HyperLogLog key.

"},{"t":"M","n":"Redis::pfmerge","p":"Redis.html#method_pfmerge","d":"

Merge one or more source HyperLogLog sets into a destination set.

"},{"t":"M","n":"Redis::ping","p":"Redis.html#method_ping","d":"

PING the redis server with an optional string argument.

"},{"t":"M","n":"Redis::pipeline","p":"Redis.html#method_pipeline","d":"

Enter into pipeline mode.

"},{"t":"M","n":"Redis::popen","p":"Redis.html#method_popen","d":""},{"t":"M","n":"Redis::psetex","p":"Redis.html#method_psetex","d":""},{"t":"M","n":"Redis::psubscribe","p":"Redis.html#method_psubscribe","d":"

Subscribe to one or more glob-style patterns

"},{"t":"M","n":"Redis::pttl","p":"Redis.html#method_pttl","d":"

Get a keys time to live in milliseconds.

"},{"t":"M","n":"Redis::publish","p":"Redis.html#method_publish","d":"

Publish a message to a pubsub channel

"},{"t":"M","n":"Redis::pubsub","p":"Redis.html#method_pubsub","d":null},{"t":"M","n":"Redis::punsubscribe","p":"Redis.html#method_punsubscribe","d":"

Unsubscribe from one or more channels by pattern

"},{"t":"M","n":"Redis::rPop","p":"Redis.html#method_rPop","d":"

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

"},{"t":"M","n":"Redis::randomKey","p":"Redis.html#method_randomKey","d":"

Return a random key from the current database

"},{"t":"M","n":"Redis::rawcommand","p":"Redis.html#method_rawcommand","d":"

Execute any arbitrary Redis command by name.

"},{"t":"M","n":"Redis::rename","p":"Redis.html#method_rename","d":"

Unconditionally rename a key from $old_name to $new_name

"},{"t":"M","n":"Redis::renameNx","p":"Redis.html#method_renameNx","d":"

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

"},{"t":"M","n":"Redis::reset","p":"Redis.html#method_reset","d":"

Reset the state of the connection.

"},{"t":"M","n":"Redis::restore","p":"Redis.html#method_restore","d":"

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

"},{"t":"M","n":"Redis::role","p":"Redis.html#method_role","d":"

Query whether the connected instance is a primary or replica

"},{"t":"M","n":"Redis::rpoplpush","p":"Redis.html#method_rpoplpush","d":"

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

"},{"t":"M","n":"Redis::sAdd","p":"Redis.html#method_sAdd","d":"

Add one or more values to a Redis SET key.

"},{"t":"M","n":"Redis::sAddArray","p":"Redis.html#method_sAddArray","d":"

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

"},{"t":"M","n":"Redis::sDiff","p":"Redis.html#method_sDiff","d":"

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

"},{"t":"M","n":"Redis::sDiffStore","p":"Redis.html#method_sDiffStore","d":"

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

"},{"t":"M","n":"Redis::sInter","p":"Redis.html#method_sInter","d":"

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

"},{"t":"M","n":"Redis::sintercard","p":"Redis.html#method_sintercard","d":"

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

"},{"t":"M","n":"Redis::sInterStore","p":"Redis.html#method_sInterStore","d":"

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

"},{"t":"M","n":"Redis::sMembers","p":"Redis.html#method_sMembers","d":"

Retrieve every member from a set key.

"},{"t":"M","n":"Redis::sMisMember","p":"Redis.html#method_sMisMember","d":"

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

"},{"t":"M","n":"Redis::sMove","p":"Redis.html#method_sMove","d":"

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

"},{"t":"M","n":"Redis::sPop","p":"Redis.html#method_sPop","d":"

Remove one or more elements from a set.

"},{"t":"M","n":"Redis::sRandMember","p":"Redis.html#method_sRandMember","d":"

Retrieve one or more random members of a set.

"},{"t":"M","n":"Redis::sUnion","p":"Redis.html#method_sUnion","d":"

Returns the union of one or more Redis SET keys.

"},{"t":"M","n":"Redis::sUnionStore","p":"Redis.html#method_sUnionStore","d":"

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

"},{"t":"M","n":"Redis::save","p":"Redis.html#method_save","d":"

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

"},{"t":"M","n":"Redis::scan","p":"Redis.html#method_scan","d":"

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

"},{"t":"M","n":"Redis::scard","p":"Redis.html#method_scard","d":"

Retrieve the number of members in a Redis set.

"},{"t":"M","n":"Redis::script","p":"Redis.html#method_script","d":"

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

"},{"t":"M","n":"Redis::select","p":"Redis.html#method_select","d":"

Select a specific Redis database.

"},{"t":"M","n":"Redis::set","p":"Redis.html#method_set","d":"

Create or set a Redis STRING key to a value.

"},{"t":"M","n":"Redis::setBit","p":"Redis.html#method_setBit","d":"

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

"},{"t":"M","n":"Redis::setRange","p":"Redis.html#method_setRange","d":"

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

"},{"t":"M","n":"Redis::setOption","p":"Redis.html#method_setOption","d":"

Set a configurable option on the Redis object.

"},{"t":"M","n":"Redis::setex","p":"Redis.html#method_setex","d":"

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

"},{"t":"M","n":"Redis::setnx","p":"Redis.html#method_setnx","d":"

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

"},{"t":"M","n":"Redis::sismember","p":"Redis.html#method_sismember","d":"

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

"},{"t":"M","n":"Redis::slaveof","p":"Redis.html#method_slaveof","d":"

Turn a redis instance into a replica of another or promote a replica\nto a primary.

"},{"t":"M","n":"Redis::replicaof","p":"Redis.html#method_replicaof","d":"

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

"},{"t":"M","n":"Redis::touch","p":"Redis.html#method_touch","d":"

Update one or more keys last modified metadata.

"},{"t":"M","n":"Redis::slowlog","p":"Redis.html#method_slowlog","d":"

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

"},{"t":"M","n":"Redis::sort","p":"Redis.html#method_sort","d":"

Sort the contents of a Redis key in various ways.

"},{"t":"M","n":"Redis::sort_ro","p":"Redis.html#method_sort_ro","d":"

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

"},{"t":"M","n":"Redis::sortAsc","p":"Redis.html#method_sortAsc","d":""},{"t":"M","n":"Redis::sortAscAlpha","p":"Redis.html#method_sortAscAlpha","d":""},{"t":"M","n":"Redis::sortDesc","p":"Redis.html#method_sortDesc","d":""},{"t":"M","n":"Redis::sortDescAlpha","p":"Redis.html#method_sortDescAlpha","d":""},{"t":"M","n":"Redis::srem","p":"Redis.html#method_srem","d":"

Remove one or more values from a Redis SET key.

"},{"t":"M","n":"Redis::sscan","p":"Redis.html#method_sscan","d":"

Scan the members of a redis SET key.

"},{"t":"M","n":"Redis::strlen","p":"Redis.html#method_strlen","d":"

Retrieve the length of a Redis STRING key.

"},{"t":"M","n":"Redis::subscribe","p":"Redis.html#method_subscribe","d":"

Subscribe to one or more Redis pubsub channels.

"},{"t":"M","n":"Redis::swapdb","p":"Redis.html#method_swapdb","d":"

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

"},{"t":"M","n":"Redis::time","p":"Redis.html#method_time","d":"

Retrieve the server time from the connected Redis instance.

"},{"t":"M","n":"Redis::ttl","p":"Redis.html#method_ttl","d":"

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

"},{"t":"M","n":"Redis::type","p":"Redis.html#method_type","d":"

Get the type of a given Redis key.

"},{"t":"M","n":"Redis::unlink","p":"Redis.html#method_unlink","d":"

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

"},{"t":"M","n":"Redis::unsubscribe","p":"Redis.html#method_unsubscribe","d":"

Unsubscribe from one or more subscribed channels.

"},{"t":"M","n":"Redis::unwatch","p":"Redis.html#method_unwatch","d":"

Remove any previously WATCH'ed keys in a transaction.

"},{"t":"M","n":"Redis::watch","p":"Redis.html#method_watch","d":""},{"t":"M","n":"Redis::wait","p":"Redis.html#method_wait","d":"

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

"},{"t":"M","n":"Redis::xack","p":"Redis.html#method_xack","d":null},{"t":"M","n":"Redis::xadd","p":"Redis.html#method_xadd","d":"

Append a message to a stream.

"},{"t":"M","n":"Redis::xautoclaim","p":"Redis.html#method_xautoclaim","d":null},{"t":"M","n":"Redis::xclaim","p":"Redis.html#method_xclaim","d":null},{"t":"M","n":"Redis::xdel","p":"Redis.html#method_xdel","d":"

Remove one or more specific IDs from a stream.

"},{"t":"M","n":"Redis::xgroup","p":"Redis.html#method_xgroup","d":"XGROUP"},{"t":"M","n":"Redis::xinfo","p":"Redis.html#method_xinfo","d":"

Retrieve information about a stream key.

"},{"t":"M","n":"Redis::xlen","p":"Redis.html#method_xlen","d":"

Get the number of messages in a Redis STREAM key.

"},{"t":"M","n":"Redis::xpending","p":"Redis.html#method_xpending","d":"

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

"},{"t":"M","n":"Redis::xrange","p":"Redis.html#method_xrange","d":"

Get a range of entries from a STREAM key.

"},{"t":"M","n":"Redis::xread","p":"Redis.html#method_xread","d":"

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

"},{"t":"M","n":"Redis::xreadgroup","p":"Redis.html#method_xreadgroup","d":"

Read one or more messages using a consumer group.

"},{"t":"M","n":"Redis::xrevrange","p":"Redis.html#method_xrevrange","d":"

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

"},{"t":"M","n":"Redis::xtrim","p":"Redis.html#method_xtrim","d":"

Truncate a STREAM key in various ways.

"},{"t":"M","n":"Redis::zAdd","p":"Redis.html#method_zAdd","d":"

Add one or more elements and scores to a Redis sorted set.

"},{"t":"M","n":"Redis::zCard","p":"Redis.html#method_zCard","d":"

Return the number of elements in a sorted set.

"},{"t":"M","n":"Redis::zCount","p":"Redis.html#method_zCount","d":"

Count the number of members in a sorted set with scores inside a provided range.

"},{"t":"M","n":"Redis::zIncrBy","p":"Redis.html#method_zIncrBy","d":"

Create or increment the score of a member in a Redis sorted set

"},{"t":"M","n":"Redis::zLexCount","p":"Redis.html#method_zLexCount","d":"

Count the number of elements in a sorted set whos members fall within the provided\nlexographical range.

"},{"t":"M","n":"Redis::zMscore","p":"Redis.html#method_zMscore","d":"

Retrieve the score of one or more members in a sorted set.

"},{"t":"M","n":"Redis::zPopMax","p":"Redis.html#method_zPopMax","d":"

Pop one or more of the highest scoring elements from a sorted set.

"},{"t":"M","n":"Redis::zPopMin","p":"Redis.html#method_zPopMin","d":"

Pop one or more of the lowest scoring elements from a sorted set.

"},{"t":"M","n":"Redis::zRange","p":"Redis.html#method_zRange","d":"

Retrieve a range of elements of a sorted set between a start and end point.

"},{"t":"M","n":"Redis::zRangeByLex","p":"Redis.html#method_zRangeByLex","d":"

Retrieve a range of elements from a sorted set by legographical range.

"},{"t":"M","n":"Redis::zRangeByScore","p":"Redis.html#method_zRangeByScore","d":"

Retrieve a range of members from a sorted set by their score.

"},{"t":"M","n":"Redis::zrangestore","p":"Redis.html#method_zrangestore","d":"

This command is similar to ZRANGE except that instead of returning the values directly\nit will store them in a destination key provided by the user

"},{"t":"M","n":"Redis::zRandMember","p":"Redis.html#method_zRandMember","d":"

Retrieve one or more random members from a Redis sorted set.

"},{"t":"M","n":"Redis::zRank","p":"Redis.html#method_zRank","d":"

Get the rank of a member of a sorted set, by score.

"},{"t":"M","n":"Redis::zRem","p":"Redis.html#method_zRem","d":"

Remove one or more members from a Redis sorted set.

"},{"t":"M","n":"Redis::zRemRangeByLex","p":"Redis.html#method_zRemRangeByLex","d":"

Remove zero or more elements from a Redis sorted set by legographical range.

"},{"t":"M","n":"Redis::zRemRangeByRank","p":"Redis.html#method_zRemRangeByRank","d":"

Remove one or more members of a sorted set by their rank.

"},{"t":"M","n":"Redis::zRemRangeByScore","p":"Redis.html#method_zRemRangeByScore","d":"

Remove one or more members of a sorted set by their score.

"},{"t":"M","n":"Redis::zRevRange","p":"Redis.html#method_zRevRange","d":"

List the members of a Redis sorted set in reverse order

"},{"t":"M","n":"Redis::zRevRangeByLex","p":"Redis.html#method_zRevRangeByLex","d":"

List members of a Redis sorted set within a legographical range, in reverse order.

"},{"t":"M","n":"Redis::zRevRangeByScore","p":"Redis.html#method_zRevRangeByScore","d":"

List elements from a Redis sorted set by score, highest to lowest

"},{"t":"M","n":"Redis::zRevRank","p":"Redis.html#method_zRevRank","d":"

Retrieve a member of a sorted set by reverse rank.

"},{"t":"M","n":"Redis::zScore","p":"Redis.html#method_zScore","d":"

Get the score of a member of a sorted set.

"},{"t":"M","n":"Redis::zdiff","p":"Redis.html#method_zdiff","d":"

Given one or more sorted set key names, return every element that is in the first\nset but not any of the others.

"},{"t":"M","n":"Redis::zdiffstore","p":"Redis.html#method_zdiffstore","d":"

Store the difference of one or more sorted sets in a destination sorted set.

"},{"t":"M","n":"Redis::zinter","p":"Redis.html#method_zinter","d":"

Compute the intersection of one or more sorted sets and return the members

"},{"t":"M","n":"Redis::zintercard","p":"Redis.html#method_zintercard","d":"

Similar to ZINTER but instead of returning the intersected values, this command returns the\ncardinality of the intersected set.

"},{"t":"M","n":"Redis::zinterstore","p":"Redis.html#method_zinterstore","d":"

Compute the intersection of one ore more sorted sets storing the result in a new sorted set.

"},{"t":"M","n":"Redis::zscan","p":"Redis.html#method_zscan","d":"

Scan the members of a sorted set incrementally, using a cursor

"},{"t":"M","n":"Redis::zunion","p":"Redis.html#method_zunion","d":"

Retrieve the union of one or more sorted sets

"},{"t":"M","n":"Redis::zunionstore","p":"Redis.html#method_zunionstore","d":"

Perform a union on one or more Redis sets and store the result in a destination sorted set.

"},{"t":"M","n":"RedisArray::__call","p":"RedisArray.html#method___call","d":null},{"t":"M","n":"RedisArray::__construct","p":"RedisArray.html#method___construct","d":null},{"t":"M","n":"RedisArray::_continuum","p":"RedisArray.html#method__continuum","d":null},{"t":"M","n":"RedisArray::_distributor","p":"RedisArray.html#method__distributor","d":null},{"t":"M","n":"RedisArray::_function","p":"RedisArray.html#method__function","d":null},{"t":"M","n":"RedisArray::_hosts","p":"RedisArray.html#method__hosts","d":null},{"t":"M","n":"RedisArray::_instance","p":"RedisArray.html#method__instance","d":null},{"t":"M","n":"RedisArray::_rehash","p":"RedisArray.html#method__rehash","d":null},{"t":"M","n":"RedisArray::_target","p":"RedisArray.html#method__target","d":null},{"t":"M","n":"RedisArray::bgsave","p":"RedisArray.html#method_bgsave","d":null},{"t":"M","n":"RedisArray::del","p":"RedisArray.html#method_del","d":null},{"t":"M","n":"RedisArray::discard","p":"RedisArray.html#method_discard","d":null},{"t":"M","n":"RedisArray::exec","p":"RedisArray.html#method_exec","d":null},{"t":"M","n":"RedisArray::flushall","p":"RedisArray.html#method_flushall","d":null},{"t":"M","n":"RedisArray::flushdb","p":"RedisArray.html#method_flushdb","d":null},{"t":"M","n":"RedisArray::getOption","p":"RedisArray.html#method_getOption","d":null},{"t":"M","n":"RedisArray::hscan","p":"RedisArray.html#method_hscan","d":null},{"t":"M","n":"RedisArray::info","p":"RedisArray.html#method_info","d":null},{"t":"M","n":"RedisArray::keys","p":"RedisArray.html#method_keys","d":null},{"t":"M","n":"RedisArray::mget","p":"RedisArray.html#method_mget","d":null},{"t":"M","n":"RedisArray::mset","p":"RedisArray.html#method_mset","d":null},{"t":"M","n":"RedisArray::multi","p":"RedisArray.html#method_multi","d":null},{"t":"M","n":"RedisArray::ping","p":"RedisArray.html#method_ping","d":null},{"t":"M","n":"RedisArray::save","p":"RedisArray.html#method_save","d":null},{"t":"M","n":"RedisArray::scan","p":"RedisArray.html#method_scan","d":null},{"t":"M","n":"RedisArray::select","p":"RedisArray.html#method_select","d":null},{"t":"M","n":"RedisArray::setOption","p":"RedisArray.html#method_setOption","d":null},{"t":"M","n":"RedisArray::sscan","p":"RedisArray.html#method_sscan","d":null},{"t":"M","n":"RedisArray::unlink","p":"RedisArray.html#method_unlink","d":null},{"t":"M","n":"RedisArray::unwatch","p":"RedisArray.html#method_unwatch","d":null},{"t":"M","n":"RedisArray::zscan","p":"RedisArray.html#method_zscan","d":null},{"t":"M","n":"RedisCluster::__construct","p":"RedisCluster.html#method___construct","d":null},{"t":"M","n":"RedisCluster::_compress","p":"RedisCluster.html#method__compress","d":""},{"t":"M","n":"RedisCluster::_uncompress","p":"RedisCluster.html#method__uncompress","d":""},{"t":"M","n":"RedisCluster::_serialize","p":"RedisCluster.html#method__serialize","d":""},{"t":"M","n":"RedisCluster::_unserialize","p":"RedisCluster.html#method__unserialize","d":""},{"t":"M","n":"RedisCluster::_pack","p":"RedisCluster.html#method__pack","d":""},{"t":"M","n":"RedisCluster::_unpack","p":"RedisCluster.html#method__unpack","d":""},{"t":"M","n":"RedisCluster::_prefix","p":"RedisCluster.html#method__prefix","d":""},{"t":"M","n":"RedisCluster::_masters","p":"RedisCluster.html#method__masters","d":null},{"t":"M","n":"RedisCluster::_redir","p":"RedisCluster.html#method__redir","d":null},{"t":"M","n":"RedisCluster::acl","p":"RedisCluster.html#method_acl","d":""},{"t":"M","n":"RedisCluster::append","p":"RedisCluster.html#method_append","d":""},{"t":"M","n":"RedisCluster::bgrewriteaof","p":"RedisCluster.html#method_bgrewriteaof","d":""},{"t":"M","n":"RedisCluster::bgsave","p":"RedisCluster.html#method_bgsave","d":""},{"t":"M","n":"RedisCluster::bitcount","p":"RedisCluster.html#method_bitcount","d":""},{"t":"M","n":"RedisCluster::bitop","p":"RedisCluster.html#method_bitop","d":""},{"t":"M","n":"RedisCluster::bitpos","p":"RedisCluster.html#method_bitpos","d":"

Return the position of the first bit set to 0 or 1 in a string.

"},{"t":"M","n":"RedisCluster::blpop","p":"RedisCluster.html#method_blpop","d":"

See Redis::blpop()

"},{"t":"M","n":"RedisCluster::brpop","p":"RedisCluster.html#method_brpop","d":"

See Redis::brpop()

"},{"t":"M","n":"RedisCluster::brpoplpush","p":"RedisCluster.html#method_brpoplpush","d":"

See Redis::brpoplpush()

"},{"t":"M","n":"RedisCluster::bzpopmax","p":"RedisCluster.html#method_bzpopmax","d":""},{"t":"M","n":"RedisCluster::bzpopmin","p":"RedisCluster.html#method_bzpopmin","d":""},{"t":"M","n":"RedisCluster::bzmpop","p":"RedisCluster.html#method_bzmpop","d":""},{"t":"M","n":"RedisCluster::zmpop","p":"RedisCluster.html#method_zmpop","d":""},{"t":"M","n":"RedisCluster::blmpop","p":"RedisCluster.html#method_blmpop","d":""},{"t":"M","n":"RedisCluster::lmpop","p":"RedisCluster.html#method_lmpop","d":""},{"t":"M","n":"RedisCluster::clearlasterror","p":"RedisCluster.html#method_clearlasterror","d":""},{"t":"M","n":"RedisCluster::client","p":"RedisCluster.html#method_client","d":""},{"t":"M","n":"RedisCluster::close","p":"RedisCluster.html#method_close","d":""},{"t":"M","n":"RedisCluster::cluster","p":"RedisCluster.html#method_cluster","d":""},{"t":"M","n":"RedisCluster::command","p":"RedisCluster.html#method_command","d":""},{"t":"M","n":"RedisCluster::config","p":"RedisCluster.html#method_config","d":""},{"t":"M","n":"RedisCluster::dbsize","p":"RedisCluster.html#method_dbsize","d":""},{"t":"M","n":"RedisCluster::decr","p":"RedisCluster.html#method_decr","d":""},{"t":"M","n":"RedisCluster::decrby","p":"RedisCluster.html#method_decrby","d":""},{"t":"M","n":"RedisCluster::decrbyfloat","p":"RedisCluster.html#method_decrbyfloat","d":""},{"t":"M","n":"RedisCluster::del","p":"RedisCluster.html#method_del","d":""},{"t":"M","n":"RedisCluster::discard","p":"RedisCluster.html#method_discard","d":""},{"t":"M","n":"RedisCluster::dump","p":"RedisCluster.html#method_dump","d":""},{"t":"M","n":"RedisCluster::echo","p":"RedisCluster.html#method_echo","d":""},{"t":"M","n":"RedisCluster::eval","p":"RedisCluster.html#method_eval","d":""},{"t":"M","n":"RedisCluster::eval_ro","p":"RedisCluster.html#method_eval_ro","d":""},{"t":"M","n":"RedisCluster::evalsha","p":"RedisCluster.html#method_evalsha","d":""},{"t":"M","n":"RedisCluster::evalsha_ro","p":"RedisCluster.html#method_evalsha_ro","d":""},{"t":"M","n":"RedisCluster::exec","p":"RedisCluster.html#method_exec","d":""},{"t":"M","n":"RedisCluster::exists","p":"RedisCluster.html#method_exists","d":""},{"t":"M","n":"RedisCluster::touch","p":"RedisCluster.html#method_touch","d":""},{"t":"M","n":"RedisCluster::expire","p":"RedisCluster.html#method_expire","d":""},{"t":"M","n":"RedisCluster::expireat","p":"RedisCluster.html#method_expireat","d":""},{"t":"M","n":"RedisCluster::expiretime","p":"RedisCluster.html#method_expiretime","d":""},{"t":"M","n":"RedisCluster::pexpiretime","p":"RedisCluster.html#method_pexpiretime","d":""},{"t":"M","n":"RedisCluster::flushall","p":"RedisCluster.html#method_flushall","d":""},{"t":"M","n":"RedisCluster::flushdb","p":"RedisCluster.html#method_flushdb","d":""},{"t":"M","n":"RedisCluster::geoadd","p":"RedisCluster.html#method_geoadd","d":""},{"t":"M","n":"RedisCluster::geodist","p":"RedisCluster.html#method_geodist","d":""},{"t":"M","n":"RedisCluster::geohash","p":"RedisCluster.html#method_geohash","d":""},{"t":"M","n":"RedisCluster::geopos","p":"RedisCluster.html#method_geopos","d":""},{"t":"M","n":"RedisCluster::georadius","p":"RedisCluster.html#method_georadius","d":""},{"t":"M","n":"RedisCluster::georadius_ro","p":"RedisCluster.html#method_georadius_ro","d":""},{"t":"M","n":"RedisCluster::georadiusbymember","p":"RedisCluster.html#method_georadiusbymember","d":""},{"t":"M","n":"RedisCluster::georadiusbymember_ro","p":"RedisCluster.html#method_georadiusbymember_ro","d":""},{"t":"M","n":"RedisCluster::get","p":"RedisCluster.html#method_get","d":""},{"t":"M","n":"RedisCluster::getbit","p":"RedisCluster.html#method_getbit","d":""},{"t":"M","n":"RedisCluster::getlasterror","p":"RedisCluster.html#method_getlasterror","d":""},{"t":"M","n":"RedisCluster::getmode","p":"RedisCluster.html#method_getmode","d":""},{"t":"M","n":"RedisCluster::getoption","p":"RedisCluster.html#method_getoption","d":""},{"t":"M","n":"RedisCluster::getrange","p":"RedisCluster.html#method_getrange","d":""},{"t":"M","n":"RedisCluster::lcs","p":"RedisCluster.html#method_lcs","d":""},{"t":"M","n":"RedisCluster::getset","p":"RedisCluster.html#method_getset","d":""},{"t":"M","n":"RedisCluster::gettransferredbytes","p":"RedisCluster.html#method_gettransferredbytes","d":""},{"t":"M","n":"RedisCluster::hdel","p":"RedisCluster.html#method_hdel","d":""},{"t":"M","n":"RedisCluster::hexists","p":"RedisCluster.html#method_hexists","d":""},{"t":"M","n":"RedisCluster::hget","p":"RedisCluster.html#method_hget","d":""},{"t":"M","n":"RedisCluster::hgetall","p":"RedisCluster.html#method_hgetall","d":""},{"t":"M","n":"RedisCluster::hincrby","p":"RedisCluster.html#method_hincrby","d":""},{"t":"M","n":"RedisCluster::hincrbyfloat","p":"RedisCluster.html#method_hincrbyfloat","d":""},{"t":"M","n":"RedisCluster::hkeys","p":"RedisCluster.html#method_hkeys","d":""},{"t":"M","n":"RedisCluster::hlen","p":"RedisCluster.html#method_hlen","d":""},{"t":"M","n":"RedisCluster::hmget","p":"RedisCluster.html#method_hmget","d":""},{"t":"M","n":"RedisCluster::hmset","p":"RedisCluster.html#method_hmset","d":""},{"t":"M","n":"RedisCluster::hscan","p":"RedisCluster.html#method_hscan","d":""},{"t":"M","n":"RedisCluster::hset","p":"RedisCluster.html#method_hset","d":""},{"t":"M","n":"RedisCluster::hsetnx","p":"RedisCluster.html#method_hsetnx","d":""},{"t":"M","n":"RedisCluster::hstrlen","p":"RedisCluster.html#method_hstrlen","d":""},{"t":"M","n":"RedisCluster::hvals","p":"RedisCluster.html#method_hvals","d":""},{"t":"M","n":"RedisCluster::incr","p":"RedisCluster.html#method_incr","d":""},{"t":"M","n":"RedisCluster::incrby","p":"RedisCluster.html#method_incrby","d":""},{"t":"M","n":"RedisCluster::incrbyfloat","p":"RedisCluster.html#method_incrbyfloat","d":""},{"t":"M","n":"RedisCluster::info","p":"RedisCluster.html#method_info","d":"

Retrieve information about the connected redis-server. If no arguments are passed to\nthis function, redis will return every info field. Alternatively you may pass a specific\nsection you want returned (e.g. 'server', or 'memory') to receive only information pertaining\nto that section.

"},{"t":"M","n":"RedisCluster::keys","p":"RedisCluster.html#method_keys","d":""},{"t":"M","n":"RedisCluster::lastsave","p":"RedisCluster.html#method_lastsave","d":""},{"t":"M","n":"RedisCluster::lget","p":"RedisCluster.html#method_lget","d":""},{"t":"M","n":"RedisCluster::lindex","p":"RedisCluster.html#method_lindex","d":""},{"t":"M","n":"RedisCluster::linsert","p":"RedisCluster.html#method_linsert","d":""},{"t":"M","n":"RedisCluster::llen","p":"RedisCluster.html#method_llen","d":""},{"t":"M","n":"RedisCluster::lpop","p":"RedisCluster.html#method_lpop","d":""},{"t":"M","n":"RedisCluster::lpush","p":"RedisCluster.html#method_lpush","d":""},{"t":"M","n":"RedisCluster::lpushx","p":"RedisCluster.html#method_lpushx","d":""},{"t":"M","n":"RedisCluster::lrange","p":"RedisCluster.html#method_lrange","d":""},{"t":"M","n":"RedisCluster::lrem","p":"RedisCluster.html#method_lrem","d":""},{"t":"M","n":"RedisCluster::lset","p":"RedisCluster.html#method_lset","d":""},{"t":"M","n":"RedisCluster::ltrim","p":"RedisCluster.html#method_ltrim","d":""},{"t":"M","n":"RedisCluster::mget","p":"RedisCluster.html#method_mget","d":""},{"t":"M","n":"RedisCluster::mset","p":"RedisCluster.html#method_mset","d":""},{"t":"M","n":"RedisCluster::msetnx","p":"RedisCluster.html#method_msetnx","d":""},{"t":"M","n":"RedisCluster::multi","p":"RedisCluster.html#method_multi","d":null},{"t":"M","n":"RedisCluster::object","p":"RedisCluster.html#method_object","d":""},{"t":"M","n":"RedisCluster::persist","p":"RedisCluster.html#method_persist","d":""},{"t":"M","n":"RedisCluster::pexpire","p":"RedisCluster.html#method_pexpire","d":""},{"t":"M","n":"RedisCluster::pexpireat","p":"RedisCluster.html#method_pexpireat","d":""},{"t":"M","n":"RedisCluster::pfadd","p":"RedisCluster.html#method_pfadd","d":""},{"t":"M","n":"RedisCluster::pfcount","p":"RedisCluster.html#method_pfcount","d":""},{"t":"M","n":"RedisCluster::pfmerge","p":"RedisCluster.html#method_pfmerge","d":""},{"t":"M","n":"RedisCluster::ping","p":"RedisCluster.html#method_ping","d":"

PING an instance in the redis cluster.

"},{"t":"M","n":"RedisCluster::psetex","p":"RedisCluster.html#method_psetex","d":""},{"t":"M","n":"RedisCluster::psubscribe","p":"RedisCluster.html#method_psubscribe","d":""},{"t":"M","n":"RedisCluster::pttl","p":"RedisCluster.html#method_pttl","d":""},{"t":"M","n":"RedisCluster::publish","p":"RedisCluster.html#method_publish","d":""},{"t":"M","n":"RedisCluster::pubsub","p":"RedisCluster.html#method_pubsub","d":""},{"t":"M","n":"RedisCluster::punsubscribe","p":"RedisCluster.html#method_punsubscribe","d":""},{"t":"M","n":"RedisCluster::randomkey","p":"RedisCluster.html#method_randomkey","d":""},{"t":"M","n":"RedisCluster::rawcommand","p":"RedisCluster.html#method_rawcommand","d":""},{"t":"M","n":"RedisCluster::rename","p":"RedisCluster.html#method_rename","d":""},{"t":"M","n":"RedisCluster::renamenx","p":"RedisCluster.html#method_renamenx","d":""},{"t":"M","n":"RedisCluster::restore","p":"RedisCluster.html#method_restore","d":""},{"t":"M","n":"RedisCluster::role","p":"RedisCluster.html#method_role","d":""},{"t":"M","n":"RedisCluster::rpop","p":"RedisCluster.html#method_rpop","d":""},{"t":"M","n":"RedisCluster::rpoplpush","p":"RedisCluster.html#method_rpoplpush","d":""},{"t":"M","n":"RedisCluster::rpush","p":"RedisCluster.html#method_rpush","d":""},{"t":"M","n":"RedisCluster::rpushx","p":"RedisCluster.html#method_rpushx","d":""},{"t":"M","n":"RedisCluster::sadd","p":"RedisCluster.html#method_sadd","d":""},{"t":"M","n":"RedisCluster::saddarray","p":"RedisCluster.html#method_saddarray","d":""},{"t":"M","n":"RedisCluster::save","p":"RedisCluster.html#method_save","d":""},{"t":"M","n":"RedisCluster::scan","p":"RedisCluster.html#method_scan","d":""},{"t":"M","n":"RedisCluster::scard","p":"RedisCluster.html#method_scard","d":""},{"t":"M","n":"RedisCluster::script","p":"RedisCluster.html#method_script","d":""},{"t":"M","n":"RedisCluster::sdiff","p":"RedisCluster.html#method_sdiff","d":""},{"t":"M","n":"RedisCluster::sdiffstore","p":"RedisCluster.html#method_sdiffstore","d":""},{"t":"M","n":"RedisCluster::set","p":"RedisCluster.html#method_set","d":""},{"t":"M","n":"RedisCluster::setbit","p":"RedisCluster.html#method_setbit","d":""},{"t":"M","n":"RedisCluster::setex","p":"RedisCluster.html#method_setex","d":""},{"t":"M","n":"RedisCluster::setnx","p":"RedisCluster.html#method_setnx","d":""},{"t":"M","n":"RedisCluster::setoption","p":"RedisCluster.html#method_setoption","d":""},{"t":"M","n":"RedisCluster::setrange","p":"RedisCluster.html#method_setrange","d":""},{"t":"M","n":"RedisCluster::sinter","p":"RedisCluster.html#method_sinter","d":""},{"t":"M","n":"RedisCluster::sintercard","p":"RedisCluster.html#method_sintercard","d":""},{"t":"M","n":"RedisCluster::sinterstore","p":"RedisCluster.html#method_sinterstore","d":""},{"t":"M","n":"RedisCluster::sismember","p":"RedisCluster.html#method_sismember","d":""},{"t":"M","n":"RedisCluster::slowlog","p":"RedisCluster.html#method_slowlog","d":""},{"t":"M","n":"RedisCluster::smembers","p":"RedisCluster.html#method_smembers","d":""},{"t":"M","n":"RedisCluster::smove","p":"RedisCluster.html#method_smove","d":""},{"t":"M","n":"RedisCluster::sort","p":"RedisCluster.html#method_sort","d":""},{"t":"M","n":"RedisCluster::sort_ro","p":"RedisCluster.html#method_sort_ro","d":""},{"t":"M","n":"RedisCluster::spop","p":"RedisCluster.html#method_spop","d":""},{"t":"M","n":"RedisCluster::srandmember","p":"RedisCluster.html#method_srandmember","d":""},{"t":"M","n":"RedisCluster::srem","p":"RedisCluster.html#method_srem","d":""},{"t":"M","n":"RedisCluster::sscan","p":"RedisCluster.html#method_sscan","d":""},{"t":"M","n":"RedisCluster::strlen","p":"RedisCluster.html#method_strlen","d":""},{"t":"M","n":"RedisCluster::subscribe","p":"RedisCluster.html#method_subscribe","d":""},{"t":"M","n":"RedisCluster::sunion","p":"RedisCluster.html#method_sunion","d":""},{"t":"M","n":"RedisCluster::sunionstore","p":"RedisCluster.html#method_sunionstore","d":""},{"t":"M","n":"RedisCluster::time","p":"RedisCluster.html#method_time","d":""},{"t":"M","n":"RedisCluster::ttl","p":"RedisCluster.html#method_ttl","d":""},{"t":"M","n":"RedisCluster::type","p":"RedisCluster.html#method_type","d":""},{"t":"M","n":"RedisCluster::unsubscribe","p":"RedisCluster.html#method_unsubscribe","d":""},{"t":"M","n":"RedisCluster::unlink","p":"RedisCluster.html#method_unlink","d":""},{"t":"M","n":"RedisCluster::unwatch","p":"RedisCluster.html#method_unwatch","d":""},{"t":"M","n":"RedisCluster::watch","p":"RedisCluster.html#method_watch","d":""},{"t":"M","n":"RedisCluster::xack","p":"RedisCluster.html#method_xack","d":""},{"t":"M","n":"RedisCluster::xadd","p":"RedisCluster.html#method_xadd","d":""},{"t":"M","n":"RedisCluster::xclaim","p":"RedisCluster.html#method_xclaim","d":""},{"t":"M","n":"RedisCluster::xdel","p":"RedisCluster.html#method_xdel","d":""},{"t":"M","n":"RedisCluster::xgroup","p":"RedisCluster.html#method_xgroup","d":""},{"t":"M","n":"RedisCluster::xinfo","p":"RedisCluster.html#method_xinfo","d":""},{"t":"M","n":"RedisCluster::xlen","p":"RedisCluster.html#method_xlen","d":""},{"t":"M","n":"RedisCluster::xpending","p":"RedisCluster.html#method_xpending","d":""},{"t":"M","n":"RedisCluster::xrange","p":"RedisCluster.html#method_xrange","d":""},{"t":"M","n":"RedisCluster::xread","p":"RedisCluster.html#method_xread","d":""},{"t":"M","n":"RedisCluster::xreadgroup","p":"RedisCluster.html#method_xreadgroup","d":""},{"t":"M","n":"RedisCluster::xrevrange","p":"RedisCluster.html#method_xrevrange","d":""},{"t":"M","n":"RedisCluster::xtrim","p":"RedisCluster.html#method_xtrim","d":""},{"t":"M","n":"RedisCluster::zadd","p":"RedisCluster.html#method_zadd","d":""},{"t":"M","n":"RedisCluster::zcard","p":"RedisCluster.html#method_zcard","d":""},{"t":"M","n":"RedisCluster::zcount","p":"RedisCluster.html#method_zcount","d":""},{"t":"M","n":"RedisCluster::zincrby","p":"RedisCluster.html#method_zincrby","d":""},{"t":"M","n":"RedisCluster::zinterstore","p":"RedisCluster.html#method_zinterstore","d":""},{"t":"M","n":"RedisCluster::zintercard","p":"RedisCluster.html#method_zintercard","d":""},{"t":"M","n":"RedisCluster::zlexcount","p":"RedisCluster.html#method_zlexcount","d":""},{"t":"M","n":"RedisCluster::zpopmax","p":"RedisCluster.html#method_zpopmax","d":""},{"t":"M","n":"RedisCluster::zpopmin","p":"RedisCluster.html#method_zpopmin","d":""},{"t":"M","n":"RedisCluster::zrange","p":"RedisCluster.html#method_zrange","d":""},{"t":"M","n":"RedisCluster::zrangestore","p":"RedisCluster.html#method_zrangestore","d":""},{"t":"M","n":"RedisCluster::zrangebylex","p":"RedisCluster.html#method_zrangebylex","d":""},{"t":"M","n":"RedisCluster::zrangebyscore","p":"RedisCluster.html#method_zrangebyscore","d":""},{"t":"M","n":"RedisCluster::zrank","p":"RedisCluster.html#method_zrank","d":""},{"t":"M","n":"RedisCluster::zrem","p":"RedisCluster.html#method_zrem","d":""},{"t":"M","n":"RedisCluster::zremrangebylex","p":"RedisCluster.html#method_zremrangebylex","d":""},{"t":"M","n":"RedisCluster::zremrangebyrank","p":"RedisCluster.html#method_zremrangebyrank","d":""},{"t":"M","n":"RedisCluster::zremrangebyscore","p":"RedisCluster.html#method_zremrangebyscore","d":""},{"t":"M","n":"RedisCluster::zrevrange","p":"RedisCluster.html#method_zrevrange","d":""},{"t":"M","n":"RedisCluster::zrevrangebylex","p":"RedisCluster.html#method_zrevrangebylex","d":""},{"t":"M","n":"RedisCluster::zrevrangebyscore","p":"RedisCluster.html#method_zrevrangebyscore","d":""},{"t":"M","n":"RedisCluster::zrevrank","p":"RedisCluster.html#method_zrevrank","d":""},{"t":"M","n":"RedisCluster::zscan","p":"RedisCluster.html#method_zscan","d":""},{"t":"M","n":"RedisCluster::zscore","p":"RedisCluster.html#method_zscore","d":""},{"t":"M","n":"RedisCluster::zunionstore","p":"RedisCluster.html#method_zunionstore","d":""},{"t":"M","n":"RedisSentinel::__construct","p":"RedisSentinel.html#method___construct","d":null},{"t":"M","n":"RedisSentinel::ckquorum","p":"RedisSentinel.html#method_ckquorum","d":""},{"t":"M","n":"RedisSentinel::failover","p":"RedisSentinel.html#method_failover","d":""},{"t":"M","n":"RedisSentinel::flushconfig","p":"RedisSentinel.html#method_flushconfig","d":""},{"t":"M","n":"RedisSentinel::getMasterAddrByName","p":"RedisSentinel.html#method_getMasterAddrByName","d":""},{"t":"M","n":"RedisSentinel::master","p":"RedisSentinel.html#method_master","d":""},{"t":"M","n":"RedisSentinel::masters","p":"RedisSentinel.html#method_masters","d":""},{"t":"M","n":"RedisSentinel::myid","p":"RedisSentinel.html#method_myid","d":null},{"t":"M","n":"RedisSentinel::ping","p":"RedisSentinel.html#method_ping","d":""},{"t":"M","n":"RedisSentinel::reset","p":"RedisSentinel.html#method_reset","d":""},{"t":"M","n":"RedisSentinel::sentinels","p":"RedisSentinel.html#method_sentinels","d":""},{"t":"M","n":"RedisSentinel::slaves","p":"RedisSentinel.html#method_slaves","d":""},{"t":"N","n":"","p":"[Global_Namespace].html"}]} diff --git a/docs/renderer.index b/docs/renderer.index index 6361316e..427fc853 100644 --- a/docs/renderer.index +++ b/docs/renderer.index @@ -1 +1 @@ -O:21:"Doctum\Renderer\Index":3:{i:0;a:6:{s:5:"Redis";s:40:"4f4f62f9f49eb59c17c3dda8e0c3ae397a6df977";s:10:"RedisArray";s:40:"fb17c785beccf1dbeedaa48afb4aa7d48fd8b655";s:12:"RedisCluster";s:40:"1783d14c476f95598062edb44dab7284b9b2680d";s:21:"RedisClusterException";s:40:"1783d14c476f95598062edb44dab7284b9b2680d";s:14:"RedisException";s:40:"4f4f62f9f49eb59c17c3dda8e0c3ae397a6df977";s:13:"RedisSentinel";s:40:"4055ace9f1cf20bef89bdb5d3219470b4c8915e6";}i:1;a:1:{i:0;s:7:"develop";}i:2;a:1:{i:0;s:0:"";}} \ No newline at end of file +O:21:"Doctum\Renderer\Index":3:{i:0;a:6:{s:5:"Redis";s:40:"0ca9052a6b2da623f76b015fa3271f4a9d1ffcf9";s:10:"RedisArray";s:40:"fb17c785beccf1dbeedaa48afb4aa7d48fd8b655";s:12:"RedisCluster";s:40:"1783d14c476f95598062edb44dab7284b9b2680d";s:21:"RedisClusterException";s:40:"1783d14c476f95598062edb44dab7284b9b2680d";s:14:"RedisException";s:40:"0ca9052a6b2da623f76b015fa3271f4a9d1ffcf9";s:13:"RedisSentinel";s:40:"4055ace9f1cf20bef89bdb5d3219470b4c8915e6";}i:1;a:1:{i:0;s:7:"develop";}i:2;a:1:{i:0;s:0:"";}} \ No newline at end of file diff --git a/redis.stub.php b/redis.stub.php index 15288db2..a05859d0 100644 --- a/redis.stub.php +++ b/redis.stub.php @@ -238,14 +238,6 @@ class Redis { * Pop an element off the beginning of a Redis list or lists, potentially blocking up to a specified * timeout. This method may be called in two distinct ways, of which examples are provided below. * - * - * // Variadic, with the final argument a timeout. - * $redis->blPop('list1', 'list2', 'list3', 1.5); - * - * // Alternatively, you can send an array of keys - * $relay->blPop(['list1', 'list2', 'list3'], 1.5); - * - * * @see https://redis.io/commands/blpop/ * * @param string|array $key_or_keys This can either be a string key or an array of one or more @@ -255,6 +247,10 @@ class Redis { * the command. * * @return Redis|array|null|false Can return various things depending on command and data in Redis. + * + * @example + * $redis->blPop('list1', 'list2', 'list3', 1.5); + * $relay->blPop(['list1', 'list2', 'list3'], 1.5); */ public function blPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed ...$extra_args): Redis|array|null|false; @@ -288,14 +284,6 @@ class Redis { * * Following are examples of the two main ways to call this method. * - * - * // Method 1 - Variadic, with the last argument being our timeout - * $redis->bzPopMax('key1', 'key2', 'key3', 1.5); - * - * // Method 2 - A single array of keys, followed by the timeout - * $redis->bzPopMax(['key1', 'key2', 'key3'], 1.5); - * - * * **NOTE**: We reccomend calling this function with an array and a timeout as the other strategy * may be deprecated in future versions of PhpRedis * @@ -309,6 +297,10 @@ class Redis { * which needs to be a timeout. * * @return Redis|array|false The popped elements. + * + * @example + * $redis->bzPopMax('key1', 'key2', 'key3', 1.5); + * $redis->bzPopMax(['key1', 'key2', 'key3'], 1.5); */ public function bzPopMax(string|array $key, string|int $timeout_or_key, mixed ...$extra_args): Redis|array|false; @@ -393,19 +385,16 @@ class Redis { /** * Reset any last error on the connection to NULL * - * - * $redis = new Redis(['host' => 'localhost']); + * @see Redis::getLastError() + * @return bool This should always return true or throw an exception if we're not connected. * + * @example + * $redis = new Redis(['host' => 'localhost']); * $redis->set('string', 'this_is_a_string'); * $redis->smembers('string'); - * * var_dump($redis->getLastError()); * $redis->clearLastError(); * var_dump($redis->getLastError()); - * - * - * @see Redis::getLastError() - * @return bool This should always return true or throw an exception if we're not connected. */ public function clearLastError(): bool; @@ -416,30 +405,22 @@ class Redis { public function command(string $opt = null, string|array $arg): mixed; /** - * Execute the Redis CONFIG command in a variety of ways. What the command does in particular depends - * on the `$operation` qualifier. + * Execute the Redis CONFIG command in a variety of ways. * + * What the command does in particular depends on the `$operation` qualifier. * Operations that PhpRedis supports are: RESETSTAT, REWRITE, GET, and SET. * - * - * $redis->config('GET', 'timeout'); - * $redis->config('GET', ['timeout', 'databases']); - * - * $redis->config('SET', 'timeout', 30); - * $redis->config('SET', ['timeout' => 30, 'loglevel' => 'warning']); - * - * - * @param string $operation The CONFIG subcommand to execute - * @param array|string|null $key_or_setting Can either be a setting string for the GET/SET operation or - * an array of settings or settings and values. - * Note: Redis 7.0.0 is required to send an array of settings. - * @param string $value The setting value when the operation is SET. - * - * @return mixed Can return various things depending on arguments sent. + * @param string $operation The CONFIG operation to execute (e.g. GET, SET, REWRITE). + * @param array|string|null $key_or_settings One or more keys or values. + * @param string $value The value if this is a `CONFIG SET` operation. + * @see https://redis.io/commands/config * - * @see https://redis.io/commands/config - * - * */ + * @example + * $redis->config('GET', 'timeout'); + * $redis->config('GET', ['timeout', 'databases']); + * $redis->config('SET', 'timeout', 30); + * $redis->config('SET', ['timeout' => 30, 'loglevel' => 'warning']); + */ public function config(string $operation, array|string|null $key_or_settings = NULL, ?string $value = NULL): mixed; public function connect(string $host, int $port = 6379, float $timeout = 0, string $persistent_id = null, @@ -448,36 +429,8 @@ class Redis { /** * Make a copy of a key. * - * * $redis = new Redis(['host' => 'localhost']); * - * $redis->pipeline() - * ->select(1) - * ->del('newkey') - * ->select(0) - * ->del('newkey') - * ->mset(['source1' => 'value1', 'exists' => 'old_value']) - * ->exec(); - * - * // Will succeed, as 'newkey' doesn't exist - * var_dump($redis->copy('source1', 'newkey')); - * - * // Will succeed, because 'newkey' doesn't exist in DB 1 - * var_dump($redis->copy('source1', 'newkey', ['db' => 1])); - * - * // Will fail, because 'exists' does exist - * var_dump($redis->copy('source1', 'exists')); - * - * // Will succeed, because even though 'exists' is a key, we sent the REPLACE option. - * var_dump($redis->copy('source1', 'exists', ['REPLACE' => true])); - * - * - * **Available Options** - * - * | OPTION | TYPE | DESCRIPTION | - * | --------------- | ---- | ----------- | - * | OPT_MAX_RETRIES | int | foo | - * * @param string $src The key to copy * @param string $dst The name of the new key created from the source key. * @param array $options An array with modifiers on how COPY should operate. @@ -491,27 +444,37 @@ class Redis { * @return Redis|bool True if the copy was completed and false if not. * * @see https://redis.io/commands/copy + * + * @example + * $redis->pipeline() + * ->select(1) + * ->del('newkey') + * ->select(0) + * ->del('newkey') + * ->mset(['source1' => 'value1', 'exists' => 'old_value']) + * ->exec(); + * + * var_dump($redis->copy('source1', 'newkey')); + * var_dump($redis->copy('source1', 'newkey', ['db' => 1])); + * var_dump($redis->copy('source1', 'exists')); + * var_dump($redis->copy('source1', 'exists', ['REPLACE' => true])); */ public function copy(string $src, string $dst, array $options = null): Redis|bool; /** * Return the number of keys in the currently selected Redis database. * - * - * $redis = new Redis(['host' => 'localhost']); + * @see https://redis.io/commands/dbsize * - * $redis->flushdb(); + * @return Redis|int The number of keys or false on failure. * + * @example + * $redis = new Redis(['host' => 'localhost']); + * $redis->flushdb(); * $redis->set('foo', 'bar'); * var_dump($redis->dbsize()); - * * $redis->mset(['a' => 'a', 'b' => 'b', 'c' => 'c', 'd' => 'd']); * var_dump($redis->dbsize()); - * - * - * @see https://redis.io/commands/dbsize - * - * @return Redis|int The number of keys or false on failure. */ public function dbSize(): Redis|int|false; @@ -546,44 +509,32 @@ class Redis { /** * Decrement a redis integer by a value * - * @see https://redis.io/commands/decrby - * - * @param string $key The integer key to decrement. - * @param int $value How much to decrement the key. - * - * @return Redis|int|false The new value of the key or false on failure. - * * - * 'localhost'); * * $redis->set('counter', 3); * var_dump($redis->decrby('counter', 1)); * var_dump($redis->decrby('counter', 2)); - * - * // --- OUTPUT --- - * // int(2) - * // int(0) - * ?> * + * + * @param string $key The integer key to decrement. + * @param int $value How much to decrement the key. + * + * @return Redis|int|false The new value of the key or false on failure. + * + * @see https://redis.io/commands/decrby + * */ public function decrBy(string $key, int $value): Redis|int|false; /** * Delete one or more keys from Redis. * - * @see https://redis.io/commands/del - * - * @param array|string $key_or_keys Either an array with one or more key names or a string with - * the name of a key. - * @param string $other_keys One or more additional keys passed in a variadic fashion. - * * This method can be called in two distinct ways. The first is to pass a single array * of keys to delete, and the second is to pass N arguments, all names of keys. See * below for an example of both strategies. * * - * 'localhost']); * * for ($i = 0; $i < 5; $i++) { @@ -592,12 +543,16 @@ class Redis { * * var_dump($redis->del('key:0', 'key:1')); * var_dump($redis->del(['key:2', 'key:3', 'key:4'])); - * - * // --- OUTPUT --- - * // int(2) - * // int(3) - * ?> * + * + * @param array|string $key_or_keys Either an array with one or more key names or a string with + * the name of a key. + * @param string $other_keys One or more additional keys passed in a variadic fashion. + * + * @return Redis|int|false The number of keys that were deleted + * + * @see https://redis.io/commands/del + * */ public function del(array|string $key, string ...$other_keys): Redis|int|false; @@ -610,10 +565,7 @@ class Redis { /** * Discard a transaction currently in progress. * - * @return Redis|bool True if we could discard the transaction. - * * - * 'localhost']); * * $redis->multi()->set('foo', 'bar')->get('foo'); @@ -626,24 +578,17 @@ class Redis { * * // Redis::ATOMIC * $redis->getMode(); - * - * ?> * + * + * @return Redis|bool True if we could discard the transaction. + * */ public function discard(): Redis|bool; - //public function restore(string $key, int $timeout, string $value, ?array $options = NULL): bool; /** * Dump Redis' internal binary representation of a key. * - * @see https://redis.io/commands/dump - * - * @param string $key The key to dump. - * - * @return Redis|string A binary string representing the key's value. - * * - * 'localhost']); * * $redis->del('zset'); @@ -656,38 +601,32 @@ class Redis { * // Retore it to a different name * $redis->restore('new-zset', 0, $binary); * - * // Array - * // ( - * // [zero] => 0 - * // [one] => 1 - * // [two] => 2 - * // ) * $redis->zRange('new-zset', 0, -1, true); - * ?> * + * + * @param string $key The key to dump. + * + * @return Redis|string A binary string representing the key's value. + * + * @see https://redis.io/commands/dump + * */ public function dump(string $key): Redis|string; /** * Have Redis repeat back an arbitrary string to the client. * - * @see https://redis.io/commands/echo - * - * @param string $str The string to echo - * - * @return Redis|string|false The string sent to Redis or false on failure. - * * - * 'localhost']); * * var_dump($redis->echo('Hello, World')); + * * - * // --- OUTPUT --- - * // string(12) "Hello, World" + * @param string $str The string to echo * - * ?> - * + * @return Redis|string|false The string sent to Redis or false on failure. + * + * @see https://redis.io/commands/echo */ public function echo(string $str): Redis|string|false; @@ -719,15 +658,18 @@ class Redis { * Execute a LUA script on the server but instead of sending the script, send * the SHA1 hash of the script. * - * @see https://redis.io/commands/evalsha/ - * @see Redis::eval(); - * * @param string $script_sha The SHA1 hash of the lua code. Note that the script * must already exist on the server, either having been * loaded with `SCRIPT LOAD` or having been executed directly * with `EVAL` first. * @param array $args Arguments to send to the script. * @param int $num_keys The number of arguments that are keys + * + * @return mixed Returns whatever the specific script does. + * + * @see https://redis.io/commands/evalsha/ + * @see Redis::eval(); + * */ public function evalsha(string $sha1, array $args = [], int $num_keys = 0): mixed; @@ -742,13 +684,6 @@ class Redis { /** * Execute either a MULTI or PIPELINE block and return the array of replies. * - * @see https://redis.io/commands/exec - * @see https://redis.io/commands/multi - * @see Redis::pipeline() - * @see Redis::multi() - * - * @return Redis|array|false The array of pipeline'd or multi replies or false on failure. - * * * $redis = new Redis(['host' => 'localhost']); * @@ -760,36 +695,22 @@ class Redis { * ->exec(); * * var_dump($res); - * - * // --- OUTPUT --- - * // array(4) { - * // [0]=> - * // bool(true) // set('foo', 'bar') - * // [1]=> - * // string(3) "bar" // get('foo') - * // [2]=> - * // int(1) // del('list') - * // [3]=> - * // int(3) // rpush('list', 'one', 'two', 'three') - * // } - * ?> * + * + * @return Redis|array|false The array of pipeline'd or multi replies or false on failure. + * + * @see https://redis.io/commands/exec + * @see https://redis.io/commands/multi + * @see Redis::pipeline() + * @see Redis::multi() + * */ public function exec(): Redis|array|false; /** * Test if one or more keys exist. * - * @see https://redis.io/commands/exists - * - * @param mixed $key Either an array of keys or a string key - * @param mixed $other_keys If the previous argument was a string, you may send any number of - * additional keys to test. - * - * @return Redis|int|bool The number of keys that do exist and false on failure - * * - * 'localhost']); * * $redis->multi() @@ -805,8 +726,15 @@ class Redis { * // --- OUTPUT --- * // int(3) * // int(1) - * ?> * + * + * @param mixed $key Either an array of keys or a string key + * @param mixed $other_keys If the previous argument was a string, you may send any number of + * additional keys to test. + * + * @return Redis|int|bool The number of keys that do exist and false on failure + * + * @see https://redis.io/commands/exists */ public function exists(mixed $key, mixed ...$other_keys): Redis|int|bool; @@ -815,27 +743,45 @@ class Redis { * redis-server >= 7.0.0 you may send an additional "mode" argument which * modifies how the command will execute. * - * @see https://redis.io/commands/expire - * * @param string $key The key to set an expiration on. * @param string $mode A two character modifier that changes how the * command works. + * * NX - Set expiry only if key has no expiry * XX - Set expiry only if key has an expiry * LT - Set expiry only when new expiry is < current expiry * GT - Set expiry only when new expiry is > current expiry + * + * + * @return Redis|bool True if an expiration was set and false otherwise. + * @see https://redis.io/commands/expire + * */ public function expire(string $key, int $timeout, ?string $mode = NULL): Redis|bool; - /** - * Set a key's expiration to a specific Unix timestamp in seconds. If - * connected to Redis >= 7.0.0 you can pass an optional 'mode' argument. + /* + * Set a key's expiration to a specific Unix timestamp in seconds. * + * If connected to Redis >= 7.0.0 you can pass an optional 'mode' argument. * @see Redis::expire() For a description of the mode argument. * - * @param string $key The key to set an expiration on. - * @param string $mode A two character modifier that changes how the - * command works. + * @param string $key The key to set an expiration on. + * + * @return Redis|bool True if an expiration was set, false if not. + * + */ + + /** + * Set a key to expire at an exact unix timestamp. + * + * @param string $key The key to set an expiration on. + * @param int $timestamp The unix timestamp to expire at. + * @param string $mode An option 'mode' that modifies how the command acts (see {@link Redis::expire}). + * @return Redis|bool True if an expiration was set, false if not. + * + * @see https://redis.io/commands/expireat + * @see https://redis.io/commands/expire + * @see Redis::expire() */ public function expireAt(string $key, int $timestamp, ?string $mode = NULL): Redis|bool; @@ -844,15 +790,7 @@ class Redis { /** * Get the expiration of a given key as a unix timestamp * - * @see https://redis.io/commands/expiretime - * - * @param string $key The key to check. - * - * @return Redis|int|false The timestamp when the key expires, or -1 if the key has no expiry - * and -2 if the key doesn't exist. - * * - * 'localhost']); * * $redis->set('expiry-key', 'this will last a very long time'); @@ -861,12 +799,15 @@ class Redis { * $redis->expireAt('expiry-key', 7955144542); * * var_dump($redis->expiretime('expiry-key')); + * * - * // --- OUTPUT --- - * // int(7955144542) + * @param string $key The key to check. + * + * @return Redis|int|false The timestamp when the key expires, or -1 if the key has no expiry + * and -2 if the key doesn't exist. + * + * @see https://redis.io/commands/expiretime * - * ?>php - * */ public function expiretime(string $key): Redis|int|false; @@ -887,11 +828,9 @@ class Redis { * Deletes every key in all Redis databases * * @param bool $sync Whether to perform the task in a blocking or non-blocking way. - * when TRUE, PhpRedis will execute `FLUSHALL SYNC`, and when FALSE we - * will execute `FLUSHALL ASYNC`. If the argument is omitted, we - * simply execute `FLUSHALL` and whether it is SYNC or ASYNC depends - * on Redis' `lazyfree-lazy-user-flush` config setting. * @return bool + * + * @see https://redis.io/commands/flushall */ public function flushAll(?bool $sync = null): Redis|bool; @@ -899,11 +838,9 @@ class Redis { * Deletes all the keys of the currently selected database. * * @param bool $sync Whether to perform the task in a blocking or non-blocking way. - * when TRUE, PhpRedis will execute `FLUSHDB SYNC`, and when FALSE we - * will execute `FLUSHDB ASYNC`. If the argument is omitted, we - * simply execute `FLUSHDB` and whether it is SYNC or ASYNC depends - * on Redis' `lazyfree-lazy-user-flush` config setting. * @return bool + * + * @see https://redis.io/commands/flush */ public function flushDB(?bool $sync = null): Redis|bool; @@ -942,6 +879,16 @@ class Redis { public function getEx(string $key, array $options = []): Redis|string|bool; + /** + * Get the database number PhpRedis thinks we're connected to. + * + * This value is updated internally in PhpRedis each time {@link Redis::select} is called. + * + * @return The database we're connected to. + * + * @see Redis::select() + * @see https://redis.io/commands/select + */ public function getDBNum(): int; public function getDel(string $key): Redis|string|bool; @@ -994,14 +941,7 @@ class Redis { /** * Retrieve a substring of a string by index. * - * @param string $key The string to query. - * @param int $start The zero-based starting index. - * @param int $end The zero-based ending index. - * - * @return Redis|string|false The substring or false on failure. - * * - * 'localhost']); * * $word = 'Supercalifragilisticexpialidocious'; @@ -1012,13 +952,31 @@ class Redis { * * // string(7) "docious" * var_dump($redis->getRange('silly-word', -7, -1)); - * ?> + * + * + * @param string $key The string to query. + * @param int $start The zero-based starting index. + * @param int $end The zero-based ending index. + * + * @return Redis|string|false The substring or false on failure. + * + * @see https://redis.io/commands/getrange */ public function getRange(string $key, int $start, int $end): Redis|string|false; /** * Get the longest common subsequence between two string keys. * + * + * $redis = new Redis(['host' => 'localhost']); + * + * $redis->set('seq1', 'gtaggcccgcacggtctttaatgtatccctgtttaccatgccatacctgagcgcatacgc'); + * $redis->set('seq2', 'aactcggcgcgagtaccaggccaaggtcgttccagagcaaagactcgtgccccgctgagc'); + * + * // string(37) "acccgcacggcaagtcgttccagcaactggcgctagc" + * var_dump($redis->lcs('seq1', 'seq2')); + * + * * @param string $key1 The first key to check * @param string $key2 The second key to check * @param array $options An optional array of modifiers for the comand. @@ -1040,19 +998,7 @@ class Redis { * * @return Redis|string|array|int|false Various reply types depending on options. * - * - * - * 'localhost']); - * - * $redis->set('seq1', 'gtaggcccgcacggtctttaatgtatccctgtttaccatgccatacctgagcgcatacgc'); - * $redis->set('seq2', 'aactcggcgcgagtaccaggccaaggtcgttccagagcaaagactcgtgccccgctgagc'); - * - * // string(37) "acccgcacggcaagtcgttccagcaactggcgctagc" - * var_dump($redis->lcs('seq1', 'seq2')); - * ?> + * @see https://redis.io/commands/lcs */ public function lcs(string $key1, string $key2, ?array $options = NULL): Redis|string|array|int|false; @@ -1066,13 +1012,7 @@ class Redis { /** * Sets a key and returns any previously set value, if the key already existed. * - * @param string $key The key to set. - * @param mixed $value The value to set the key to. - * - * @return Redis|string|false The old value of the key or false if it didn't exist. - * * - * 'localhost']); * * $redis->del('captain'); @@ -1082,8 +1022,14 @@ class Redis { * * // string(4) "Pike" * var_dump($redis->getset('captain', 'Kirk')); - * ?> * + * + * @param string $key The key to set. + * @param mixed $value The value to set the key to. + * + * @return Redis|string|false The old value of the key or false if it didn't exist. + * + * @see https://redis.io/commands/getset */ public function getset(string $key, mixed $value): Redis|string|false; @@ -1099,16 +1045,7 @@ class Redis { /** * Remove one or more fields from a hash. * - * @see https://redis.io/commands/hdel - * - * @param string $key The hash key in question. - * @param string $field The first field to remove - * @param string $other_fields One or more additional fields to remove. - * - * @return Redis|int|false The number of fields actually removed. - * * - * 'localhost']); * * $redis->del('people'); @@ -1117,36 +1054,39 @@ class Redis { * * // int(1) * $redis->hDel('comms', 'Mallory', 'Archibald'); - * ?> * + * + * @param string $key The hash key in question. + * @param string $field The first field to remove + * @param string $other_fields One or more additional fields to remove. + * + * @return Redis|int|false The number of fields actually removed. + * + * @see https://redis.io/commands/hdel */ public function hDel(string $key, string $field, string ...$other_fields): Redis|int|false; /** * Checks whether a field exists in a hash. * - * @see https://redis.io/commands/hexists - * - * @param string $key The hash to query. - * @param string $field The field to check - * - * @return Redis|bool True if it exists, false if not. - * * - * 'localhost']); * * $redis->del('captains'); * * $redis->hmset('captains', ['Kirk' => 'Enterprise', 'Picard' => 'Enterprise-D', 'Sisko' => 'Defiant']); * - * bool(false) * $redis->hExists('captains', 'Pike'); - * - * bool(true) * $redis->hExists('captains', 'Picard'); - * ?> * + * + * @param string $key The hash to query. + * @param string $field The field to check + * + * @return Redis|bool True if it exists, false if not. + * + * @see https://redis.io/commands/hexists + * */ public function hExists(string $key, string $field): Redis|bool; @@ -1155,14 +1095,7 @@ class Redis { /** * Read every field and value from a hash. * - * @see https://redis.io/commands/hgetall - * - * @param string $key The hash to query. - * - * @return Redis|array|false All fields and values or false if the key didn't exist. - * * - * 'localhost']); * * $redis->del('comms'); @@ -1178,24 +1111,20 @@ class Redis { * // string(7) "haxx00r" * // } * $redis->hGetAll('comms'); - * ?> * + * + * @param string $key The hash to query. + * @return Redis|array|false All fields and values or false if the key didn't exist. + * + * @see https://redis.io/commands/hgetall + * */ public function hGetAll(string $key): Redis|array|false; /** * Increment a hash field's value by an integer * - * @see https://redis.io/commands/hincrby - * - * @param string $key The hash to modify - * @param string $field The field to increment - * @param int $value How much to increment the value. - * - * @return Redis|int|false The new value of the field. - * * - * 'localhost']); * * $redis->del('player'); @@ -1207,22 +1136,22 @@ class Redis { * * // int(5) * $redis->hIncrBy('player', 'level', 3); - * ?> * * + * @param string $key The hash to modify + * @param string $field The field to increment + * @param int $value How much to increment the value. + * + * @return Redis|int|false The new value of the field. + * + * @see https://redis.io/commands/hincrby + * */ public function hIncrBy(string $key, string $field, int $value): Redis|int|false; /** * Increment a hash field by a floating point value * - * @see https://redis.io/commands/hincrbyfloat - * - * @param string $key The hash with the field to increment. - * @param string $field The field to increment. - * - * @return Redis|float|false The field value after incremented. - * * * $redis = new Redis(['host' => 'localhost']); * @@ -1233,22 +1162,22 @@ class Redis { * * // float(6.2831852) * $redis->hIncrByFloat('trig-numbers', 'tau', 2 * $pi); - * ?> * + * + * @param string $key The hash with the field to increment. + * @param string $field The field to increment. + * + * @return Redis|float|false The field value after incremented. + * + * @see https://redis.io/commands/hincrbyfloat + * */ public function hIncrByFloat(string $key, string $field, float $value): Redis|float|false; /** * Retrieve all of the fields of a hash. * - * @see https://redis.io/commands/hkeys - * - * @param string $key The hash to query. - * - * @return Redis|array|false The fields in the hash or false if the hash doesn't exist. - * * - * 'localhost']); * * $redis->del('ships'); @@ -1264,8 +1193,13 @@ class Redis { * // string(7) "Voyager" * // } * $redis->hKeys('ships'); - * ?> * + * + * @param string $key The hash to query. + * + * @return Redis|array|false The fields in the hash or false if the hash doesn't exist. + * + * @see https://redis.io/commands/hkeys */ public function hKeys(string $key): Redis|array|false; @@ -1283,15 +1217,7 @@ class Redis { /** * Get one or more fields from a hash. * - * @see https://redis.io/commands/hmget - * - * @param string $key The hash to query. - * @param array $fields One or more fields to query in the hash. - * - * @return Redis|array|false The fields and values or false if the key didn't exist. - * * - * 'localhost']); * * $redis->del('player:1'); @@ -1305,35 +1231,50 @@ class Redis { * // string(4) "1337" * // } * $redis->hmget('player:1', ['name', 'score']); - * ?> * + * + * @param string $key The hash to query. + * @param array $fields One or more fields to query in the hash. + * + * @return Redis|array|false The fields and values or false if the key didn't exist. + * + * @see https://redis.io/commands/hmget + * */ public function hMget(string $key, array $fields): Redis|array|false; /** * Add or update one or more hash fields and values * - * @see https://redis.io/commands/hmset + * + * $redis = new Redis(['host' => 'localhost']); + * + * $redis->hmset('updates', ['status' => 'starting', 'elapsed' => 0]); + * * * @param string $key The hash to create/update * @param array $fieldvals An associative array with fields and their values. * * @return Redis|bool True if the operation was successful * - * - * 'localhost']); + * @see https://redis.io/commands/hmset * - * $redis->hmset('updates', ['status' => 'starting', 'elapsed' => 0]); - * ?> - * */ public function hMset(string $key, array $fieldvals): Redis|bool; /** * Get one or more random field from a hash. * - * @see https://redis.io/commands/hrandfield + * + * $redis = new Redis(['host' => 'localhost']); + * + * $redis->del('settings'); + * + * $redis->hmset('settings', ['path' => '/', 'state' => 'active', 'jobs' => 15]); + * + * $redis->hrandfield('settings'); + * $redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]); + * * * @param string $key The hash to query. * @param array $options An array of options to modify how the command behaves. @@ -1347,19 +1288,8 @@ class Redis { * * @return Redis|array|string One or more random fields (and possibly values). * - * - * 'localhost']); - * - * $redis->del('settings'); - * - * $redis->hmset('settings', ['path' => '/', 'state' => 'active', 'jobs' => 15]); - * - * $redis->hrandfield('settings'); + * @see https://redis.io/commands/hrandfield * - * $redis->hrandfield('settings', ['count' => 2, 'withvalues' => true]); - * ?> - * */ public function hRandField(string $key, array $options = null): Redis|string|array; @@ -1368,13 +1298,6 @@ class Redis { /** * Set a hash field and value, but only if that field does not exist * - * @see https://redis.io/commands/hsetnx - * - * @param string $key The hash to update. - * @param string $field The value to set. - * - * @return Redis|bool True if the field was set and false if not. - * * * $redis = new Redis(['host' => 'localhost']); * @@ -1388,30 +1311,31 @@ class Redis { * // bool(false) * var_dump($redis->hsetnx('player:1', 'lock', 'enabled')); * + * + * @param string $key The hash to update. + * @param string $field The value to set. + * + * @return Redis|bool True if the field was set and false if not. + * + * @see https://redis.io/commands/hsetnx */ public function hSetNx(string $key, string $field, string $value): Redis|bool; /** * Get the string length of a hash field * - * @see https://redis.io/commands/hstrlen - * * @param string $key The hash to query. * @param string $field The field to query. * * @return Redis|int|false The string length of the field or false. * - * - * 'localhost']); - * * $redis->del('hash'); * $redis->hmset('hash', ['50bytes' => str_repeat('a', 50)]); - * - * // int(50) * $redis->hstrlen('hash', '50bytes'); * - * + * @see https://redis.io/commands/hstrlen */ public function hStrLen(string $key, string $field): Redis|int|false; diff --git a/redis_arginfo.h b/redis_arginfo.h index 09e3c1fe..fa86cdc3 100644 --- a/redis_arginfo.h +++ b/redis_arginfo.h @@ -1,5 +1,5 @@ /* This is a generated file, edit the .stub.php file instead. - * Stub hash: 4f4f62f9f49eb59c17c3dda8e0c3ae397a6df977 */ + * Stub hash: 0ca9052a6b2da623f76b015fa3271f4a9d1ffcf9 */ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___construct, 0, 0, 0) ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, options, IS_ARRAY, 0, "null") diff --git a/redis_legacy_arginfo.h b/redis_legacy_arginfo.h index ab2f328c..1594edf7 100644 --- a/redis_legacy_arginfo.h +++ b/redis_legacy_arginfo.h @@ -1,5 +1,5 @@ /* This is a generated file, edit the .stub.php file instead. - * Stub hash: 4f4f62f9f49eb59c17c3dda8e0c3ae397a6df977 */ + * Stub hash: 0ca9052a6b2da623f76b015fa3271f4a9d1ffcf9 */ ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Redis___construct, 0, 0, 0) ZEND_ARG_INFO(0, options) -- cgit v1.2.3