class RedisCluster (View source)

Constants

OPT_SLAVE_FAILOVER

Used to configure how PhpRedis will fail over to replica nodes when a primary node fails to respond.

FAILOVER_NONE

Never read from replicas.

FAILOVER_ERROR

Attempt to read from replicas when the primary errors out or is down.

FAILOVER_DISTRIBUTE

Distribute read-only commands at random between the primary and replica(s).

FAILOVER_DISTRIBUTE_SLAVES

Distribute read-only commands between the replicas only.

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|false
bitrangeintarray(string $key, int $start, int $end, array|null $options = null)

No description

mixed
bless(string $command, string|int|null $key = null, string|null $directive = null, array|null $options = null, array|string|null $key_or_address = null)

No description

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

No description

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

No description

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

No description

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

Move an element from one list into another.

RedisCluster|array|false
lmovem(string $src, string $dst, string $wherefrom, string $whereto, array|null $options = null)

Move one or more elements from one list to another.

RedisCluster|array|false
blmovem(string $src, string $dst, string $wherefrom, string $whereto, float $timeout, array|null $options = null)

No description

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

bool
reconnect()

Closes all node connections, then reopens all known masters and previously connected replicas, restoring authentication without refreshing topology.

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

Execute Redis CLUSTER subcommands on the specified node.

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)

Send a DECRBYFLOAT command for the given key.

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|int
himport(string $op, string $hash, string|null $fieldset = null, array $fields = [])

Note that unlike \Redis::himport() the hash is required for every operation, as it is what directs the command to the correct node. It is only sent to Redis for the 'SET' operation.

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
increx(string $key, int|float|null $value = null, array|null $options = null)

No description

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

Retrieve information about a cluster node. If no sections are passed, Redis will return the default info fields. 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|int|false
msetex(array $key_vals, int|float|array|null $expiry = null)

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
sunioncard(array $keys, array|null $options = null)

No description

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

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 vector set.

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)

Retrieve a lexicographical 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|array|false
gcra(string $key, int $maxBurst, int $requestsPerPeriod, int $period, int $tokens = 0)

No description

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

No description

RedisCluster|array|false
xackdel(string $key, string $group, array $ids, string|null $mode = null)

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

RedisCluster|array|false
xdelex(string $key, array $ids, string|null $mode = null)

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|array|false
zrevrangebylex(string $key, string $max, string $min, int $offset = -1, int $count = -1)

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

__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

string _compress(string $value)

No description

Parameters

string $value

Return Value

string

See also

Redis::_compress

string _uncompress(string $value)

No description

Parameters

string $value

Return Value

string

See also

Redis::_uncompress

bool|string _serialize(mixed $value)

No description

Parameters

mixed $value

Return Value

bool|string

See also

Redis::_serialize

mixed _unserialize(string $value)

No description

Parameters

string $value

Return Value

mixed

See also

Redis::_unserialize

string _pack(mixed $value)

No description

Parameters

mixed $value

Return Value

string

See also

Redis::_pack

string _digest(mixed $value)

No description

Parameters

mixed $value

Return Value

string

See also

Redis::_digest

mixed _unpack(string $value)

No description

Parameters

string $value

Return Value

mixed

See also

Redis::_unpack

bool|string _prefix(string $key)

No description

Parameters

string $key

Return Value

bool|string

See also

Redis::_prefix

array _masters()

No description

Return Value

array

string|null _redir()

No description

Return Value

string|null

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

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

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|bool|int

See also

Redis::append

RedisCluster|bool bgrewriteaof(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|bool

See also

Redis::bgrewriteaof

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

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

RedisCluster|bool bgsave(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|bool

See also

Redis::bgSave

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

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

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 were 0 and end were 2, Redis would search the first three bits.

Return Value

RedisCluster|int|false

See also

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

RedisCluster|array|false bitrangeintarray(string $key, int $start, int $end, array|null $options = null)

No description

Parameters

string $key
int $start
int $end
array|null $options

Return Value

RedisCluster|array|false

See also

Redis::bitrangeintarray

mixed bless(string $command, string|int|null $key = null, string|null $directive = null, array|null $options = null, array|string|null $key_or_address = null)

No description

Parameters

string $command
string|int|null $key
string|null $directive
array|null $options
array|string|null $key_or_address

Return Value

mixed

See also

Redis::bless SCAN additionally requires `$key_or_address` and stays on the node it selects. SET, CLEAR and GET route by key; `$key_or_address` is only accepted for SCAN.

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

No description

Parameters

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

Return Value

RedisCluster|array|null|false

See also

Redis::blPop

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

No description

Parameters

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

Return Value

RedisCluster|array|null|false

See also

Redis::brPop

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

No description

Parameters

string $srckey
string $deskey
int $timeout

Return Value

mixed

See also

Redis::brpoplpush

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

RedisCluster|array|false lmovem(string $src, string $dst, string $wherefrom, string $whereto, array|null $options = null)

Move one or more elements from one list to another.

Parameters

string $src

The source list

string $dst

The destination list

string $wherefrom

Where in the source list to extract the element.

string $whereto

Where in the destination list to put the element.

array|null $options

An array of options to modify how the command behaves.

Return Value

RedisCluster|array|false

The element(s) removed from the source list.

See also

https://redis.io/docs/latest/commands/lmovem/

Examples

$redis->rPush('{lists}:numbers', 'one', 'two', 'three');
$redis->lMovem('{lists}:numbers', '{lists}:odds', Redis::LEFT, Redis::LEFT, ['COUNT' => [2, 'BULK']]);

RedisCluster|array|false blmovem(string $src, string $dst, string $wherefrom, string $whereto, float $timeout, array|null $options = null)

No description

Parameters

string $src
string $dst
string $wherefrom
string $whereto
float $timeout
array|null $options

Return Value

RedisCluster|array|false

See also

Redis::blmovem

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

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

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

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

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

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

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

bool clearlasterror()

No description

Return Value

bool

See also

Redis::clearLastError

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

bool close()

No description

Return Value

bool

See also

Redis::close

bool reconnect()

Closes all node connections, then reopens all known masters and previously connected replicas, restoring authentication without refreshing topology.

Pending transactions are discarded. Client options are preserved. If reconnection fails, all node connections are closed.

Return Value

bool

Exceptions

RedisClusterException

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

Execute Redis CLUSTER subcommands on the specified node.

Parameters

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

Return Value

mixed

mixed command(mixed ...$extra_args)

No description

Parameters

mixed ...$extra_args

Return Value

mixed

See also

Redis::command

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

RedisCluster|int dbsize(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|int

See also

Redis::dbSize

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

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

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

No description

Parameters

string $key
int $value

Return Value

RedisCluster|int|false

See also

Redis::decrBy

float decrbyfloat(string $key, float $value)

Send a DECRBYFLOAT command for the given key.

Parameters

string $key
float $value

Return Value

float

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

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 DELEX works.

Return Value

RedisCluster|int|false

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

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.

bool discard()

No description

Return Value

bool

See also

Redis::discard

RedisCluster|string|false dump(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string|false

See also

Redis::dump

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

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

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

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

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

array|false exec()

No description

Return Value

array|false

See also

Redis::exec

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

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

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

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

RedisCluster|int|false expiretime(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::expiretime

RedisCluster|int|false pexpiretime(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::pexpiretime

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

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

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

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

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

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

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

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

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

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

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

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

mixed get(string $key)

No description

Parameters

string $key

Return Value

mixed

See also

Redis::get

mixed getdel(string $key)

No description

Parameters

string $key

Return Value

mixed

See also

Redis::getDel

RedisCluster|array|false getWithMeta(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::getWithMeta

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

No description

Parameters

string $key
array $options

Return Value

RedisCluster|string|false

See also

Redis::getEx

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

No description

Parameters

string $key
int $value

Return Value

RedisCluster|int|false

See also

Redis::getBit

string|null getlasterror()

No description

Return Value

string|null

See also

Redis::getLastError

int getmode()

No description

Return Value

int

See also

Redis::getMode

mixed getoption(int $option)

No description

Parameters

int $option

Return Value

mixed

See also

Redis::getOption

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

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

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

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|string|bool

See also

Redis::getset

array|false gettransferredbytes()

No description

Return Value

array|false

See also

Redis::getTransferredBytes

void cleartransferredbytes()

No description

Return Value

void

See also

Redis::clearTransferredBytes

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

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

No description

Parameters

string $key
string $member

Return Value

RedisCluster|bool

See also

Redis::hExists

mixed hget(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

See also

Redis::hGet

RedisCluster|array|false hgetall(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::hGetAll

mixed hgetWithMeta(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

See also

Redis::hGetWithMeta

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

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

RedisCluster|array|false hkeys(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::hKeys

RedisCluster|int|false hlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::hLen

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

No description

Parameters

string $key
array $keys

Return Value

RedisCluster|array|false

See also

Redis::hMget

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

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

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

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hgetdel

RedisCluster|bool|int himport(string $op, string $hash, string|null $fieldset = null, array $fields = [])

Note that unlike \Redis::himport() the hash is required for every operation, as it is what directs the command to the correct node. It is only sent to Redis for the 'SET' operation.

Parameters

string $op
string $hash
string|null $fieldset
array $fields

Return Value

RedisCluster|bool|int

See also

Redis::himport

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

No description

Parameters

string $key
array $key_values

Return Value

RedisCluster|bool

See also

Redis::hMset

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

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

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

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

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

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

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

No description

Parameters

string $key
string $field

Return Value

RedisCluster|int|false

See also

Redis::hStrLen

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

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

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

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

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

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::httl

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

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hpttl

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

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hexpiretime

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

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hpexpiretime

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

No description

Parameters

string $key
array $fields

Return Value

RedisCluster|array|false

See also

Redis::hpersist

RedisCluster|array|false hvals(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::hVals

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

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

No description

Parameters

string $key
int $value

Return Value

RedisCluster|int|false

See also

Redis::incrBy

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

No description

Parameters

string $key
float $value

Return Value

RedisCluster|float|false

See also

Redis::incrByFloat

RedisCluster|array|false increx(string $key, int|float|null $value = null, array|null $options = null)

No description

Parameters

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

Return Value

RedisCluster|array|false

See also

Redis::incrEx

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

Retrieve information about a cluster node. If no sections are passed, Redis will return the default info fields. 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 sections you want the Redis server to return.

Return Value

RedisCluster|array|false

See also

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

RedisCluster|array|false keys(string $pattern)

No description

Parameters

string $pattern

Return Value

RedisCluster|array|false

See also

Redis::keys

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

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

No description

Parameters

string $key
int $index

Return Value

RedisCluster|string|bool

See also

Redis::lindex

mixed lindex(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

mixed

See also

Redis::lindex

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

RedisCluster|int|bool llen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|bool

See also

Redis::lLen

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

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

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

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

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|int|bool

See also

Redis::lPushx

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

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

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

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

RedisCluster|array|false mget(array $keys)

No description

Parameters

array $keys

Return Value

RedisCluster|array|false

See also

Redis::mget

RedisCluster|bool mset(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisCluster|bool

See also

Redis::mset

RedisCluster|array|false msetnx(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisCluster|array|false

See also

Redis::msetnx

RedisCluster|int|false msetex(array $key_vals, int|float|array|null $expiry = null)

No description

Parameters

array $key_vals
int|float|array|null $expiry

Return Value

RedisCluster|int|false

See also

Redis::msetex

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

No description

Parameters

int $value

Return Value

RedisCluster|bool

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

RedisCluster|bool persist(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|bool

See also

Redis::persist

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

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

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

No description

Parameters

string $key
array $elements

Return Value

RedisCluster|bool

See also

Redis::pfadd

RedisCluster|int|false pfcount(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::pfcount

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

No description

Parameters

string $key
array $keys

Return Value

RedisCluster|bool

See also

Redis::pfmerge

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 port, 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

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

void psubscribe(array $patterns, callable $callback)

No description

Parameters

array $patterns
callable $callback

Return Value

void

See also

Redis::psubscribe

RedisCluster|int|false pttl(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::pttl

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

No description

Parameters

string $channel
string $message

Return Value

RedisCluster|bool|int

See also

Redis::publish

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

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

No description

Parameters

string $pattern
string ...$other_patterns

Return Value

bool|array

See also

Redis::punsubscribe

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

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

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

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

No description

Parameters

string $key
string $newkey

Return Value

RedisCluster|bool

See also

Redis::renameNx

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

mixed role(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

mixed

See also

Redis::role

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

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

No description

Parameters

string $src
string $dst

Return Value

RedisCluster|bool|string

See also

Redis::rpoplpush

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

No description

Parameters

string $key
mixed ...$elements

Return Value

RedisCluster|int|false

See also

Redis::rPush

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

No description

Parameters

string $key
string $value

Return Value

RedisCluster|bool|int

See also

Redis::rPushx

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

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

No description

Parameters

string $key
array $values

Return Value

RedisCluster|bool|int

See also

Redis::sAddArray

RedisCluster|bool save(string|array $key_or_address)

No description

Parameters

string|array $key_or_address

Return Value

RedisCluster|bool

See also

Redis::save

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

RedisCluster|int|false scard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::scard

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

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

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

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

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

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

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

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|bool

See also

Redis::setnx

bool setoption(int $option, mixed $value)

No description

Parameters

int $option
mixed $value

Return Value

bool

See also

Redis::setOption

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

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

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

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

No description

Parameters

array $keys
array|null $options

Return Value

RedisCluster|int|false

See also

Redis::sunioncard

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

No description

Parameters

array $keys
array|null $options

Return Value

RedisCluster|int|false

See also

Redis::sdiffcard

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

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

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|bool

See also

Redis::sismember

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

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

RedisCluster|array|false smembers(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::sMembers

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

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

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

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

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

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

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

RedisCluster|int|false strlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::strlen

void subscribe(array $channels, callable $cb)

No description

Parameters

array $channels
callable $cb

Return Value

void

See also

Redis::subscribe

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

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

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

RedisCluster|int|false ttl(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::ttl

RedisCluster|int|false type(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::type

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

bool unwatch()

No description

Return Value

bool

See also

Redis::unwatch

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

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisCluster|bool

See also

Redis::watch

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

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

RedisCluster|int|false vcard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::vcard

RedisCluster|int|false vdim(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::vdim

RedisCluster|array|false vinfo(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|array|false

See also

Redis::vinfo

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

Check if an element is a member of a vector set.

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.

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

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

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

Retrieve a lexicographical 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.

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

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

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

RedisCluster|array|false gcra(string $key, int $maxBurst, int $requestsPerPeriod, int $period, int $tokens = 0)

No description

Parameters

string $key
int $maxBurst
int $requestsPerPeriod
int $period
int $tokens

Return Value

RedisCluster|array|false

See also

Redis::gcra

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

RedisCluster|array|false xackdel(string $key, string $group, array $ids, string|null $mode = null)

No description

Parameters

string $key
string $group
array $ids
string|null $mode

Return Value

RedisCluster|array|false

See also

Redis::xackdel

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

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

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

No description

Parameters

string $key
array $ids

Return Value

RedisCluster|int|false

See also

Redis::xdel

RedisCluster|array|false xdelex(string $key, array $ids, string|null $mode = null)

No description

Parameters

string $key
array $ids
string|null $mode

Return Value

RedisCluster|array|false

See also

Redis::xdelex

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

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

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

RedisCluster|int|false xlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::xlen

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

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

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

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

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

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

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

RedisCluster|int|false zcard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|int|false

See also

Redis::zCard

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

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

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

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

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

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

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

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

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

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

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

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

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

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster|int|false

See also

Redis::zRank

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

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

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

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

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

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

No description

Parameters

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

Return Value

RedisCluster|array|false

See also

Redis::zRevRangeByLex

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

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

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster|int|false

See also

Redis::zRevRank

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

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

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster|float|false

See also

Redis::zScore

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

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

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

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

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

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

RedisCluster|string|false digest(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string|false

See also

https://redis.io/commands/digest