RedisCluster

class RedisCluster (View source)

Constants

OPT_SLAVE_FAILOVER

FAILOVER_NONE

FAILOVER_ERROR

FAILOVER_DISTRIBUTE

FAILOVER_DISTRIBUTE_SLAVES

Methods

__construct(string|null $name, array|null $seeds = null, int|float $timeout = 0, int|float $read_timeout = 0, bool $persistent = false, mixed $auth = null, array|null $context = null)

No description

string
_compress(string $value)

No description

string
_uncompress(string $value)

No description

bool|string
_serialize(mixed $value)

No description

mixed
_unserialize(string $value)

No description

string
_pack(mixed $value)

No description

string
_digest(mixed $value)

No description

mixed
_unpack(string $value)

No description

bool|string
_prefix(string $key)

No description

array
_masters()

No description

string|null
_redir()

No description

mixed
acl(string|array $key_or_address, string $subcmd, string ...$args)

No description

RedisCluster|bool|int
append(string $key, mixed $value)

No description

RedisCluster|bool
bgrewriteaof(string|array $key_or_address)

No description

RedisCluster|int|false
wait(string|array $key_or_address, int $numreplicas, int $timeout)

No description

RedisCluster|array|false
waitaof(string|array $key_or_address, int $numlocal, int $numreplicas, int $timeout)

No description

RedisCluster|bool
bgsave(string|array $key_or_address)

No description

RedisCluster|bool|int
bitcount(string $key, int $start = 0, int $end = -1, bool $bybit = false)

No description

RedisCluster|bool|int
bitop(string $operation, string $deskey, string $srckey, string ...$otherkeys)

No description

RedisCluster|int|false
bitpos(string $key, bool $bit, int $start = 0, int $end = -1, bool $bybit = false)

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

RedisCluster|array|null|false
blpop(string|array $key, string|float|int $timeout_or_key, mixed ...$extra_args)

See Redis::blpop()

RedisCluster|array|null|false
brpop(string|array $key, string|float|int $timeout_or_key, mixed ...$extra_args)

See Redis::brpop()

mixed
brpoplpush(string $srckey, string $deskey, int $timeout)

See Redis::brpoplpush()

RedisCluster|string|false
lmove(string $src, string $dst, string $wherefrom, string $whereto)

Move an element from one list into another.

RedisCluster|string|false
blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout)

Move an element from one list to another, blocking up to a timeout until an element is available.

array
bzpopmax(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)

No description

array
bzpopmin(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)

No description

RedisCluster|array|null|false
bzmpop(float $timeout, array $keys, string $from, int $count = 1)

No description

RedisCluster|array|null|false
zmpop(array $keys, string $from, int $count = 1)

No description

RedisCluster|array|null|false
blmpop(float $timeout, array $keys, string $from, int $count = 1)

No description

RedisCluster|array|null|false
lmpop(array $keys, string $from, int $count = 1)

No description

bool
clearlasterror()

No description

array|string|bool
client(string|array $key_or_address, string $subcommand, string|null $arg = null)

No description

bool
close()

No description

mixed
cluster(string|array $key_or_address, string $command, mixed ...$extra_args)

No description

mixed
command(mixed ...$extra_args)

No description

mixed
config(string|array $key_or_address, string $subcommand, mixed ...$extra_args)

No description

RedisCluster|int
dbsize(string|array $key_or_address)

No description

RedisCluster|bool
copy(string $src, string $dst, array|null $options = null)

No description

RedisCluster|int|false
decr(string $key, int $by = 1)

No description

RedisCluster|int|false
decrby(string $key, int $value)

No description

float
decrbyfloat(string $key, float $value)

No description

RedisCluster|int|false
del(array|string $key, string ...$other_keys)

No description

RedisCluster|int|false
delex(string $key, array|null $options = null)

Delete a key conditionally based on its value or hash digest

RedisCluster|int|false
delifeq(string $key, mixed $value)

Delete a key if it's equal to the specified value. This command is specific to Valkey >= 9.0

bool
discard()

No description

RedisCluster|string|false
dump(string $key)

No description

RedisCluster|string|false
echo(string|array $key_or_address, string $msg)

No description

mixed
eval(string $script, array $args = [], int $num_keys = 0)

No description

mixed
eval_ro(string $script, array $args = [], int $num_keys = 0)

No description

mixed
evalsha(string $script_sha, array $args = [], int $num_keys = 0)

No description

mixed
evalsha_ro(string $script_sha, array $args = [], int $num_keys = 0)

No description

array|false
exec()

No description

RedisCluster|int|bool
exists(mixed $key, mixed ...$other_keys)

No description

RedisCluster|int|bool
touch(mixed $key, mixed ...$other_keys)

No description

RedisCluster|bool
expire(string $key, int $timeout, string|null $mode = null)

No description

RedisCluster|bool
expireat(string $key, int $timestamp, string|null $mode = null)

No description

RedisCluster|int|false
expiretime(string $key)

No description

RedisCluster|int|false
pexpiretime(string $key)

No description

RedisCluster|bool
flushall(string|array $key_or_address, bool $async = false)

No description

RedisCluster|bool
flushdb(string|array $key_or_address, bool $async = false)

No description

RedisCluster|int|false
geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples_and_options)

No description

RedisCluster|float|false
geodist(string $key, string $src, string $dest, string|null $unit = null)

No description

RedisCluster|array|false
geohash(string $key, string $member, string ...$other_members)

No description

RedisCluster|array|false
geopos(string $key, string $member, string ...$other_members)

No description

mixed
georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = [])

No description

mixed
georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = [])

No description

mixed
georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = [])

No description

mixed
georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = [])

No description

RedisCluster|array
geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = [])

No description

RedisCluster|array|int|false
geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = [])

No description

mixed
get(string $key)

No description

mixed
getdel(string $key)

No description

RedisCluster|array|false
getWithMeta(string $key)

No description

RedisCluster|string|false
getex(string $key, array $options = [])

No description

RedisCluster|int|false
getbit(string $key, int $value)

No description

string|null
getlasterror()

No description

int
getmode()

No description

mixed
getoption(int $option)

No description

RedisCluster|string|false
getrange(string $key, int $start, int $end)

No description

RedisCluster|string|array|int|false
lcs(string $key1, string $key2, array|null $options = null)

No description

RedisCluster|string|bool
getset(string $key, mixed $value)

No description

array|false
gettransferredbytes()

No description

void
cleartransferredbytes()

No description

RedisCluster|int|false
hdel(string $key, string $member, string ...$other_members)

No description

RedisCluster|bool
hexists(string $key, string $member)

No description

mixed
hget(string $key, string $member)

No description

RedisCluster|array|false
hgetall(string $key)

No description

mixed
hgetWithMeta(string $key, string $member)

No description

RedisCluster|int|false
hincrby(string $key, string $member, int $value)

No description

RedisCluster|float|false
hincrbyfloat(string $key, string $member, float $value)

No description

RedisCluster|array|false
hkeys(string $key)

No description

RedisCluster|int|false
hlen(string $key)

No description

RedisCluster|array|false
hmget(string $key, array $keys)

No description

RedisCluster|array|false
hgetex(string $key, array $fields, string|array|null $expiry = null)

No description

RedisCluster|int|false
hsetex(string $key, array $fields, array|null $expiry = null)

No description

RedisCluster|array|false
hgetdel(string $key, array $fields)

No description

RedisCluster|bool
hmset(string $key, array $key_values)

No description

array|bool
hscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

RedisCluster|int|false
expiremember(string $key, string $field, int $ttl, string|null $unit = null)

No description

RedisCluster|int|false
expirememberat(string $key, string $field, int $timestamp)

No description

RedisCluster|string|array
hrandfield(string $key, array|null $options = null)

No description

RedisCluster|int|false
hset(string $key, string $member, mixed $value)

No description

RedisCluster|bool
hsetnx(string $key, string $member, mixed $value)

No description

RedisCluster|int|false
hstrlen(string $key, string $field)

No description

RedisCluster|array|false
hexpire(string $key, int $ttl, array $fields, string|null $mode = NULL)

No description

RedisCluster|array|false
hpexpire(string $key, int $ttl, array $fields, string|null $mode = NULL)

No description

RedisCluster|array|false
hexpireat(string $key, int $time, array $fields, string|null $mode = NULL)

No description

RedisCluster|array|false
hpexpireat(string $key, int $mstime, array $fields, string|null $mode = NULL)

No description

RedisCluster|array|false
httl(string $key, array $fields)

No description

RedisCluster|array|false
hpttl(string $key, array $fields)

No description

RedisCluster|array|false
hexpiretime(string $key, array $fields)

No description

RedisCluster|array|false
hpexpiretime(string $key, array $fields)

No description

RedisCluster|array|false
hpersist(string $key, array $fields)

No description

RedisCluster|array|false
hvals(string $key)

No description

RedisCluster|int|false
incr(string $key, int $by = 1)

No description

RedisCluster|int|false
incrby(string $key, int $value)

No description

RedisCluster|float|false
incrbyfloat(string $key, float $value)

No description

RedisCluster|array|false
info(string|array $key_or_address, string ...$sections)

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

RedisCluster|array|false
keys(string $pattern)

No description

RedisCluster|int|false
lastsave(string|array $key_or_address)

No description

RedisCluster|string|bool
lget(string $key, int $index)

No description

mixed
lindex(string $key, int $index)

No description

RedisCluster|int|false
linsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

RedisCluster|int|bool
llen(string $key)

No description

RedisCluster|bool|string|array
lpop(string $key, int $count = 0)

No description

RedisCluster|null|bool|int|array
lpos(string $key, mixed $value, array|null $options = null)

No description

RedisCluster|int|bool
lpush(string $key, mixed $value, mixed ...$other_values)

No description

RedisCluster|int|bool
lpushx(string $key, mixed $value)

No description

RedisCluster|array|false
lrange(string $key, int $start, int $end)

No description

RedisCluster|int|bool
lrem(string $key, mixed $value, int $count = 0)

No description

RedisCluster|bool
lset(string $key, int $index, mixed $value)

No description

RedisCluster|bool
ltrim(string $key, int $start, int $end)

No description

RedisCluster|array|false
mget(array $keys)

No description

RedisCluster|bool
mset(array $key_values)

No description

RedisCluster|array|false
msetnx(array $key_values)

No description

RedisCluster|bool
multi(int $value = Redis::MULTI)

No description

RedisCluster|int|string|false
object(string $subcommand, string $key)

No description

RedisCluster|bool
persist(string $key)

No description

RedisCluster|bool
pexpire(string $key, int $timeout, string|null $mode = null)

No description

RedisCluster|bool
pexpireat(string $key, int $timestamp, string|null $mode = null)

No description

RedisCluster|bool
pfadd(string $key, array $elements)

No description

RedisCluster|int|false
pfcount(string $key)

No description

RedisCluster|bool
pfmerge(string $key, array $keys)

No description

mixed
ping(string|array $key_or_address, string|null $message = null)

PING an instance in the redis cluster.

RedisCluster|bool
psetex(string $key, int $timeout, string $value)

No description

void
psubscribe(array $patterns, callable $callback)

No description

RedisCluster|int|false
pttl(string $key)

No description

RedisCluster|bool|int
publish(string $channel, string $message)

No description

mixed
pubsub(string|array $key_or_address, string ...$values)

No description

bool|array
punsubscribe(string $pattern, string ...$other_patterns)

No description

RedisCluster|bool|string
randomkey(string|array $key_or_address)

No description

mixed
rawcommand(string|array $key_or_address, string $command, mixed ...$args)

No description

RedisCluster|bool
rename(string $key_src, string $key_dst)

No description

RedisCluster|bool
renamenx(string $key, string $newkey)

No description

RedisCluster|bool
restore(string $key, int $timeout, string $value, array|null $options = null)

No description

mixed
role(string|array $key_or_address)

No description

RedisCluster|bool|string|array
rpop(string $key, int $count = 0)

No description

RedisCluster|bool|string
rpoplpush(string $src, string $dst)

No description

RedisCluster|int|false
rpush(string $key, mixed ...$elements)

No description

RedisCluster|bool|int
rpushx(string $key, string $value)

No description

RedisCluster|int|false
sadd(string $key, mixed $value, mixed ...$other_values)

No description

RedisCluster|bool|int
saddarray(string $key, array $values)

No description

RedisCluster|bool
save(string|array $key_or_address)

No description

bool|array
scan(null|int|string $iterator, string|array $key_or_address, string|null $pattern = null, int $count = 0)

No description

RedisCluster|int|false
scard(string $key)

No description

mixed
script(string|array $key_or_address, mixed ...$args)

No description

RedisCluster|array|false
sdiff(string $key, string ...$other_keys)

No description

RedisCluster|int|false
sdiffstore(string $dst, string $key, string ...$other_keys)

No description

RedisCluster|string|bool
set(string $key, mixed $value, mixed $options = null)

No description

RedisCluster|int|false
setbit(string $key, int $offset, bool $onoff)

No description

RedisCluster|bool
setex(string $key, int $expire, mixed $value)

No description

RedisCluster|bool
setnx(string $key, mixed $value)

No description

bool
setoption(int $option, mixed $value)

No description

RedisCluster|int|false
setrange(string $key, int $offset, string $value)

No description

RedisCluster|array|false
sinter(array|string $key, string ...$other_keys)

No description

RedisCluster|int|false
sintercard(array $keys, int $limit = -1)

No description

RedisCluster|int|false
sinterstore(array|string $key, string ...$other_keys)

No description

RedisCluster|bool
sismember(string $key, mixed $value)

No description

RedisCluster|array|false
smismember(string $key, string $member, string ...$other_members)

No description

mixed
slowlog(string|array $key_or_address, mixed ...$args)

No description

RedisCluster|array|false
smembers(string $key)

No description

RedisCluster|bool
smove(string $src, string $dst, string $member)

No description

RedisCluster|array|bool|int|string
sort(string $key, array|null $options = null)

No description

RedisCluster|array|bool|int|string
sort_ro(string $key, array|null $options = null)

No description

RedisCluster|string|array|false
spop(string $key, int $count = 0)

No description

RedisCluster|string|array|false
srandmember(string $key, int $count = 0)

No description

RedisCluster|int|false
srem(string $key, mixed $value, mixed ...$other_values)

No description

array|false
sscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

RedisCluster|int|false
strlen(string $key)

No description

void
subscribe(array $channels, callable $cb)

No description

RedisCluster|bool|array
sunion(string $key, string ...$other_keys)

No description

RedisCluster|int|false
sunionstore(string $dst, string $key, string ...$other_keys)

No description

RedisCluster|bool|array
time(string|array $key_or_address)

No description

RedisCluster|int|false
ttl(string $key)

No description

RedisCluster|int|false
type(string $key)

No description

bool|array
unsubscribe(array $channels)

No description

RedisCluster|int|false
unlink(array|string $key, string ...$other_keys)

No description

bool
unwatch()

No description

RedisCluster|bool
watch(string $key, string ...$other_keys)

No description

RedisCluster|int|false
vadd(string $key, array $values, mixed $element, array|null $options = null)

No description

RedisCluster|array|false
vsim(string $key, mixed $member, array|null $options = null)

No description

RedisCluster|int|false
vcard(string $key)

No description

RedisCluster|int|false
vdim(string $key)

No description

RedisCluster|array|false
vinfo(string $key)

No description

RedisCluster|bool
vismember(string $key, mixed $member)

Check if an element is a member of a vectorset

RedisCluster|array|false
vemb(string $key, mixed $member, bool $raw = false)

No description

RedisCluster|array|string|false
vrandmember(string $key, int $count = 0)

No description

RedisCluster|array|false
vrange(string $key, string $min, string $max, int $count = -1)

Retreive a lexographical range of elements from a vector set

RedisCluster|int|false
vrem(string $key, mixed $member)

No description

RedisCluster|array|false
vlinks(string $key, mixed $member, bool $withscores = false)

No description

RedisCluster|array|string|false
vgetattr(string $key, mixed $member, bool $decode = true)

No description

RedisCluster|int|false
vsetattr(string $key, mixed $member, array|string $attributes)

No description

RedisCluster|int|false
xack(string $key, string $group, array $ids)

No description

RedisCluster|string|false
xadd(string $key, string $id, array $values, int $maxlen = 0, bool $approx = false)

No description

RedisCluster|string|array|false
xclaim(string $key, string $group, string $consumer, int $min_iddle, array $ids, array $options)

No description

RedisCluster|int|false
xdel(string $key, array $ids)

No description

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

No description

RedisCluster|bool|array
xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = -1, bool $justid = false)

No description

mixed
xinfo(string $operation, string|null $arg1 = null, string|null $arg2 = null, int $count = -1)

No description

RedisCluster|int|false
xlen(string $key)

No description

RedisCluster|array|false
xpending(string $key, string $group, string|null $start = null, string|null $end = null, int $count = -1, string|null $consumer = null)

No description

RedisCluster|bool|array
xrange(string $key, string $start, string $end, int $count = -1)

No description

RedisCluster|bool|array
xread(array $streams, int $count = -1, int $block = -1)

No description

RedisCluster|bool|array
xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1)

No description

RedisCluster|bool|array
xrevrange(string $key, string $start, string $end, int $count = -1)

No description

RedisCluster|int|false
xtrim(string $key, int $maxlen, bool $approx = false, bool $minid = false, int $limit = -1)

No description

RedisCluster|int|float|false
zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

No description

RedisCluster|int|false
zcard(string $key)

No description

RedisCluster|int|false
zcount(string $key, string $start, string $end)

No description

RedisCluster|float|false
zincrby(string $key, float $value, string $member)

No description

RedisCluster|int|false
zinterstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)

No description

RedisCluster|int|false
zintercard(array $keys, int $limit = -1)

No description

RedisCluster|int|false
zlexcount(string $key, string $min, string $max)

No description

RedisCluster|bool|array
zpopmax(string $key, int|null $value = null)

No description

RedisCluster|bool|array
zpopmin(string $key, int|null $value = null)

No description

RedisCluster|array|bool
zrange(string $key, mixed $start, mixed $end, array|bool|null $options = null)

No description

RedisCluster|int|false
zrangestore(string $dstkey, string $srckey, int $start, int $end, array|bool|null $options = null)

No description

RedisCluster|string|array
zrandmember(string $key, array|null $options = null)

No description

RedisCluster|array|false
zrangebylex(string $key, string $min, string $max, int $offset = -1, int $count = -1)

No description

RedisCluster|array|false
zrangebyscore(string $key, string $start, string $end, array $options = [])

No description

RedisCluster|int|false
zrank(string $key, mixed $member)

No description

RedisCluster|int|false
zrem(string $key, string $value, string ...$other_values)

No description

RedisCluster|int|false
zremrangebylex(string $key, string $min, string $max)

No description

RedisCluster|int|false
zremrangebyrank(string $key, string $min, string $max)

No description

RedisCluster|int|false
zremrangebyscore(string $key, string $min, string $max)

No description

RedisCluster|bool|array
zrevrange(string $key, string $min, string $max, array|null $options = null)

No description

RedisCluster|bool|array
zrevrangebylex(string $key, string $min, string $max, array|null $options = null)

No description

RedisCluster|bool|array
zrevrangebyscore(string $key, string $min, string $max, array|null $options = null)

No description

RedisCluster|int|false
zrevrank(string $key, mixed $member)

No description

RedisCluster|bool|array
zscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

RedisCluster|float|false
zscore(string $key, mixed $member)

No description

RedisCluster|array|false
zmscore(string $key, mixed $member, mixed ...$other_members)

No description

RedisCluster|int|false
zunionstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)

No description

RedisCluster|array|false
zinter(array $keys, array|null $weights = null, array|null $options = null)

No description

RedisCluster|int|false
zdiffstore(string $dst, array $keys)

No description

RedisCluster|array|false
zunion(array $keys, array|null $weights = null, array|null $options = null)

No description

RedisCluster|array|false
zdiff(array $keys, array|null $options = null)

No description

RedisCluster|string|false
digest(string $key)

No description

Details

at line 50
__construct(string|null $name, array|null $seeds = null, int|float $timeout = 0, int|float $read_timeout = 0, bool $persistent = false, mixed $auth = null, array|null $context = null)

No description

Parameters

string|null $name
array|null $seeds
int|float $timeout
int|float $read_timeout
bool $persistent
mixed $auth
array|null $context

at line 55
string _compress(string $value)

No description

Parameters

string $value

Return Value

string

See also

Redis::_compress

at line 60
string _uncompress(string $value)

No description

Parameters

string $value

Return Value

string

See also

Redis::_uncompress

at line 65
bool|string _serialize(mixed $value)

No description

Parameters

mixed $value

Return Value

bool|string

See also

Redis::_serialize

at line 70
mixed _unserialize(string $value)

No description

Parameters

string $value

Return Value

mixed

See also

Redis::_unserialize

at line 75
string _pack(mixed $value)

No description

Parameters

mixed $value

Return Value

string

See also

Redis::_pack

at line 80
string _digest(mixed $value)

No description

Parameters

mixed $value

Return Value

string

See also

Redis::_digest

at line 85
mixed _unpack(string $value)

No description

Parameters

string $value

Return Value

mixed

See also

Redis::_unpack

at line 90
bool|string _prefix(string $key)

No description

Parameters

string $key

Return Value

bool|string

See also

Redis::_prefix

at line 92
array _masters()

No description

Return Value

array

at line 94
string|null _redir()

No description

Return Value

string|null

at line 99
mixed acl(string|array $key_or_address, string $subcmd, string ...$args)

No description

Parameters

string|array $key_or_address
string $subcmd
string ...$args

Return Value

mixed

See also

Redis::acl

at line 104
RedisCluster|bool|int append(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|bool|int

See also

Redis::append

at line 109
RedisCluster|bool bgrewriteaof(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|bool

See also

Redis::bgrewriteaof

at line 114
RedisCluster|int|false wait(string|array $key_or_address, int $numreplicas, int $timeout)

No description

Parameters

string|array $key_or_address
int $numreplicas
int $timeout

Return Value

RedisCluster|int|false

See also

Redis::wait

at line 119
RedisCluster|array|false waitaof(string|array $key_or_address, int $numlocal, int $numreplicas, int $timeout)

No description

Parameters

string|array $key_or_address
int $numlocal
int $numreplicas
int $timeout

Return Value

RedisCluster|array|false

See also

Redis::waitaof

at line 125
RedisCluster|bool bgsave(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|bool

See also

Redis::bgsave

at line 130
RedisCluster|bool|int bitcount(string $key, int $start = 0, int $end = -1, bool $bybit = false)

No description

Parameters

string $key
int $start
int $end
bool $bybit

Return Value

RedisCluster|bool|int

See also

Redis::bitcount

at line 135
RedisCluster|bool|int bitop(string $operation, string $deskey, string $srckey, string ...$otherkeys)

No description

Parameters

string $operation
string $deskey
string $srckey
string ...$otherkeys

Return Value

RedisCluster|bool|int

See also

Redis::bitop

at line 149
RedisCluster|int|false bitpos(string $key, bool $bit, int $start = 0, int $end = -1, bool $bybit = false)

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

Parameters

string $key

The key to check (must be a string)
bool $bit

Whether to look for an unset (0) or set (1) bit.
int $start

Where in the string to start looking.
int $end

Where in the string to stop looking.
bool $bybit

If true, Redis will treat $start and $end as BIT values and not bytes, so if start was 0 and end was 2, Redis would only search the first two bits.

Return Value

RedisCluster|int|false

See also

https://https://redis.io/commands/bitpos/

at line 154
RedisCluster|array|null|false blpop(string|array $key, string|float|int $timeout_or_key, mixed ...$extra_args)

See Redis::blpop()

Parameters

string|array $key
string|float|int $timeout_or_key
mixed ...$extra_args

Return Value

RedisCluster|array|null|false

at line 159
RedisCluster|array|null|false brpop(string|array $key, string|float|int $timeout_or_key, mixed ...$extra_args)

See Redis::brpop()

Parameters

string|array $key
string|float|int $timeout_or_key
mixed ...$extra_args

Return Value

RedisCluster|array|null|false

at line 164
mixed brpoplpush(string $srckey, string $deskey, int $timeout)

See Redis::brpoplpush()

Parameters

string $srckey
string $deskey
int $timeout

Return Value

mixed

at line 171
RedisCluster|string|false lmove(string $src, string $dst, string $wherefrom, string $whereto)

Move an element from one list into another.

Parameters

string $src
string $dst
string $wherefrom
string $whereto

Return Value

RedisCluster|string|false

See also

Redis::lmove

at line 179
RedisCluster|string|false blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout)

Move an element from one list to another, blocking up to a timeout until an element is available.

Parameters

string $src
string $dst
string $wherefrom
string $whereto
float $timeout

Return Value

RedisCluster|string|false

See also

Redis::blmove

at line 184
array bzpopmax(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)

No description

Parameters

string|array $key
string|int $timeout_or_key
mixed ...$extra_args

Return Value

array

See also

Redis::bzpopmax

at line 189
array bzpopmin(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)

No description

Parameters

string|array $key
string|int $timeout_or_key
mixed ...$extra_args

Return Value

array

See also

Redis::bzpopmin

at line 194
RedisCluster|array|null|false bzmpop(float $timeout, array $keys, string $from, int $count = 1)

No description

Parameters

float $timeout
array $keys
string $from
int $count

Return Value

RedisCluster|array|null|false

See also

Redis::bzmpop

at line 199
RedisCluster|array|null|false zmpop(array $keys, string $from, int $count = 1)

No description

Parameters

array $keys
string $from
int $count

Return Value

RedisCluster|array|null|false

See also

Redis::zmpop

at line 204
RedisCluster|array|null|false blmpop(float $timeout, array $keys, string $from, int $count = 1)

No description

Parameters

float $timeout
array $keys
string $from
int $count

Return Value

RedisCluster|array|null|false

See also

Redis::blmpop

at line 209
RedisCluster|array|null|false lmpop(array $keys, string $from, int $count = 1)

No description

Parameters

array $keys
string $from
int $count

Return Value

RedisCluster|array|null|false

See also

Redis::lmpop

at line 214
bool clearlasterror()

No description

Return Value

bool

See also

\Redis::clearlasterror()

at line 219
array|string|bool client(string|array $key_or_address, string $subcommand, string|null $arg = null)

No description

Parameters

string|array $key_or_address
string $subcommand
string|null $arg

Return Value

array|string|bool

See also

Redis::client

at line 224
bool close()

No description

Return Value

bool

See also

Redis::close

at line 229
mixed cluster(string|array $key_or_address, string $command, mixed ...$extra_args)

No description

Parameters

string|array $key_or_address
string $command
mixed ...$extra_args

Return Value

mixed

See also

Redis::cluster

at line 234
mixed command(mixed ...$extra_args)

No description

Parameters

mixed ...$extra_args

Return Value

mixed

See also

Redis::command

at line 239
mixed config(string|array $key_or_address, string $subcommand, mixed ...$extra_args)

No description

Parameters

string|array $key_or_address
string $subcommand
mixed ...$extra_args

Return Value

mixed

See also

Redis::config

at line 244
RedisCluster|int dbsize(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|int

See also

\Redis::dbsize()

at line 249
RedisCluster|bool copy(string $src, string $dst, array|null $options = null)

No description

Parameters

string $src
string $dst
array|null $options

Return Value

RedisCluster|bool

See also

https://redis.io/commands/copy

at line 254
RedisCluster|int|false decr(string $key, int $by = 1)

No description

Parameters

string $key
int $by

Return Value

RedisCluster|int|false

See also

Redis::decr

at line 259
RedisCluster|int|false decrby(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisCluster|int|false

See also

\Redis::decrby()

at line 264
float decrbyfloat(string $key, float $value)

No description

Parameters

string $key
float $value

Return Value

float

See also

Redis::decrbyfloat

at line 269
RedisCluster|int|false del(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster|int|false

See also

Redis::del

at line 279
RedisCluster|int|false delex(string $key, array|null $options = null)

Delete a key conditionally based on its value or hash digest

Parameters

string $key

The key to delete
array|null $options

An array with options to modify how DELX works.

Return Value

RedisCluster|int|false

Returns 1 if the key was deleted, 0 if it was not.

at line 289
RedisCluster|int|false delifeq(string $key, mixed $value)

Delete a key if it's equal to the specified value. This command is specific to Valkey >= 9.0

Parameters

string $key

The key to delete
mixed $value

The value to compare against the key's value.

Return Value

RedisCluster|int|false

Returns 1 if the key was deleted, 0 if it was not.

at line 294
bool discard()

No description

Return Value

bool

See also

Redis::discard

at line 299
RedisCluster|string|false dump(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string|false

See also

Redis::dump

at line 304
RedisCluster|string|false echo(string|array $key_or_address, string $msg)

No description

Parameters

string|array $key_or_address
string $msg

Return Value

RedisCluster|string|false

See also

Redis::echo

at line 309
mixed eval(string $script, array $args = [], int $num_keys = 0)

No description

Parameters

string $script
array $args
int $num_keys

Return Value

mixed

See also

Redis::eval

at line 314
mixed eval_ro(string $script, array $args = [], int $num_keys = 0)

No description

Parameters

string $script
array $args
int $num_keys

Return Value

mixed

See also

Redis::eval_ro

at line 319
mixed evalsha(string $script_sha, array $args = [], int $num_keys = 0)

No description

Parameters

string $script_sha
array $args
int $num_keys

Return Value

mixed

See also

Redis::evalsha

at line 324
mixed evalsha_ro(string $script_sha, array $args = [], int $num_keys = 0)

No description

Parameters

string $script_sha
array $args
int $num_keys

Return Value

mixed

See also

Redis::evalsha_ro

at line 329
array|false exec()

No description

Return Value

array|false

See also

Redis::exec

at line 334
RedisCluster|int|bool exists(mixed $key, mixed ...$other_keys)

No description

Parameters

mixed $key
mixed ...$other_keys

Return Value

RedisCluster|int|bool

See also

Redis::exists

at line 339
RedisCluster|int|bool touch(mixed $key, mixed ...$other_keys)

No description

Parameters

mixed $key
mixed ...$other_keys

Return Value

RedisCluster|int|bool

See also

Redis::touch

at line 344
RedisCluster|bool expire(string $key, int $timeout, string|null $mode = null)

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

RedisCluster|bool

See also

Redis::expire

at line 349
RedisCluster|bool expireat(string $key, int $timestamp, string|null $mode = null)

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

RedisCluster|bool

See also

Redis::expireat

at line 354
RedisCluster|int|false expiretime(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::expiretime

at line 359
RedisCluster|int|false pexpiretime(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::pexpiretime

at line 364
RedisCluster|bool flushall(string|array $key_or_address, bool $async = false)

No description

Parameters

string|array $key_or_address
bool $async

Return Value

RedisCluster|bool

See also

Redis::flushall

at line 369
RedisCluster|bool flushdb(string|array $key_or_address, bool $async = false)

No description

Parameters

string|array $key_or_address
bool $async

Return Value

RedisCluster|bool

See also

Redis::flushdb

at line 374
RedisCluster|int|false geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples_and_options)

No description

Parameters

string $key
float $lng
float $lat
string $member
mixed ...$other_triples_and_options

Return Value

RedisCluster|int|false

See also

Redis::geoadd

at line 379
RedisCluster|float|false geodist(string $key, string $src, string $dest, string|null $unit = null)

No description

Parameters

string $key
string $src
string $dest
string|null $unit

Return Value

RedisCluster|float|false

See also

Redis::geodist

at line 384
RedisCluster|array|false geohash(string $key, string $member, string ...$other_members)

No description

Parameters

string $key
string $member
string ...$other_members

Return Value

RedisCluster|array|false

See also

Redis::geohash

at line 389
RedisCluster|array|false geopos(string $key, string $member, string ...$other_members)

No description

Parameters

string $key
string $member
string ...$other_members

Return Value

RedisCluster|array|false

See also

Redis::geopos

at line 394
mixed georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = [])

No description

Parameters

string $key
float $lng
float $lat
float $radius
string $unit
array $options

Return Value

mixed

See also

Redis::georadius

at line 399
mixed georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = [])

No description

Parameters

string $key
float $lng
float $lat
float $radius
string $unit
array $options

Return Value

mixed

See also

Redis::georadius_ro

at line 404
mixed georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = [])

No description

Parameters

string $key
string $member
float $radius
string $unit
array $options

Return Value

mixed

See also

Redis::georadiusbymember

at line 409
mixed georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = [])

No description

Parameters

string $key
string $member
float $radius
string $unit
array $options

Return Value

mixed

See also

Redis::georadiusbymember_ro

at line 414
RedisCluster|array geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = [])

No description

Parameters

string $key
array|string $position
array|int|float $shape
string $unit
array $options

Return Value

RedisCluster|array

See also

https://redis.io/commands/geosearch

at line 419
RedisCluster|array|int|false geosearchstore(string $dst, string $src, array|string $position, array|int|float $shape, string $unit, array $options = [])

No description

Parameters

string $dst
string $src
array|string $position
array|int|float $shape
string $unit
array $options

Return Value

RedisCluster|array|int|false

See also

https://redis.io/commands/geosearchstore

at line 424
mixed get(string $key)

No description

Parameters

string $key

Return Value

mixed

See also

Redis::get

at line 429
mixed getdel(string $key)

No description

Parameters

string $key

Return Value

mixed

See also

Redis::getdel

at line 434
RedisCluster|array|false getWithMeta(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::getWithMeta

at line 439
RedisCluster|string|false getex(string $key, array $options = [])

No description

Parameters

string $key
array $options

Return Value

RedisCluster|string|false

See also

Redis::getEx

at line 444
RedisCluster|int|false getbit(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisCluster|int|false

See also

Redis::getbit

at line 449
string|null getlasterror()

No description

Return Value

string|null

See also

Redis::getlasterror

at line 454
int getmode()

No description

Return Value

int

See also

Redis::getmode

at line 459
mixed getoption(int $option)

No description

Parameters

int $option

Return Value

mixed

See also

Redis::getoption

at line 464
RedisCluster|string|false getrange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster|string|false

See also

Redis::getrange

at line 469
RedisCluster|string|array|int|false lcs(string $key1, string $key2, array|null $options = null)

No description

Parameters

string $key1
string $key2
array|null $options

Return Value

RedisCluster|string|array|int|false

See also

Redis::lcs

at line 474
RedisCluster|string|bool getset(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|string|bool

See also

Redis::getset

at line 479
array|false gettransferredbytes()

No description

Return Value

array|false

See also

Redis::gettransferredbytes

at line 484
void cleartransferredbytes()

No description

Return Value

void

See also

Redis::cleartransferredbytes

at line 489
RedisCluster|int|false hdel(string $key, string $member, string ...$other_members)

No description

Parameters

string $key
string $member
string ...$other_members

Return Value

RedisCluster|int|false

See also

Redis::hdel

at line 494
RedisCluster|bool hexists(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

RedisCluster|bool

See also

Redis::hexists

at line 499
mixed hget(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

See also

Redis::hget

at line 504
RedisCluster|array|false hgetall(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::hgetall

at line 509
mixed hgetWithMeta(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

See also

Redis::hgetWithMeta

at line 514
RedisCluster|int|false hincrby(string $key, string $member, int $value)

No description

Parameters

string $key
string $member
int $value

Return Value

RedisCluster|int|false

See also

Redis::hincrby

at line 519
RedisCluster|float|false hincrbyfloat(string $key, string $member, float $value)

No description

Parameters

string $key
string $member
float $value

Return Value

RedisCluster|float|false

See also

Redis::hincrbyfloat

at line 524
RedisCluster|array|false hkeys(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::hkeys

at line 529
RedisCluster|int|false hlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::hlen

at line 534
RedisCluster|array|false hmget(string $key, array $keys)

No description

Parameters

string $key
array $keys

Return Value

RedisCluster|array|false

See also

Redis::hmget

at line 539
RedisCluster|array|false hgetex(string $key, array $fields, string|array|null $expiry = null)

No description

Parameters

string $key
array $fields
string|array|null $expiry

Return Value

RedisCluster|array|false

See also

Redis::hgetex

at line 544
RedisCluster|int|false hsetex(string $key, array $fields, array|null $expiry = null)

No description

Parameters

string $key
array $fields
array|null $expiry

Return Value

RedisCluster|int|false

See also

Redis::hsetex

at line 549
RedisCluster|array|false hgetdel(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hgetdel

at line 554
RedisCluster|bool hmset(string $key, array $key_values)

No description

Parameters

string $key
array $key_values

Return Value

RedisCluster|bool

See also

Redis::hmset

at line 559
array|bool hscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

Parameters

string $key
null|int|string $iterator
string|null $pattern
int $count

Return Value

array|bool

See also

Redis::hscan

at line 564
RedisCluster|int|false expiremember(string $key, string $field, int $ttl, string|null $unit = null)

No description

Parameters

string $key
string $field
int $ttl
string|null $unit

Return Value

RedisCluster|int|false

See also

Redis::expiremember

at line 569
RedisCluster|int|false expirememberat(string $key, string $field, int $timestamp)

No description

Parameters

string $key
string $field
int $timestamp

Return Value

RedisCluster|int|false

See also

Redis::expirememberat

at line 574
RedisCluster|string|array hrandfield(string $key, array|null $options = null)

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster|string|array

See also

https://redis.io/commands/hrandfield

at line 579
RedisCluster|int|false hset(string $key, string $member, mixed $value)

No description

Parameters

string $key
string $member
mixed $value

Return Value

RedisCluster|int|false

See also

Redis::hset

at line 584
RedisCluster|bool hsetnx(string $key, string $member, mixed $value)

No description

Parameters

string $key
string $member
mixed $value

Return Value

RedisCluster|bool

See also

Redis::hsetnx

at line 589
RedisCluster|int|false hstrlen(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

RedisCluster|int|false

See also

Redis::hstrlen

at line 594
RedisCluster|array|false hexpire(string $key, int $ttl, array $fields, string|null $mode = NULL)

No description

Parameters

string $key
int $ttl
array $fields
string|null $mode

Return Value

RedisCluster|array|false

See also

Redis::hexpire

at line 600
RedisCluster|array|false hpexpire(string $key, int $ttl, array $fields, string|null $mode = NULL)

No description

Parameters

string $key
int $ttl
array $fields
string|null $mode

Return Value

RedisCluster|array|false

See also

Redis::hpexpire

at line 606
RedisCluster|array|false hexpireat(string $key, int $time, array $fields, string|null $mode = NULL)

No description

Parameters

string $key
int $time
array $fields
string|null $mode

Return Value

RedisCluster|array|false

See also

Redis::hexpireat

at line 612
RedisCluster|array|false hpexpireat(string $key, int $mstime, array $fields, string|null $mode = NULL)

No description

Parameters

string $key
int $mstime
array $fields
string|null $mode

Return Value

RedisCluster|array|false

See also

Redis::hpexpireat

at line 618
RedisCluster|array|false httl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::httl

at line 623
RedisCluster|array|false hpttl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hpttl

at line 628
RedisCluster|array|false hexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hexpiretime

at line 633
RedisCluster|array|false hpexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hpexpiretime

at line 638
RedisCluster|array|false hpersist(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hpexpiretime

at line 643
RedisCluster|array|false hvals(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::hvals

at line 648
RedisCluster|int|false incr(string $key, int $by = 1)

No description

Parameters

string $key
int $by

Return Value

RedisCluster|int|false

See also

Redis::incr

at line 653
RedisCluster|int|false incrby(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisCluster|int|false

See also

Redis::incrby

at line 658
RedisCluster|float|false incrbyfloat(string $key, float $value)

No description

Parameters

string $key
float $value

Return Value

RedisCluster|float|false

See also

Redis::incrbyfloat

at line 676
RedisCluster|array|false info(string|array $key_or_address, string ...$sections)

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

If connected to Redis server >= 7.0.0 you may pass multiple optional sections.

Parameters

string|array $key_or_address

Either a key name or array with host and port indicating which cluster node we want to send the command to.
string ...$sections

Optional section(s) you wish Redis server to return.

Return Value

RedisCluster|array|false

See also

https://redis.io/commands/info/

at line 681
RedisCluster|array|false keys(string $pattern)

No description

Parameters

string $pattern

Return Value

RedisCluster|array|false

See also

Redis::keys

at line 686
RedisCluster|int|false lastsave(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|int|false

See also

Redis::lastsave

at line 691
RedisCluster|string|bool lget(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

RedisCluster|string|bool

See also

Redis::lget

at line 696
mixed lindex(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

mixed

See also

Redis::lindex

at line 701
RedisCluster|int|false linsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

Parameters

string $key
string $pos
mixed $pivot
mixed $value

Return Value

RedisCluster|int|false

See also

Redis::linsert

at line 706
RedisCluster|int|bool llen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|bool

See also

Redis::llen

at line 711
RedisCluster|bool|string|array lpop(string $key, int $count = 0)

No description

Parameters

string $key
int $count

Return Value

RedisCluster|bool|string|array

See also

Redis::lpop

at line 716
RedisCluster|null|bool|int|array lpos(string $key, mixed $value, array|null $options = null)

No description

Parameters

string $key
mixed $value
array|null $options

Return Value

RedisCluster|null|bool|int|array

See also

Redis::lpos

at line 721
RedisCluster|int|bool lpush(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

string $key
mixed $value
mixed ...$other_values

Return Value

RedisCluster|int|bool

See also

Redis::lpush

at line 726
RedisCluster|int|bool lpushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|int|bool

See also

Redis::lpushx

at line 731
RedisCluster|array|false lrange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster|array|false

See also

Redis::lrange

at line 736
RedisCluster|int|bool lrem(string $key, mixed $value, int $count = 0)

No description

Parameters

string $key
mixed $value
int $count

Return Value

RedisCluster|int|bool

See also

Redis::lrem

at line 741
RedisCluster|bool lset(string $key, int $index, mixed $value)

No description

Parameters

string $key
int $index
mixed $value

Return Value

RedisCluster|bool

See also

Redis::lset

at line 746
RedisCluster|bool ltrim(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster|bool

See also

Redis::ltrim

at line 751
RedisCluster|array|false mget(array $keys)

No description

Parameters

array $keys

Return Value

RedisCluster|array|false

See also

Redis::mget

at line 756
RedisCluster|bool mset(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisCluster|bool

See also

Redis::mset

at line 761
RedisCluster|array|false msetnx(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisCluster|array|false

See also

Redis::msetnx

at line 766
RedisCluster|bool multi(int $value = Redis::MULTI)

No description

Parameters

int $value

Return Value

RedisCluster|bool

at line 771
RedisCluster|int|string|false object(string $subcommand, string $key)

No description

Parameters

string $subcommand
string $key

Return Value

RedisCluster|int|string|false

See also

Redis::object

at line 776
RedisCluster|bool persist(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|bool

See also

Redis::persist

at line 781
RedisCluster|bool pexpire(string $key, int $timeout, string|null $mode = null)

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

RedisCluster|bool

See also

Redis::pexpire

at line 786
RedisCluster|bool pexpireat(string $key, int $timestamp, string|null $mode = null)

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

RedisCluster|bool

See also

Redis::pexpireat

at line 792
RedisCluster|bool pfadd(string $key, array $elements)

No description

Parameters

string $key
array $elements

Return Value

RedisCluster|bool

See also

Redis::pfadd

at line 797
RedisCluster|int|false pfcount(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::pfcount

at line 802
RedisCluster|bool pfmerge(string $key, array $keys)

No description

Parameters

string $key
array $keys

Return Value

RedisCluster|bool

See also

Redis::pfmerge

at line 817
mixed ping(string|array $key_or_address, string|null $message = null)

PING an instance in the redis cluster.

Parameters

string|array $key_or_address

Either a key name or a two element array with host and address, informing RedisCluster which node to ping.
string|null $message

An optional message to send.

Return Value

mixed

This method always returns true if no message was sent, and the message itself if one was.

See also

Redis::ping

at line 822
RedisCluster|bool psetex(string $key, int $timeout, string $value)

No description

Parameters

string $key
int $timeout
string $value

Return Value

RedisCluster|bool

See also

Redis::psetex

at line 827
void psubscribe(array $patterns, callable $callback)

No description

Parameters

array $patterns
callable $callback

Return Value

void

See also

Redis::psubscribe

at line 832
RedisCluster|int|false pttl(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::pttl

at line 837
RedisCluster|bool|int publish(string $channel, string $message)

No description

Parameters

string $channel
string $message

Return Value

RedisCluster|bool|int

See also

Redis::publish

at line 842
mixed pubsub(string|array $key_or_address, string ...$values)

No description

Parameters

string|array $key_or_address
string ...$values

Return Value

mixed

See also

Redis::pubsub

at line 847
bool|array punsubscribe(string $pattern, string ...$other_patterns)

No description

Parameters

string $pattern
string ...$other_patterns

Return Value

bool|array

See also

Redis::punsubscribe

at line 852
RedisCluster|bool|string randomkey(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|bool|string

See also

Redis::randomkey

at line 857
mixed rawcommand(string|array $key_or_address, string $command, mixed ...$args)

No description

Parameters

string|array $key_or_address
string $command
mixed ...$args

Return Value

mixed

See also

Redis::rawcommand

at line 862
RedisCluster|bool rename(string $key_src, string $key_dst)

No description

Parameters

string $key_src
string $key_dst

Return Value

RedisCluster|bool

See also

Redis::rename

at line 867
RedisCluster|bool renamenx(string $key, string $newkey)

No description

Parameters

string $key
string $newkey

Return Value

RedisCluster|bool

See also

Redis::renamenx

at line 872
RedisCluster|bool restore(string $key, int $timeout, string $value, array|null $options = null)

No description

Parameters

string $key
int $timeout
string $value
array|null $options

Return Value

RedisCluster|bool

See also

Redis::restore

at line 877
mixed role(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

mixed

See also

Redis::role

at line 882
RedisCluster|bool|string|array rpop(string $key, int $count = 0)

No description

Parameters

string $key
int $count

Return Value

RedisCluster|bool|string|array

See also

\Redis::rpop()

at line 887
RedisCluster|bool|string rpoplpush(string $src, string $dst)

No description

Parameters

string $src
string $dst

Return Value

RedisCluster|bool|string

See also

Redis::rpoplpush

at line 892
RedisCluster|int|false rpush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

RedisCluster|int|false

See also

Redis::rpush

at line 897
RedisCluster|bool|int rpushx(string $key, string $value)

No description

Parameters

string $key
string $value

Return Value

RedisCluster|bool|int

See also

Redis::rpushx

at line 902
RedisCluster|int|false sadd(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

string $key
mixed $value
mixed ...$other_values

Return Value

RedisCluster|int|false

See also

\Redis::sadd()

at line 907
RedisCluster|bool|int saddarray(string $key, array $values)

No description

Parameters

string $key
array $values

Return Value

RedisCluster|bool|int

See also

\Redis::saddarray()

at line 912
RedisCluster|bool save(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|bool

See also

Redis::save

at line 917
bool|array scan(null|int|string $iterator, string|array $key_or_address, string|null $pattern = null, int $count = 0)

No description

Parameters

null|int|string $iterator
string|array $key_or_address
string|null $pattern
int $count

Return Value

bool|array

See also

Redis::scan

at line 922
RedisCluster|int|false scard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::scard

at line 927
mixed script(string|array $key_or_address, mixed ...$args)

No description

Parameters

string|array $key_or_address
mixed ...$args

Return Value

mixed

See also

Redis::script

at line 932
RedisCluster|array|false sdiff(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisCluster|array|false

See also

\Redis::sdiff()

at line 937
RedisCluster|int|false sdiffstore(string $dst, string $key, string ...$other_keys)

No description

Parameters

string $dst
string $key
string ...$other_keys

Return Value

RedisCluster|int|false

See also

\Redis::sdiffstore()

at line 942
RedisCluster|string|bool set(string $key, mixed $value, mixed $options = null)

No description

Parameters

string $key
mixed $value
mixed $options

Return Value

RedisCluster|string|bool

See also

https://redis.io/commands/set

at line 947
RedisCluster|int|false setbit(string $key, int $offset, bool $onoff)

No description

Parameters

string $key
int $offset
bool $onoff

Return Value

RedisCluster|int|false

See also

Redis::setbit

at line 952
RedisCluster|bool setex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

RedisCluster|bool

See also

Redis::setex

at line 957
RedisCluster|bool setnx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|bool

See also

Redis::setnx

at line 962
bool setoption(int $option, mixed $value)

No description

Parameters

int $option
mixed $value

Return Value

bool

See also

Redis::setoption

at line 967
RedisCluster|int|false setrange(string $key, int $offset, string $value)

No description

Parameters

string $key
int $offset
string $value

Return Value

RedisCluster|int|false

See also

Redis::setrange

at line 972
RedisCluster|array|false sinter(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster|array|false

See also

\Redis::sinter()

at line 977
RedisCluster|int|false sintercard(array $keys, int $limit = -1)

No description

Parameters

array $keys
int $limit

Return Value

RedisCluster|int|false

See also

Redis::sintercard

at line 982
RedisCluster|int|false sinterstore(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster|int|false

See also

\Redis::sinterstore()

at line 987
RedisCluster|bool sismember(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|bool

See also

Redis::sismember

at line 992
RedisCluster|array|false smismember(string $key, string $member, string ...$other_members)

No description

Parameters

string $key
string $member
string ...$other_members

Return Value

RedisCluster|array|false

See also

Redis::smismember

at line 997
mixed slowlog(string|array $key_or_address, mixed ...$args)

No description

Parameters

string|array $key_or_address
mixed ...$args

Return Value

mixed

See also

Redis::slowlog

at line 1002
RedisCluster|array|false smembers(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

\Redis::smembers()

at line 1007
RedisCluster|bool smove(string $src, string $dst, string $member)

No description

Parameters

string $src
string $dst
string $member

Return Value

RedisCluster|bool

See also

\Redis::smove()

at line 1012
RedisCluster|array|bool|int|string sort(string $key, array|null $options = null)

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster|array|bool|int|string

See also

Redis::sort

at line 1017
RedisCluster|array|bool|int|string sort_ro(string $key, array|null $options = null)

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster|array|bool|int|string

See also

Redis::sort_ro

at line 1022
RedisCluster|string|array|false spop(string $key, int $count = 0)

No description

Parameters

string $key
int $count

Return Value

RedisCluster|string|array|false

See also

Redis::spop

at line 1027
RedisCluster|string|array|false srandmember(string $key, int $count = 0)

No description

Parameters

string $key
int $count

Return Value

RedisCluster|string|array|false

See also

Redis::srandmember

at line 1032
RedisCluster|int|false srem(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

string $key
mixed $value
mixed ...$other_values

Return Value

RedisCluster|int|false

See also

Redis::srem

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

No description

Parameters

string $key
null|int|string $iterator
string|null $pattern
int $count

Return Value

array|false

See also

Redis::sscan

at line 1042
RedisCluster|int|false strlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::strlen

at line 1047
void subscribe(array $channels, callable $cb)

No description

Parameters

array $channels
callable $cb

Return Value

void

See also

Redis::subscribe

at line 1052
RedisCluster|bool|array sunion(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisCluster|bool|array

See also

\Redis::sunion()

at line 1057
RedisCluster|int|false sunionstore(string $dst, string $key, string ...$other_keys)

No description

Parameters

string $dst
string $key
string ...$other_keys

Return Value

RedisCluster|int|false

See also

\Redis::sunionstore()

at line 1062
RedisCluster|bool|array time(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|bool|array

See also

Redis::time

at line 1067
RedisCluster|int|false ttl(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::ttl

at line 1072
RedisCluster|int|false type(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::type

at line 1077
bool|array unsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

bool|array

See also

Redis::unsubscribe

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster|int|false

See also

Redis::unlink

at line 1087
bool unwatch()

No description

Return Value

bool

See also

Redis::unwatch

at line 1092
RedisCluster|bool watch(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisCluster|bool

See also

Redis::watch

at line 1097
RedisCluster|int|false vadd(string $key, array $values, mixed $element, array|null $options = null)

No description

Parameters

string $key
array $values
mixed $element
array|null $options

Return Value

RedisCluster|int|false

See also

Redis::vadd

at line 1102
RedisCluster|array|false vsim(string $key, mixed $member, array|null $options = null)

No description

Parameters

string $key
mixed $member
array|null $options

Return Value

RedisCluster|array|false

See also

Redis::vsim

at line 1107
RedisCluster|int|false vcard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::vcard

at line 1112
RedisCluster|int|false vdim(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::vdim

at line 1117
RedisCluster|array|false vinfo(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::vinfo

at line 1127
RedisCluster|bool vismember(string $key, mixed $member)

Check if an element is a member of a vectorset

Parameters

string $key

The vector set to query.
mixed $member

The member to check for.

Return Value

RedisCluster|bool

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

at line 1132
RedisCluster|array|false vemb(string $key, mixed $member, bool $raw = false)

No description

Parameters

string $key
mixed $member
bool $raw

Return Value

RedisCluster|array|false

See also

Redis::vemb

at line 1137
RedisCluster|array|string|false vrandmember(string $key, int $count = 0)

No description

Parameters

string $key
int $count

Return Value

RedisCluster|array|string|false

See also

Redis::vrandmember

at line 1149
RedisCluster|array|false vrange(string $key, string $min, string $max, int $count = -1)

Retreive a lexographical range of elements from a vector set

Parameters

string $key

The vector set to query.
string $min

The minimum element to return.
string $max

The maximum element to return.
int $count

An optional maximum number of elements to return.

Return Value

RedisCluster|array|false

An array of elements in the specified range.`

at line 1155
RedisCluster|int|false vrem(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster|int|false

See also

Redis::vrem

No description

Parameters

string $key
mixed $member
bool $withscores

Return Value

RedisCluster|array|false

See also

Redis::vlinks

at line 1165
RedisCluster|array|string|false vgetattr(string $key, mixed $member, bool $decode = true)

No description

Parameters

string $key
mixed $member
bool $decode

Return Value

RedisCluster|array|string|false

See also

Redis::vgetattr

at line 1170
RedisCluster|int|false vsetattr(string $key, mixed $member, array|string $attributes)

No description

Parameters

string $key
mixed $member
array|string $attributes

Return Value

RedisCluster|int|false

See also

Redis::vsetattr

at line 1175
RedisCluster|int|false xack(string $key, string $group, array $ids)

No description

Parameters

string $key
string $group
array $ids

Return Value

RedisCluster|int|false

See also

Redis::xack

at line 1180
RedisCluster|string|false xadd(string $key, string $id, array $values, int $maxlen = 0, bool $approx = false)

No description

Parameters

string $key
string $id
array $values
int $maxlen
bool $approx

Return Value

RedisCluster|string|false

See also

Redis::xadd

at line 1185
RedisCluster|string|array|false xclaim(string $key, string $group, string $consumer, int $min_iddle, array $ids, array $options)

No description

Parameters

string $key
string $group
string $consumer
int $min_iddle
array $ids
array $options

Return Value

RedisCluster|string|array|false

See also

Redis::xclaim

at line 1190
RedisCluster|int|false xdel(string $key, array $ids)

No description

Parameters

string $key
array $ids

Return Value

RedisCluster|int|false

See also

Redis::xdel

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

No description

Parameters

string $operation
string|null $key
string|null $group
string|null $id_or_consumer
bool $mkstream
int $entries_read

Return Value

mixed

See also

Redis::xgroup

at line 1201
RedisCluster|bool|array xautoclaim(string $key, string $group, string $consumer, int $min_idle, string $start, int $count = -1, bool $justid = false)

No description

Parameters

string $key
string $group
string $consumer
int $min_idle
string $start
int $count
bool $justid

Return Value

RedisCluster|bool|array

See also

Redis::xautoclaim

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

No description

Parameters

string $operation
string|null $arg1
string|null $arg2
int $count

Return Value

mixed

See also

Redis::xinfo

at line 1211
RedisCluster|int|false xlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::xlen

at line 1216
RedisCluster|array|false xpending(string $key, string $group, string|null $start = null, string|null $end = null, int $count = -1, string|null $consumer = null)

No description

Parameters

string $key
string $group
string|null $start
string|null $end
int $count
string|null $consumer

Return Value

RedisCluster|array|false

See also

Redis::xpending

at line 1221
RedisCluster|bool|array xrange(string $key, string $start, string $end, int $count = -1)

No description

Parameters

string $key
string $start
string $end
int $count

Return Value

RedisCluster|bool|array

See also

Redis::xrange

at line 1226
RedisCluster|bool|array xread(array $streams, int $count = -1, int $block = -1)

No description

Parameters

array $streams
int $count
int $block

Return Value

RedisCluster|bool|array

See also

Redis::xread

at line 1231
RedisCluster|bool|array xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1)

No description

Parameters

string $group
string $consumer
array $streams
int $count
int $block

Return Value

RedisCluster|bool|array

See also

Redis::xreadgroup

at line 1236
RedisCluster|bool|array xrevrange(string $key, string $start, string $end, int $count = -1)

No description

Parameters

string $key
string $start
string $end
int $count

Return Value

RedisCluster|bool|array

See also

Redis::xrevrange

at line 1241
RedisCluster|int|false xtrim(string $key, int $maxlen, bool $approx = false, bool $minid = false, int $limit = -1)

No description

Parameters

string $key
int $maxlen
bool $approx
bool $minid
int $limit

Return Value

RedisCluster|int|false

See also

Redis::xtrim

at line 1246
RedisCluster|int|float|false zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

No description

Parameters

string $key
array|float $score_or_options
mixed ...$more_scores_and_mems

Return Value

RedisCluster|int|float|false

See also

Redis::zadd

at line 1251
RedisCluster|int|false zcard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::zcard

at line 1256
RedisCluster|int|false zcount(string $key, string $start, string $end)

No description

Parameters

string $key
string $start
string $end

Return Value

RedisCluster|int|false

See also

Redis::zcount

at line 1261
RedisCluster|float|false zincrby(string $key, float $value, string $member)

No description

Parameters

string $key
float $value
string $member

Return Value

RedisCluster|float|false

See also

Redis::zincrby

at line 1266
RedisCluster|int|false zinterstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)

No description

Parameters

string $dst
array $keys
array|null $weights
string|null $aggregate

Return Value

RedisCluster|int|false

See also

Redis::zinterstore

at line 1271
RedisCluster|int|false zintercard(array $keys, int $limit = -1)

No description

Parameters

array $keys
int $limit

Return Value

RedisCluster|int|false

See also

Redis::zintercard

at line 1276
RedisCluster|int|false zlexcount(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisCluster|int|false

See also

Redis::zlexcount

at line 1281
RedisCluster|bool|array zpopmax(string $key, int|null $value = null)

No description

Parameters

string $key
int|null $value

Return Value

RedisCluster|bool|array

See also

Redis::zpopmax

at line 1286
RedisCluster|bool|array zpopmin(string $key, int|null $value = null)

No description

Parameters

string $key
int|null $value

Return Value

RedisCluster|bool|array

See also

Redis::zpopmin

at line 1291
RedisCluster|array|bool zrange(string $key, mixed $start, mixed $end, array|bool|null $options = null)

No description

Parameters

string $key
mixed $start
mixed $end
array|bool|null $options

Return Value

RedisCluster|array|bool

See also

Redis::zrange

at line 1296
RedisCluster|int|false zrangestore(string $dstkey, string $srckey, int $start, int $end, array|bool|null $options = null)

No description

Parameters

string $dstkey
string $srckey
int $start
int $end
array|bool|null $options

Return Value

RedisCluster|int|false

See also

Redis::zrangestore

at line 1302
RedisCluster|string|array zrandmember(string $key, array|null $options = null)

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster|string|array

See also

https://redis.io/commands/zrandmember

at line 1307
RedisCluster|array|false zrangebylex(string $key, string $min, string $max, int $offset = -1, int $count = -1)

No description

Parameters

string $key
string $min
string $max
int $offset
int $count

Return Value

RedisCluster|array|false

See also

Redis::zrangebylex

at line 1312
RedisCluster|array|false zrangebyscore(string $key, string $start, string $end, array $options = [])

No description

Parameters

string $key
string $start
string $end
array $options

Return Value

RedisCluster|array|false

See also

Redis::zrangebyscore

at line 1317
RedisCluster|int|false zrank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster|int|false

See also

Redis::zrank

at line 1322
RedisCluster|int|false zrem(string $key, string $value, string ...$other_values)

No description

Parameters

string $key
string $value
string ...$other_values

Return Value

RedisCluster|int|false

See also

Redis::zrem

at line 1327
RedisCluster|int|false zremrangebylex(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisCluster|int|false

See also

Redis::zremrangebylex

at line 1332
RedisCluster|int|false zremrangebyrank(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisCluster|int|false

See also

Redis::zremrangebyrank

at line 1337
RedisCluster|int|false zremrangebyscore(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisCluster|int|false

See also

Redis::zremrangebyscore

at line 1342
RedisCluster|bool|array zrevrange(string $key, string $min, string $max, array|null $options = null)

No description

Parameters

string $key
string $min
string $max
array|null $options

Return Value

RedisCluster|bool|array

See also

Redis::zrevrange

at line 1347
RedisCluster|bool|array zrevrangebylex(string $key, string $min, string $max, array|null $options = null)

No description

Parameters

string $key
string $min
string $max
array|null $options

Return Value

RedisCluster|bool|array

See also

Redis::zrevrangebylex

at line 1352
RedisCluster|bool|array zrevrangebyscore(string $key, string $min, string $max, array|null $options = null)

No description

Parameters

string $key
string $min
string $max
array|null $options

Return Value

RedisCluster|bool|array

See also

Redis::zrevrangebyscore

at line 1357
RedisCluster|int|false zrevrank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster|int|false

See also

Redis::zrevrank

at line 1362
RedisCluster|bool|array zscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

Parameters

string $key
null|int|string $iterator
string|null $pattern
int $count

Return Value

RedisCluster|bool|array

See also

Redis::zscan

at line 1367
RedisCluster|float|false zscore(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster|float|false

See also

Redis::zscore

at line 1372
RedisCluster|array|false zmscore(string $key, mixed $member, mixed ...$other_members)

No description

Parameters

string $key
mixed $member
mixed ...$other_members

Return Value

RedisCluster|array|false

See also

https://redis.io/commands/zmscore

at line 1377
RedisCluster|int|false zunionstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)

No description

Parameters

string $dst
array $keys
array|null $weights
string|null $aggregate

Return Value

RedisCluster|int|false

See also

Redis::zunionstore

at line 1382
RedisCluster|array|false zinter(array $keys, array|null $weights = null, array|null $options = null)

No description

Parameters

array $keys
array|null $weights
array|null $options

Return Value

RedisCluster|array|false

See also

https://redis.io/commands/zinter

at line 1387
RedisCluster|int|false zdiffstore(string $dst, array $keys)

No description

Parameters

string $dst
array $keys

Return Value

RedisCluster|int|false

See also

https://redis.io/commands/zdiffstore

at line 1392
RedisCluster|array|false zunion(array $keys, array|null $weights = null, array|null $options = null)

No description

Parameters

array $keys
array|null $weights
array|null $options

Return Value

RedisCluster|array|false

See also

https://redis.io/commands/zunion

at line 1397
RedisCluster|array|false zdiff(array $keys, array|null $options = null)

No description

Parameters

array $keys
array|null $options

Return Value

RedisCluster|array|false

See also

https://redis.io/commands/zdiff

at line 1402
RedisCluster|string|false digest(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string|false

See also

https://redis.io/commands/digest