docs/RedisCluster.html
class RedisCluster (View source)
| OPT_SLAVE_FAILOVER |
Used to configure how PhpRedis will failover to replica nodes when a primary node fails to respond.
| | FAILOVER_NONE |
Never read from replicas.
| | FAILOVER_ERROR |
Attempt to read from replicas when the primary errors out or is down.
| | FAILOVER_DISTRIBUTE |
Distribute readonly commands at random between the primary and replica(s).
| | FAILOVER_DISTRIBUTE_SLAVES |
Distribute readonly commands between the replicas only.
|
__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)
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)
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|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
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
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
No description
void
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
Redis|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
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
Relay|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|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
__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|null | $name | | | array|null | $seeds | | | int|float | $timeout | | | int|float | $read_timeout | | | bool | $persistent | | | mixed | $auth | | | array|null | $context | |
string _compress(string $value)| string | $value | |
| string | |
string _uncompress(string $value)No description
| string | $value | |
| string | |
| Redis::_uncompress | |
bool|string _serialize(mixed $value)No description
| mixed | $value | |
| bool|string | |
| Redis::_serialize | |
mixed _unserialize(string $value)No description
| string | $value | |
| mixed | |
| Redis::_unserialize | |
string _pack(mixed $value)No description
| mixed | $value | |
| string | |
| Redis::_pack | |
string _digest(mixed $value)No description
| mixed | $value | |
| string | |
| Redis::_digest | |
mixed _unpack(string $value)No description
| string | $value | |
| mixed | |
| Redis::_unpack | |
bool|string _prefix(string $key)No description
| string | $key | |
| bool|string | |
| Redis::_prefix | |
array _masters()No description
| array | |
string|null _redir()No description
| string|null | |
mixed acl(string|array $key_or_address, string $subcmd, string ...$args)No description
| string|array | $key_or_address | | | string | $subcmd | | | string | ...$args | |
| mixed | |
| Redis::acl | |
RedisCluster|bool|int append(string $key, mixed $value)No description
| string | $key | | | mixed | $value | |
| RedisCluster|bool|int | |
| Redis::append | |
RedisCluster|bool bgrewriteaof(string|array $key_or_address)No description
| string|array | $key_or_address | |
| RedisCluster|bool | |
| Redis::bgrewriteaof | |
RedisCluster|int|false wait(string|array $key_or_address, int $numreplicas, int $timeout)No description
| string|array | $key_or_address | | | int | $numreplicas | | | int | $timeout | |
| RedisCluster|int|false | |
| Redis::wait | |
RedisCluster|array|false waitaof(string|array $key_or_address, int $numlocal, int $numreplicas, int $timeout)No description
| string|array | $key_or_address | | | int | $numlocal | | | int | $numreplicas | | | int | $timeout | |
| RedisCluster|array|false | |
| Redis::waitaof | |
RedisCluster|bool bgsave(string|array $key_or_address)No description
| string|array | $key_or_address | |
| RedisCluster|bool | |
| Redis::bgSave | |
RedisCluster|bool|int bitcount(string $key, int $start = 0, int $end = -1, bool $bybit = false)No description
| string | $key | | | int | $start | | | int | $end | | | bool | $bybit | |
| RedisCluster|bool|int | |
| Redis::bitcount | |
RedisCluster|bool|int bitop(string $operation, string $deskey, string $srckey, string ...$otherkeys)No description
| string | $operation | | | string | $deskey | | | string | $srckey | | | string | ...$otherkeys | |
| RedisCluster|bool|int | |
| 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.
| 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.
|
| RedisCluster|int|false | |
| https://https://redis.io/commands/bitpos/ | |
RedisCluster|array|null|false blpop(string|array $key, string|float|int $timeout_or_key, mixed ...$extra_args)No description
| string|array | $key | | | string|float|int | $timeout_or_key | | | mixed | ...$extra_args | |
| RedisCluster|array|null|false | |
| Redis::blPop | |
RedisCluster|array|null|false brpop(string|array $key, string|float|int $timeout_or_key, mixed ...$extra_args)No description
| string|array | $key | | | string|float|int | $timeout_or_key | | | mixed | ...$extra_args | |
| RedisCluster|array|null|false | |
| Redis::brPop | |
mixed brpoplpush(string $srckey, string $deskey, int $timeout)No description
| string | $srckey | | | string | $deskey | | | int | $timeout | |
| mixed | |
| Redis::brpoplpush | |
RedisCluster|string|false lmove(string $src, string $dst, string $wherefrom, string $whereto)Move an element from one list into another.
| string | $src | | | string | $dst | | | string | $wherefrom | | | string | $whereto | |
| RedisCluster|string|false | |
| Redis::lMove | |
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.
| string | $src | | | string | $dst | | | string | $wherefrom | | | string | $whereto | | | float | $timeout | |
| RedisCluster|string|false | |
| Redis::blmove | |
array bzpopmax(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)No description
| string|array | $key | | | string|int | $timeout_or_key | | | mixed | ...$extra_args | |
| array | |
| Redis::bzPopMax | |
array bzpopmin(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)No description
| string|array | $key | | | string|int | $timeout_or_key | | | mixed | ...$extra_args | |
| array | |
| Redis::bzPopMin | |
RedisCluster|array|null|false bzmpop(float $timeout, array $keys, string $from, int $count = 1)No description
| float | $timeout | | | array | $keys | | | string | $from | | | int | $count | |
| RedisCluster|array|null|false | |
| Redis::bzmpop | |
RedisCluster|array|null|false zmpop(array $keys, string $from, int $count = 1)No description
| array | $keys | | | string | $from | | | int | $count | |
| RedisCluster|array|null|false | |
| Redis::zmpop | |
RedisCluster|array|null|false blmpop(float $timeout, array $keys, string $from, int $count = 1)No description
| float | $timeout | | | array | $keys | | | string | $from | | | int | $count | |
| RedisCluster|array|null|false | |
| Redis::blmpop | |
RedisCluster|array|null|false lmpop(array $keys, string $from, int $count = 1)No description
| array | $keys | | | string | $from | | | int | $count | |
| RedisCluster|array|null|false | |
| Redis::lmpop | |
bool clearlasterror()No description
| bool | |
| Redis::clearLastError | |
array|string|bool client(string|array $key_or_address, string $subcommand, string|null $arg = null)No description
| string|array | $key_or_address | | | string | $subcommand | | | string|null | $arg | |
| array|string|bool | |
| Redis::client | |
bool close()No description
| bool | |
| Redis::close | |
mixed cluster(string|array $key_or_address, string $command, mixed ...$extra_args)No description
| string|array | $key_or_address | | | string | $command | | | mixed | ...$extra_args | |
| mixed | |
| \Redis::cluster() | |
mixed command(mixed ...$extra_args)No description
| mixed | ...$extra_args | |
| mixed | |
| Redis::command | |
mixed config(string|array $key_or_address, string $subcommand, mixed ...$extra_args)No description
| string|array | $key_or_address | | | string | $subcommand | | | mixed | ...$extra_args | |
| mixed | |
| Redis::config | |
RedisCluster|int dbsize(string|array $key_or_address)No description
| string|array | $key_or_address | |
| RedisCluster|int | |
| Redis::dbSize | |
RedisCluster|bool copy(string $src, string $dst, array|null $options = null)No description
| string | $src | | | string | $dst | | | array|null | $options | |
| RedisCluster|bool | |
| https://redis.io/commands/copy | |
RedisCluster|int|false decr(string $key, int $by = 1)No description
| string | $key | | | int | $by | |
| RedisCluster|int|false | |
| Redis::decr | |
RedisCluster|int|false decrby(string $key, int $value)No description
| string | $key | | | int | $value | |
| RedisCluster|int|false | |
| Redis::decrBy | |
float decrbyfloat(string $key, float $value)No description
| string | $key | | | float | $value | |
| float | |
| \Redis::decrbyfloat() | |
RedisCluster|int|false del(array|string $key, string ...$other_keys)No description
| array|string | $key | | | string | ...$other_keys | |
| RedisCluster|int|false | |
| Redis::del | |
RedisCluster|int|false delex(string $key, array|null $options = null)Delete a key conditionally based on its value or hash digest
| string | $key |
The key to delete
| | array|null | $options |
An array with options to modify how DELX works.
|
| 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
| string | $key |
The key to delete
| | mixed | $value |
The value to compare against the key's value.
|
| RedisCluster|int|false |
Returns 1 if the key was deleted, 0 if it was not.
|
bool discard()No description
| bool | |
| Redis::discard | |
RedisCluster|string|false dump(string $key)No description
| string | $key | |
| RedisCluster|string|false | |
| Redis::dump | |
RedisCluster|string|false echo(string|array $key_or_address, string $msg)No description
| string|array | $key_or_address | | | string | $msg | |
| RedisCluster|string|false | |
| Redis::echo | |
mixed eval(string $script, array $args = [], int $num_keys = 0)No description
| string | $script | | | array | $args | | | int | $num_keys | |
| mixed | |
| Redis::eval | |
mixed eval_ro(string $script, array $args = [], int $num_keys = 0)No description
| string | $script | | | array | $args | | | int | $num_keys | |
| mixed | |
| Redis::eval_ro | |
mixed evalsha(string $script_sha, array $args = [], int $num_keys = 0)No description
| string | $script_sha | | | array | $args | | | int | $num_keys | |
| mixed | |
| Redis::evalsha | |
mixed evalsha_ro(string $script_sha, array $args = [], int $num_keys = 0)No description
| string | $script_sha | | | array | $args | | | int | $num_keys | |
| mixed | |
| Redis::evalsha_ro | |
array|false exec()No description
| array|false | |
| Redis::exec | |
RedisCluster|int|bool exists(mixed $key, mixed ...$other_keys)No description
| mixed | $key | | | mixed | ...$other_keys | |
| RedisCluster|int|bool | |
| Redis::exists | |
RedisCluster|int|bool touch(mixed $key, mixed ...$other_keys)No description
| mixed | $key | | | mixed | ...$other_keys | |
| RedisCluster|int|bool | |
| Redis::touch | |
RedisCluster|bool expire(string $key, int $timeout, string|null $mode = null)No description
| string | $key | | | int | $timeout | | | string|null | $mode | |
| RedisCluster|bool | |
| Redis::expire | |
RedisCluster|bool expireat(string $key, int $timestamp, string|null $mode = null)No description
| string | $key | | | int | $timestamp | | | string|null | $mode | |
| RedisCluster|bool | |
| Redis::expireAt | |
RedisCluster|int|false expiretime(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::expiretime | |
RedisCluster|int|false pexpiretime(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::pexpiretime | |
RedisCluster|bool flushall(string|array $key_or_address, bool $async = false)No description
| string|array | $key_or_address | | | bool | $async | |
| RedisCluster|bool | |
| Redis::flushAll | |
RedisCluster|bool flushdb(string|array $key_or_address, bool $async = false)No description
| string|array | $key_or_address | | | bool | $async | |
| RedisCluster|bool | |
| Redis::flushDB | |
RedisCluster|int|false geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples_and_options)No description
| string | $key | | | float | $lng | | | float | $lat | | | string | $member | | | mixed | ...$other_triples_and_options | |
| RedisCluster|int|false | |
| Redis::geoadd | |
RedisCluster|float|false geodist(string $key, string $src, string $dest, string|null $unit = null)No description
| string | $key | | | string | $src | | | string | $dest | | | string|null | $unit | |
| RedisCluster|float|false | |
| Redis::geodist | |
RedisCluster|array|false geohash(string $key, string $member, string ...$other_members)No description
| string | $key | | | string | $member | | | string | ...$other_members | |
| RedisCluster|array|false | |
| Redis::geohash | |
RedisCluster|array|false geopos(string $key, string $member, string ...$other_members)No description
| string | $key | | | string | $member | | | string | ...$other_members | |
| RedisCluster|array|false | |
| Redis::geopos | |
mixed georadius(string $key, float $lng, float $lat, float $radius, string $unit, array $options = [])No description
| string | $key | | | float | $lng | | | float | $lat | | | float | $radius | | | string | $unit | | | array | $options | |
| mixed | |
| Redis::georadius | |
mixed georadius_ro(string $key, float $lng, float $lat, float $radius, string $unit, array $options = [])No description
| string | $key | | | float | $lng | | | float | $lat | | | float | $radius | | | string | $unit | | | array | $options | |
| mixed | |
| Redis::georadius_ro | |
mixed georadiusbymember(string $key, string $member, float $radius, string $unit, array $options = [])No description
| string | $key | | | string | $member | | | float | $radius | | | string | $unit | | | array | $options | |
| mixed | |
| Redis::georadiusbymember | |
mixed georadiusbymember_ro(string $key, string $member, float $radius, string $unit, array $options = [])No description
| string | $key | | | string | $member | | | float | $radius | | | string | $unit | | | array | $options | |
| mixed | |
| Redis::georadiusbymember_ro | |
RedisCluster|array geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = [])No description
| string | $key | | | array|string | $position | | | array|int|float | $shape | | | string | $unit | | | array | $options | |
| RedisCluster|array | |
| 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
| string | $dst | | | string | $src | | | array|string | $position | | | array|int|float | $shape | | | string | $unit | | | array | $options | |
| RedisCluster|array|int|false | |
| https://redis.io/commands/geosearchstore | |
mixed get(string $key)No description
| string | $key | |
| mixed | |
| Redis::get | |
mixed getdel(string $key)No description
| string | $key | |
| mixed | |
| Redis::getDel | |
RedisCluster|array|false getWithMeta(string $key)No description
| string | $key | |
| RedisCluster|array|false | |
| Redis::getWithMeta | |
RedisCluster|string|false getex(string $key, array $options = [])No description
| string | $key | | | array | $options | |
| RedisCluster|string|false | |
| Redis::getEx | |
RedisCluster|int|false getbit(string $key, int $value)No description
| string | $key | | | int | $value | |
| RedisCluster|int|false | |
| Redis::getBit | |
string|null getlasterror()No description
| string|null | |
| Redis::getLastError | |
int getmode()No description
| int | |
| Redis::getMode | |
mixed getoption(int $option)No description
| int | $option | |
| mixed | |
| Redis::getOption | |
RedisCluster|string|false getrange(string $key, int $start, int $end)No description
| string | $key | | | int | $start | | | int | $end | |
| RedisCluster|string|false | |
| Redis::getRange | |
RedisCluster|string|array|int|false lcs(string $key1, string $key2, array|null $options = null)No description
| string | $key1 | | | string | $key2 | | | array|null | $options | |
| RedisCluster|string|array|int|false | |
| Redis::lcs | |
RedisCluster|string|bool getset(string $key, mixed $value)No description
| string | $key | | | mixed | $value | |
| RedisCluster|string|bool | |
| Redis::getset | |
array|false gettransferredbytes()No description
| array|false | |
| Redis::getTransferredBytes | |
void cleartransferredbytes()No description
| void | |
| Redis::clearTransferredBytes | |
RedisCluster|int|false hdel(string $key, string $member, string ...$other_members)No description
| string | $key | | | string | $member | | | string | ...$other_members | |
| RedisCluster|int|false | |
| Redis::hDel | |
RedisCluster|bool hexists(string $key, string $member)No description
| string | $key | | | string | $member | |
| RedisCluster|bool | |
| Redis::hExists | |
mixed hget(string $key, string $member)No description
| string | $key | | | string | $member | |
| mixed | |
| Redis::hGet | |
RedisCluster|array|false hgetall(string $key)No description
| string | $key | |
| RedisCluster|array|false | |
| Redis::hGetAll | |
mixed hgetWithMeta(string $key, string $member)No description
| string | $key | | | string | $member | |
| mixed | |
| Redis::hGetWithMeta | |
RedisCluster|int|false hincrby(string $key, string $member, int $value)No description
| string | $key | | | string | $member | | | int | $value | |
| RedisCluster|int|false | |
| Redis::hIncrBy | |
RedisCluster|float|false hincrbyfloat(string $key, string $member, float $value)No description
| string | $key | | | string | $member | | | float | $value | |
| RedisCluster|float|false | |
| Redis::hIncrByFloat | |
RedisCluster|array|false hkeys(string $key)No description
| string | $key | |
| RedisCluster|array|false | |
| Redis::hKeys | |
RedisCluster|int|false hlen(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::hLen | |
RedisCluster|array|false hmget(string $key, array $keys)No description
| string | $key | | | array | $keys | |
| RedisCluster|array|false | |
| Redis::hMget | |
RedisCluster|array|false hgetex(string $key, array $fields, string|array|null $expiry = null)No description
| string | $key | | | array | $fields | | | string|array|null | $expiry | |
| RedisCluster|array|false | |
| Redis::hgetex | |
RedisCluster|int|false hsetex(string $key, array $fields, array|null $expiry = null)No description
| string | $key | | | array | $fields | | | array|null | $expiry | |
| RedisCluster|int|false | |
| Redis::hsetex | |
RedisCluster|array|false hgetdel(string $key, array $fields)No description
| string | $key | | | array | $fields | |
| RedisCluster|array|false | |
| Redis::hgetdel | |
RedisCluster|bool hmset(string $key, array $key_values)No description
| string | $key | | | array | $key_values | |
| RedisCluster|bool | |
| Redis::hMset | |
array|bool hscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)No description
| string | $key | | | null|int|string | $iterator | | | string|null | $pattern | | | int | $count | |
| array|bool | |
| Redis::hscan | |
RedisCluster|int|false expiremember(string $key, string $field, int $ttl, string|null $unit = null)No description
| string | $key | | | string | $field | | | int | $ttl | | | string|null | $unit | |
| RedisCluster|int|false | |
| Redis::expiremember | |
RedisCluster|int|false expirememberat(string $key, string $field, int $timestamp)No description
| string | $key | | | string | $field | | | int | $timestamp | |
| RedisCluster|int|false | |
| Redis::expirememberat | |
RedisCluster|string|array hrandfield(string $key, array|null $options = null)No description
| string | $key | | | array|null | $options | |
| RedisCluster|string|array | |
| https://redis.io/commands/hrandfield | |
RedisCluster|int|false hset(string $key, string $member, mixed $value)No description
| string | $key | | | string | $member | | | mixed | $value | |
| RedisCluster|int|false | |
| Redis::hSet | |
RedisCluster|bool hsetnx(string $key, string $member, mixed $value)No description
| string | $key | | | string | $member | | | mixed | $value | |
| RedisCluster|bool | |
| Redis::hSetNx | |
RedisCluster|int|false hstrlen(string $key, string $field)No description
| string | $key | | | string | $field | |
| RedisCluster|int|false | |
| Redis::hStrLen | |
RedisCluster|array|false hexpire(string $key, int $ttl, array $fields, string|null $mode = NULL)No description
| string | $key | | | int | $ttl | | | array | $fields | | | string|null | $mode | |
| RedisCluster|array|false | |
| Redis::hexpire | |
RedisCluster|array|false hpexpire(string $key, int $ttl, array $fields, string|null $mode = NULL)No description
| string | $key | | | int | $ttl | | | array | $fields | | | string|null | $mode | |
| RedisCluster|array|false | |
| Redis::hpexpire | |
RedisCluster|array|false hexpireat(string $key, int $time, array $fields, string|null $mode = NULL)No description
| string | $key | | | int | $time | | | array | $fields | | | string|null | $mode | |
| RedisCluster|array|false | |
| Redis::hexpireat | |
RedisCluster|array|false hpexpireat(string $key, int $mstime, array $fields, string|null $mode = NULL)No description
| string | $key | | | int | $mstime | | | array | $fields | | | string|null | $mode | |
| RedisCluster|array|false | |
| Redis::hpexpireat | |
RedisCluster|array|false httl(string $key, array $fields)No description
| string | $key | | | array | $fields | |
| RedisCluster|array|false | |
| Redis::httl | |
RedisCluster|array|false hpttl(string $key, array $fields)No description
| string | $key | | | array | $fields | |
| RedisCluster|array|false | |
| Redis::hpttl | |
RedisCluster|array|false hexpiretime(string $key, array $fields)No description
| string | $key | | | array | $fields | |
| RedisCluster|array|false | |
| Redis::hexpiretime | |
RedisCluster|array|false hpexpiretime(string $key, array $fields)No description
| string | $key | | | array | $fields | |
| RedisCluster|array|false | |
| Redis::hpexpiretime | |
RedisCluster|array|false hpersist(string $key, array $fields)No description
| string | $key | | | array | $fields | |
| RedisCluster|array|false | |
| Redis::hpexpiretime | |
RedisCluster|array|false hvals(string $key)No description
| string | $key | |
| RedisCluster|array|false | |
| Redis::hVals | |
RedisCluster|int|false incr(string $key, int $by = 1)No description
| string | $key | | | int | $by | |
| RedisCluster|int|false | |
| Redis::incr | |
RedisCluster|int|false incrby(string $key, int $value)No description
| string | $key | | | int | $value | |
| RedisCluster|int|false | |
| Redis::incrBy | |
RedisCluster|float|false incrbyfloat(string $key, float $value)No description
| string | $key | | | float | $value | |
| RedisCluster|float|false | |
| Redis::incrByFloat | |
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.
| 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.
|
| RedisCluster|array|false | |
| https://redis.io/commands/info/ | |
RedisCluster|array|false keys(string $pattern)No description
| string | $pattern | |
| RedisCluster|array|false | |
| Redis::keys | |
RedisCluster|int|false lastsave(string|array $key_or_address)No description
| string|array | $key_or_address | |
| RedisCluster|int|false | |
| Redis::lastSave | |
RedisCluster|string|bool lget(string $key, int $index)No description
| string | $key | | | int | $index | |
| RedisCluster|string|bool | |
| \Redis::lget() | |
mixed lindex(string $key, int $index)No description
| string | $key | | | int | $index | |
| mixed | |
| Redis::lindex | |
RedisCluster|int|false linsert(string $key, string $pos, mixed $pivot, mixed $value)No description
| string | $key | | | string | $pos | | | mixed | $pivot | | | mixed | $value | |
| RedisCluster|int|false | |
| Redis::lInsert | |
RedisCluster|int|bool llen(string $key)No description
| string | $key | |
| RedisCluster|int|bool | |
| Redis::lLen | |
RedisCluster|bool|string|array lpop(string $key, int $count = 0)No description
| string | $key | | | int | $count | |
| RedisCluster|bool|string|array | |
| Redis::lPop | |
RedisCluster|null|bool|int|array lpos(string $key, mixed $value, array|null $options = null)No description
| string | $key | | | mixed | $value | | | array|null | $options | |
| RedisCluster|null|bool|int|array | |
| Redis::lPos | |
RedisCluster|int|bool lpush(string $key, mixed $value, mixed ...$other_values)No description
| string | $key | | | mixed | $value | | | mixed | ...$other_values | |
| RedisCluster|int|bool | |
| Redis::lPush | |
RedisCluster|int|bool lpushx(string $key, mixed $value)No description
| string | $key | | | mixed | $value | |
| RedisCluster|int|bool | |
| Redis::lPushx | |
RedisCluster|array|false lrange(string $key, int $start, int $end)No description
| string | $key | | | int | $start | | | int | $end | |
| RedisCluster|array|false | |
| Redis::lrange | |
RedisCluster|int|bool lrem(string $key, mixed $value, int $count = 0)No description
| string | $key | | | mixed | $value | | | int | $count | |
| RedisCluster|int|bool | |
| Redis::lrem | |
RedisCluster|bool lset(string $key, int $index, mixed $value)No description
| string | $key | | | int | $index | | | mixed | $value | |
| RedisCluster|bool | |
| Redis::lSet | |
RedisCluster|bool ltrim(string $key, int $start, int $end)No description
| string | $key | | | int | $start | | | int | $end | |
| RedisCluster|bool | |
| Redis::ltrim | |
RedisCluster|array|false mget(array $keys)No description
| array | $keys | |
| RedisCluster|array|false | |
| Redis::mget | |
RedisCluster|bool mset(array $key_values)No description
| array | $key_values | |
| RedisCluster|bool | |
| Redis::mset | |
RedisCluster|array|false msetnx(array $key_values)No description
| array | $key_values | |
| RedisCluster|array|false | |
| Redis::msetnx | |
Redis|int|false msetex(array $key_vals, int|float|array|null $expiry = null)No description
| array | $key_vals | | | int|float|array|null | $expiry | |
| Redis|int|false | |
| Redis::msetex | |
RedisCluster|bool multi(int $value = Redis::MULTI)No description
| int | $value | |
| RedisCluster|bool | |
RedisCluster|int|string|false object(string $subcommand, string $key)No description
| string | $subcommand | | | string | $key | |
| RedisCluster|int|string|false | |
| Redis::object | |
RedisCluster|bool persist(string $key)No description
| string | $key | |
| RedisCluster|bool | |
| Redis::persist | |
RedisCluster|bool pexpire(string $key, int $timeout, string|null $mode = null)No description
| string | $key | | | int | $timeout | | | string|null | $mode | |
| RedisCluster|bool | |
| Redis::pexpire | |
RedisCluster|bool pexpireat(string $key, int $timestamp, string|null $mode = null)No description
| string | $key | | | int | $timestamp | | | string|null | $mode | |
| RedisCluster|bool | |
| Redis::pexpireAt | |
RedisCluster|bool pfadd(string $key, array $elements)No description
| string | $key | | | array | $elements | |
| RedisCluster|bool | |
| Redis::pfadd | |
RedisCluster|int|false pfcount(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::pfcount | |
RedisCluster|bool pfmerge(string $key, array $keys)No description
| string | $key | | | array | $keys | |
| RedisCluster|bool | |
| Redis::pfmerge | |
mixed ping(string|array $key_or_address, string|null $message = null)PING an instance in the redis cluster.
| 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.
|
| mixed |
This method always returns true if no message was sent, and the message itself if one was.
|
| Redis::ping | |
RedisCluster|bool psetex(string $key, int $timeout, string $value)No description
| string | $key | | | int | $timeout | | | string | $value | |
| RedisCluster|bool | |
| Redis::psetex | |
void psubscribe(array $patterns, callable $callback)No description
| array | $patterns | | | callable | $callback | |
| void | |
| Redis::psubscribe | |
RedisCluster|int|false pttl(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::pttl | |
RedisCluster|bool|int publish(string $channel, string $message)No description
| string | $channel | | | string | $message | |
| RedisCluster|bool|int | |
| Redis::publish | |
mixed pubsub(string|array $key_or_address, string ...$values)No description
| string|array | $key_or_address | | | string | ...$values | |
| mixed | |
| Redis::pubsub | |
bool|array punsubscribe(string $pattern, string ...$other_patterns)No description
| string | $pattern | | | string | ...$other_patterns | |
| bool|array | |
| Redis::punsubscribe | |
RedisCluster|bool|string randomkey(string|array $key_or_address)No description
| string|array | $key_or_address | |
| RedisCluster|bool|string | |
| Redis::randomKey | |
mixed rawcommand(string|array $key_or_address, string $command, mixed ...$args)No description
| string|array | $key_or_address | | | string | $command | | | mixed | ...$args | |
| mixed | |
| Redis::rawcommand | |
RedisCluster|bool rename(string $key_src, string $key_dst)No description
| string | $key_src | | | string | $key_dst | |
| RedisCluster|bool | |
| Redis::rename | |
RedisCluster|bool renamenx(string $key, string $newkey)No description
| string | $key | | | string | $newkey | |
| RedisCluster|bool | |
| Redis::renameNx | |
RedisCluster|bool restore(string $key, int $timeout, string $value, array|null $options = null)No description
| string | $key | | | int | $timeout | | | string | $value | | | array|null | $options | |
| RedisCluster|bool | |
| Redis::restore | |
mixed role(string|array $key_or_address)No description
| string|array | $key_or_address | |
| mixed | |
| Redis::role | |
RedisCluster|bool|string|array rpop(string $key, int $count = 0)No description
| string | $key | | | int | $count | |
| RedisCluster|bool|string|array | |
| Redis::rPop | |
RedisCluster|bool|string rpoplpush(string $src, string $dst)No description
| string | $src | | | string | $dst | |
| RedisCluster|bool|string | |
| Redis::rpoplpush | |
RedisCluster|int|false rpush(string $key, mixed ...$elements)No description
| string | $key | | | mixed | ...$elements | |
| RedisCluster|int|false | |
| Redis::rPush | |
RedisCluster|bool|int rpushx(string $key, string $value)No description
| string | $key | | | string | $value | |
| RedisCluster|bool|int | |
| Redis::rPushx | |
RedisCluster|int|false sadd(string $key, mixed $value, mixed ...$other_values)No description
| string | $key | | | mixed | $value | | | mixed | ...$other_values | |
| RedisCluster|int|false | |
| Redis::sAdd | |
RedisCluster|bool|int saddarray(string $key, array $values)No description
| string | $key | | | array | $values | |
| RedisCluster|bool|int | |
| Redis::sAddArray | |
RedisCluster|bool save(string|array $key_or_address)No description
| string|array | $key_or_address | |
| RedisCluster|bool | |
| Redis::save | |
bool|array scan(null|int|string $iterator, string|array $key_or_address, string|null $pattern = null, int $count = 0)No description
| null|int|string | $iterator | | | string|array | $key_or_address | | | string|null | $pattern | | | int | $count | |
| bool|array | |
| Redis::scan | |
RedisCluster|int|false scard(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::scard | |
mixed script(string|array $key_or_address, mixed ...$args)No description
| string|array | $key_or_address | | | mixed | ...$args | |
| mixed | |
| Redis::script | |
RedisCluster|array|false sdiff(string $key, string ...$other_keys)No description
| string | $key | | | string | ...$other_keys | |
| RedisCluster|array|false | |
| Redis::sDiff | |
RedisCluster|int|false sdiffstore(string $dst, string $key, string ...$other_keys)No description
| string | $dst | | | string | $key | | | string | ...$other_keys | |
| RedisCluster|int|false | |
| Redis::sDiffStore | |
RedisCluster|string|bool set(string $key, mixed $value, mixed $options = null)No description
| string | $key | | | mixed | $value | | | mixed | $options | |
| RedisCluster|string|bool | |
| https://redis.io/commands/set | |
RedisCluster|int|false setbit(string $key, int $offset, bool $onoff)No description
| string | $key | | | int | $offset | | | bool | $onoff | |
| RedisCluster|int|false | |
| Redis::setBit | |
RedisCluster|bool setex(string $key, int $expire, mixed $value)No description
| string | $key | | | int | $expire | | | mixed | $value | |
| RedisCluster|bool | |
| Redis::setex | |
RedisCluster|bool setnx(string $key, mixed $value)No description
| string | $key | | | mixed | $value | |
| RedisCluster|bool | |
| Redis::setnx | |
bool setoption(int $option, mixed $value)No description
| int | $option | | | mixed | $value | |
| bool | |
| Redis::setOption | |
RedisCluster|int|false setrange(string $key, int $offset, string $value)No description
| string | $key | | | int | $offset | | | string | $value | |
| RedisCluster|int|false | |
| Redis::setRange | |
RedisCluster|array|false sinter(array|string $key, string ...$other_keys)No description
| array|string | $key | | | string | ...$other_keys | |
| RedisCluster|array|false | |
| Redis::sInter | |
RedisCluster|int|false sintercard(array $keys, int $limit = -1)No description
| array | $keys | | | int | $limit | |
| RedisCluster|int|false | |
| Redis::sintercard | |
RedisCluster|int|false sinterstore(array|string $key, string ...$other_keys)No description
| array|string | $key | | | string | ...$other_keys | |
| RedisCluster|int|false | |
| Redis::sInterStore | |
RedisCluster|bool sismember(string $key, mixed $value)No description
| string | $key | | | mixed | $value | |
| RedisCluster|bool | |
| Redis::sismember | |
RedisCluster|array|false smismember(string $key, string $member, string ...$other_members)No description
| string | $key | | | string | $member | | | string | ...$other_members | |
| RedisCluster|array|false | |
| Redis::sMisMember | |
mixed slowlog(string|array $key_or_address, mixed ...$args)No description
| string|array | $key_or_address | | | mixed | ...$args | |
| mixed | |
| Redis::slowlog | |
RedisCluster|array|false smembers(string $key)No description
| string | $key | |
| RedisCluster|array|false | |
| Redis::sMembers | |
RedisCluster|bool smove(string $src, string $dst, string $member)No description
| string | $src | | | string | $dst | | | string | $member | |
| RedisCluster|bool | |
| Redis::sMove | |
RedisCluster|array|bool|int|string sort(string $key, array|null $options = null)No description
| string | $key | | | array|null | $options | |
| RedisCluster|array|bool|int|string | |
| Redis::sort | |
RedisCluster|array|bool|int|string sort_ro(string $key, array|null $options = null)No description
| string | $key | | | array|null | $options | |
| RedisCluster|array|bool|int|string | |
| Redis::sort_ro | |
RedisCluster|string|array|false spop(string $key, int $count = 0)No description
| string | $key | | | int | $count | |
| RedisCluster|string|array|false | |
| Redis::sPop | |
RedisCluster|string|array|false srandmember(string $key, int $count = 0)No description
| string | $key | | | int | $count | |
| RedisCluster|string|array|false | |
| Redis::sRandMember | |
RedisCluster|int|false srem(string $key, mixed $value, mixed ...$other_values)No description
| string | $key | | | mixed | $value | | | mixed | ...$other_values | |
| RedisCluster|int|false | |
| Redis::srem | |
array|false sscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)No description
| string | $key | | | null|int|string | $iterator | | | string|null | $pattern | | | int | $count | |
| array|false | |
| Redis::sscan | |
RedisCluster|int|false strlen(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::strlen | |
void subscribe(array $channels, callable $cb)No description
| array | $channels | | | callable | $cb | |
| void | |
| Redis::subscribe | |
RedisCluster|bool|array sunion(string $key, string ...$other_keys)No description
| string | $key | | | string | ...$other_keys | |
| RedisCluster|bool|array | |
| Redis::sUnion | |
RedisCluster|int|false sunionstore(string $dst, string $key, string ...$other_keys)No description
| string | $dst | | | string | $key | | | string | ...$other_keys | |
| RedisCluster|int|false | |
| Redis::sUnionStore | |
RedisCluster|bool|array time(string|array $key_or_address)No description
| string|array | $key_or_address | |
| RedisCluster|bool|array | |
| Redis::time | |
RedisCluster|int|false ttl(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::ttl | |
RedisCluster|int|false type(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::type | |
bool|array unsubscribe(array $channels)No description
| array | $channels | |
| bool|array | |
| Redis::unsubscribe | |
RedisCluster|int|false unlink(array|string $key, string ...$other_keys)No description
| array|string | $key | | | string | ...$other_keys | |
| RedisCluster|int|false | |
| Redis::unlink | |
bool unwatch()No description
| bool | |
| Redis::unwatch | |
RedisCluster|bool watch(string $key, string ...$other_keys)No description
| string | $key | | | string | ...$other_keys | |
| RedisCluster|bool | |
| Redis::watch | |
RedisCluster|int|false vadd(string $key, array $values, mixed $element, array|null $options = null)No description
| string | $key | | | array | $values | | | mixed | $element | | | array|null | $options | |
| RedisCluster|int|false | |
| Redis::vadd | |
RedisCluster|array|false vsim(string $key, mixed $member, array|null $options = null)No description
| string | $key | | | mixed | $member | | | array|null | $options | |
| RedisCluster|array|false | |
| Redis::vsim | |
RedisCluster|int|false vcard(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::vcard | |
RedisCluster|int|false vdim(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::vdim | |
RedisCluster|array|false vinfo(string $key)No description
| string | $key | |
| RedisCluster|array|false | |
| Redis::vinfo | |
RedisCluster|bool vismember(string $key, mixed $member)Check if an element is a member of a vectorset
| string | $key |
The vector set to query.
| | mixed | $member |
The member to check for.
|
| 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
| string | $key | | | mixed | $member | | | bool | $raw | |
| RedisCluster|array|false | |
| Redis::vemb | |
RedisCluster|array|string|false vrandmember(string $key, int $count = 0)No description
| string | $key | | | int | $count | |
| RedisCluster|array|string|false | |
| Redis::vrandmember | |
RedisCluster|array|false vrange(string $key, string $min, string $max, int $count = -1)Retreive a lexographical range of elements from a vector set
| 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.
|
| RedisCluster|array|false |
An array of elements in the specified range.`
|
RedisCluster|int|false vrem(string $key, mixed $member)No description
| string | $key | | | mixed | $member | |
| RedisCluster|int|false | |
| Redis::vrem | |
RedisCluster|array|false vlinks(string $key, mixed $member, bool $withscores = false)No description
| string | $key | | | mixed | $member | | | bool | $withscores | |
| RedisCluster|array|false | |
| Redis::vlinks | |
RedisCluster|array|string|false vgetattr(string $key, mixed $member, bool $decode = true)No description
| string | $key | | | mixed | $member | | | bool | $decode | |
| RedisCluster|array|string|false | |
| Redis::vgetattr | |
RedisCluster|int|false vsetattr(string $key, mixed $member, array|string $attributes)No description
| string | $key | | | mixed | $member | | | array|string | $attributes | |
| RedisCluster|int|false | |
| Redis::vsetattr | |
RedisCluster|int|false xack(string $key, string $group, array $ids)No description
| string | $key | | | string | $group | | | array | $ids | |
| RedisCluster|int|false | |
| Redis::xack | |
RedisCluster|string|false xadd(string $key, string $id, array $values, int $maxlen = 0, bool $approx = false)No description
| string | $key | | | string | $id | | | array | $values | | | int | $maxlen | | | bool | $approx | |
| RedisCluster|string|false | |
| Redis::xadd | |
RedisCluster|string|array|false xclaim(string $key, string $group, string $consumer, int $min_iddle, array $ids, array $options)No description
| string | $key | | | string | $group | | | string | $consumer | | | int | $min_iddle | | | array | $ids | | | array | $options | |
| RedisCluster|string|array|false | |
| Redis::xclaim | |
RedisCluster|int|false xdel(string $key, array $ids)No description
| string | $key | | | array | $ids | |
| RedisCluster|int|false | |
| Redis::xdel | |
Relay|array|false xdelex(string $key, array $ids, string|null $mode = null)No description
| string | $key | | | array | $ids | | | string|null | $mode | |
| Relay|array|false | |
| 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
| string | $operation | | | string|null | $key | | | string|null | $group | | | string|null | $id_or_consumer | | | bool | $mkstream | | | int | $entries_read | |
| mixed | |
| 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
| string | $key | | | string | $group | | | string | $consumer | | | int | $min_idle | | | string | $start | | | int | $count | | | bool | $justid | |
| RedisCluster|bool|array | |
| Redis::xautoclaim | |
mixed xinfo(string $operation, string|null $arg1 = null, string|null $arg2 = null, int $count = -1)No description
| string | $operation | | | string|null | $arg1 | | | string|null | $arg2 | | | int | $count | |
| mixed | |
| Redis::xinfo | |
RedisCluster|int|false xlen(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| 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
| string | $key | | | string | $group | | | string|null | $start | | | string|null | $end | | | int | $count | | | string|null | $consumer | |
| RedisCluster|array|false | |
| Redis::xpending | |
RedisCluster|bool|array xrange(string $key, string $start, string $end, int $count = -1)No description
| string | $key | | | string | $start | | | string | $end | | | int | $count | |
| RedisCluster|bool|array | |
| Redis::xrange | |
RedisCluster|bool|array xread(array $streams, int $count = -1, int $block = -1)No description
| array | $streams | | | int | $count | | | int | $block | |
| RedisCluster|bool|array | |
| Redis::xread | |
RedisCluster|bool|array xreadgroup(string $group, string $consumer, array $streams, int $count = 1, int $block = 1)No description
| string | $group | | | string | $consumer | | | array | $streams | | | int | $count | | | int | $block | |
| RedisCluster|bool|array | |
| Redis::xreadgroup | |
RedisCluster|bool|array xrevrange(string $key, string $start, string $end, int $count = -1)No description
| string | $key | | | string | $start | | | string | $end | | | int | $count | |
| RedisCluster|bool|array | |
| Redis::xrevrange | |
RedisCluster|int|false xtrim(string $key, int $maxlen, bool $approx = false, bool $minid = false, int $limit = -1)No description
| string | $key | | | int | $maxlen | | | bool | $approx | | | bool | $minid | | | int | $limit | |
| RedisCluster|int|false | |
| Redis::xtrim | |
RedisCluster|int|float|false zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)No description
| string | $key | | | array|float | $score_or_options | | | mixed | ...$more_scores_and_mems | |
| RedisCluster|int|float|false | |
| Redis::zAdd | |
RedisCluster|int|false zcard(string $key)No description
| string | $key | |
| RedisCluster|int|false | |
| Redis::zCard | |
RedisCluster|int|false zcount(string $key, string $start, string $end)No description
| string | $key | | | string | $start | | | string | $end | |
| RedisCluster|int|false | |
| Redis::zCount | |
RedisCluster|float|false zincrby(string $key, float $value, string $member)No description
| string | $key | | | float | $value | | | string | $member | |
| RedisCluster|float|false | |
| Redis::zIncrBy | |
RedisCluster|int|false zinterstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)No description
| string | $dst | | | array | $keys | | | array|null | $weights | | | string|null | $aggregate | |
| RedisCluster|int|false | |
| Redis::zinterstore | |
RedisCluster|int|false zintercard(array $keys, int $limit = -1)No description
| array | $keys | | | int | $limit | |
| RedisCluster|int|false | |
| Redis::zintercard | |
RedisCluster|int|false zlexcount(string $key, string $min, string $max)No description
| string | $key | | | string | $min | | | string | $max | |
| RedisCluster|int|false | |
| Redis::zLexCount | |
RedisCluster|bool|array zpopmax(string $key, int|null $value = null)No description
| string | $key | | | int|null | $value | |
| RedisCluster|bool|array | |
| Redis::zPopMax | |
RedisCluster|bool|array zpopmin(string $key, int|null $value = null)No description
| string | $key | | | int|null | $value | |
| RedisCluster|bool|array | |
| Redis::zPopMin | |
RedisCluster|array|bool zrange(string $key, mixed $start, mixed $end, array|bool|null $options = null)No description
| string | $key | | | mixed | $start | | | mixed | $end | | | array|bool|null | $options | |
| RedisCluster|array|bool | |
| Redis::zRange | |
RedisCluster|int|false zrangestore(string $dstkey, string $srckey, int $start, int $end, array|bool|null $options = null)No description
| string | $dstkey | | | string | $srckey | | | int | $start | | | int | $end | | | array|bool|null | $options | |
| RedisCluster|int|false | |
| Redis::zrangestore | |
RedisCluster|string|array zrandmember(string $key, array|null $options = null)No description
| string | $key | | | array|null | $options | |
| RedisCluster|string|array | |
| https://redis.io/commands/zrandmember | |
RedisCluster|array|false zrangebylex(string $key, string $min, string $max, int $offset = -1, int $count = -1)No description
| string | $key | | | string | $min | | | string | $max | | | int | $offset | | | int | $count | |
| RedisCluster|array|false | |
| Redis::zRangeByLex | |
RedisCluster|array|false zrangebyscore(string $key, string $start, string $end, array $options = [])No description
| string | $key | | | string | $start | | | string | $end | | | array | $options | |
| RedisCluster|array|false | |
| Redis::zRangeByScore | |
RedisCluster|int|false zrank(string $key, mixed $member)No description
| string | $key | | | mixed | $member | |
| RedisCluster|int|false | |
| Redis::zRank | |
RedisCluster|int|false zrem(string $key, string $value, string ...$other_values)No description
| string | $key | | | string | $value | | | string | ...$other_values | |
| RedisCluster|int|false | |
| Redis::zRem | |
RedisCluster|int|false zremrangebylex(string $key, string $min, string $max)No description
| string | $key | | | string | $min | | | string | $max | |
| RedisCluster|int|false | |
| Redis::zRemRangeByLex | |
RedisCluster|int|false zremrangebyrank(string $key, string $min, string $max)No description
| string | $key | | | string | $min | | | string | $max | |
| RedisCluster|int|false | |
| Redis::zRemRangeByRank | |
RedisCluster|int|false zremrangebyscore(string $key, string $min, string $max)No description
| string | $key | | | string | $min | | | string | $max | |
| RedisCluster|int|false | |
| Redis::zRemRangeByScore | |
RedisCluster|bool|array zrevrange(string $key, string $min, string $max, array|null $options = null)No description
| string | $key | | | string | $min | | | string | $max | | | array|null | $options | |
| RedisCluster|bool|array | |
| Redis::zRevRange | |
RedisCluster|bool|array zrevrangebylex(string $key, string $min, string $max, array|null $options = null)No description
| string | $key | | | string | $min | | | string | $max | | | array|null | $options | |
| RedisCluster|bool|array | |
| Redis::zRevRangeByLex | |
RedisCluster|bool|array zrevrangebyscore(string $key, string $min, string $max, array|null $options = null)No description
| string | $key | | | string | $min | | | string | $max | | | array|null | $options | |
| RedisCluster|bool|array | |
| Redis::zRevRangeByScore | |
RedisCluster|int|false zrevrank(string $key, mixed $member)No description
| string | $key | | | mixed | $member | |
| RedisCluster|int|false | |
| Redis::zRevRank | |
RedisCluster|bool|array zscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)No description
| string | $key | | | null|int|string | $iterator | | | string|null | $pattern | | | int | $count | |
| RedisCluster|bool|array | |
| Redis::zscan | |
RedisCluster|float|false zscore(string $key, mixed $member)No description
| string | $key | | | mixed | $member | |
| RedisCluster|float|false | |
| Redis::zScore | |
RedisCluster|array|false zmscore(string $key, mixed $member, mixed ...$other_members)No description
| string | $key | | | mixed | $member | | | mixed | ...$other_members | |
| RedisCluster|array|false | |
| https://redis.io/commands/zmscore | |
RedisCluster|int|false zunionstore(string $dst, array $keys, array|null $weights = null, string|null $aggregate = null)No description
| string | $dst | | | array | $keys | | | array|null | $weights | | | string|null | $aggregate | |
| RedisCluster|int|false | |
| Redis::zunionstore | |
RedisCluster|array|false zinter(array $keys, array|null $weights = null, array|null $options = null)No description
| array | $keys | | | array|null | $weights | | | array|null | $options | |
| RedisCluster|array|false | |
| https://redis.io/commands/zinter | |
RedisCluster|int|false zdiffstore(string $dst, array $keys)No description
| string | $dst | | | array | $keys | |
| RedisCluster|int|false | |
| https://redis.io/commands/zdiffstore | |
RedisCluster|array|false zunion(array $keys, array|null $weights = null, array|null $options = null)No description
| array | $keys | | | array|null | $weights | | | array|null | $options | |
| RedisCluster|array|false | |
| https://redis.io/commands/zunion | |
RedisCluster|array|false zdiff(array $keys, array|null $options = null)No description
| array | $keys | | | array|null | $options | |
| RedisCluster|array|false | |
| https://redis.io/commands/zdiff | |
RedisCluster|string|false digest(string $key)No description
| string | $key | |
| RedisCluster|string|false | |
| https://redis.io/commands/digest | |
Generated by Doctum, a API Documentation generator and fork of Sami.