1. class
  2. Hypervel
  3. \
  4. Redis
  5. \
  6. PhpRedisConnection

PhpRedisConnection

class PhpRedisConnection extends RedisConnection

Standard phpredis connection for standalone Redis and Sentinel.

Traits

Macroable

Constants

private CONNECTION_LEVEL_PHPREDIS_OPTIONS

Top-level connection config keys that should be applied through setOption.

Properties

protected float $lastUseTime from  Connection
protected float $lastReleaseTime from  Connection
protected bool $invalid from  Connection
static protected array $macros

The registered string macros.

 from  Macroable
protected Redis|RedisCluster|null $connection from  RedisConnection
protected float $createdAt from  RedisConnection
protected float|null $lifetimeExpiresAt from  RedisConnection
protected bool $availableForReuse from  RedisConnection
protected Dispatcher|null $eventDispatcher from  RedisConnection
protected array $config from  RedisConnection
protected int|null $database

Current redis database.

 from  RedisConnection
protected bool $watching

Determine if the native connection is watching keys.

 from  RedisConnection
protected bool $shouldTransform

Determine if the connection calls should be transformed to Laravel style.

 from  RedisConnection

Methods

__construct(Container $container, ConnectionPool $pool, array $config)

Create a new PhpRedis connection instance.

void
release()

Release the connection back to pool.

from  RedisConnection
void
discard()

Discard the connection from its pool.

from  Connection
mixed
getConnection()

Get the underlying connection.

from  Connection
bool
check()

Check if the connection is still valid.

from  RedisConnection
float
getLastUseTime()

Get the last use time.

from  Connection
float
getLastReleaseTime()

Get the last release time.

from  Connection
void
markInvalid()

Mark the connection as invalid.

from  Connection
void
markValid()

Mark the connection as valid.

from  Connection
mixed
getActiveConnection()

Get the active connection.

from  RedisConnection
static void
macro(string $name, callable|object $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Check if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
void
invalidate()

Mark the connection invalid before its next use.

from  RedisConnection
string
getName()

Get the connection name.

from  RedisConnection
Dispatcher|null
getEventDispatcher()

Get the event dispatcher instance.

from  RedisConnection
bool
reconnect()

Reconnect to Redis.

void
markReconnected()

Mark the underlying Redis client as freshly connected.

from  RedisConnection
void
setOptions(Redis|RedisCluster $redis)

Set configured options on a Redis or RedisCluster client.

from  RedisConnection
array
configuredPhpRedisOptions()

Get the phpredis options configured on the connection.

from  RedisConnection
int
phpRedisOption(string $name)

Resolve a phpredis option name to its native option constant.

from  RedisConnection
int
parseBackoffAlgorithm(mixed $algorithm)

Parse a friendly phpredis backoff algorithm name.

from  RedisConnection
bool
close()

Close the current connection.

from  RedisConnection
bool
heartbeatCheck(float $timeout)

Check the Redis client for heartbeat health.

from  RedisConnection
bool|Redis
discardTransaction()

Execute the native Redis DISCARD command.

from  RedisConnection
void
clearWatchState()

Clear the tracked watch state after callback-form transaction completion.

from  RedisConnection
bool
isIdleExpired(float|null $now = null)

Determine if this connection has been idle long enough to be evicted.

from  RedisConnection
float
getCreatedAt()

Get the connection generation creation time.

from  RedisConnection
bool
isLifetimeExpired(float|null $now = null)

Determine if this connection generation has reached its maximum lifetime.

from  RedisConnection
bool
shouldInvalidateAfter(RedisException|RedisClusterException|ErrorException $exception)

Determine whether a failed command left the connection unsafe to reuse.

from  RedisConnection
bool
isQueueingMode()

Determine if the underlying Redis client is in pipeline/multi mode.

bool
isCluster()

Determine if the connection is to a Redis Cluster.

static bool
hasHashTag(string $key)

Determine if the given key contains a Redis Cluster hash tag.

from  RedisConnection
bool
pingForHeartbeat()

Ping Redis for heartbeat health without shadowing the public Redis PING command.

from  RedisConnection
void
log(string $message, string $level = LogLevel::WARNING)

Log a redis connection message.

from  RedisConnection
RedisConnection
shouldTransform(bool $shouldTransform = true)

Determine if the connection calls should be transformed to Laravel style.

from  RedisConnection
bool
getShouldTransform()

Get the current transformation state.

from  RedisConnection
mixed
callGet(string $key)

Returns the value of the given key.

from  RedisConnection
array|false
callMget(array $keys)

Get the values of all the given keys.

from  RedisConnection
array
prepareSet(mixed ...$arguments)

Prepare arguments for the set command.

from  RedisConnection
mixed
callSet(string $key, mixed $value, mixed $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)

Set the string value in the argument as the value of the key.

from  RedisConnection
int
callSetnx(string $key, mixed $value)

Set the given key if it doesn't exist.

from  RedisConnection
array
prepareHmget(mixed ...$arguments)

Prepare arguments for the hmget command.

from  RedisConnection
array|false
callHmget(string $key, mixed ...$dictionary)

Get the value of the given hash fields.

from  RedisConnection
array
prepareHmset(mixed ...$arguments)

Prepare arguments for the hmset command.

from  RedisConnection
bool
callHmset(string $key, mixed ...$dictionary)

Set the given hash fields to their respective values.

from  RedisConnection
int
callHsetnx(string $hash, string $key, mixed $value)

Set the given hash field if it doesn't exist.

from  RedisConnection
array
prepareLrem(mixed ...$arguments)

Prepare arguments for the lrem command.

from  RedisConnection
false|int
callLrem(string $key, int $count, mixed $value)

Removes the first count occurrences of the value element from the list.

from  RedisConnection
array|null
callBlpop(mixed ...$arguments)

Removes and returns the first element of the list stored at key.

from  RedisConnection
array|null
callBrpop(mixed ...$arguments)

Removes and returns the last element of the list stored at key.

from  RedisConnection
mixed
callSpop(string $key, int|null $count = null)

Removes and returns random elements from the set value at key.

from  RedisConnection
array
prepareXadd(mixed ...$arguments)

Prepare arguments for the xadd command.

from  RedisConnection
false|string
callXadd(mixed ...$arguments)

Add an entry to a stream.

from  RedisConnection
array
prepareXautoclaim(mixed ...$arguments)

Prepare arguments for the xautoclaim command.

from  RedisConnection
array|bool
callXautoclaim(mixed ...$arguments)

Claim pending stream entries that have been idle long enough.

from  RedisConnection
array
prepareXgroup(mixed ...$arguments)

Prepare arguments for the xgroup command.

from  RedisConnection
mixed
callXgroup(mixed ...$arguments)

Manage stream consumer groups.

from  RedisConnection
array
prepareXpending(mixed ...$arguments)

Prepare arguments for the xpending command.

from  RedisConnection
array|false
callXpending(mixed ...$arguments)

Get pending entries in a stream consumer group.

from  RedisConnection
array
prepareXrange(mixed ...$arguments)

Prepare arguments for the xrange command.

from  RedisConnection
array|bool
callXrange(mixed ...$arguments)

Get stream entries within the given ID range.

from  RedisConnection
array
prepareXrevrange(mixed ...$arguments)

Prepare arguments for the xrevrange command.

from  RedisConnection
array|bool
callXrevrange(mixed ...$arguments)

Get stream entries within the given ID range in reverse order.

from  RedisConnection
array
prepareXtrim(mixed ...$arguments)

Prepare arguments for the xtrim command.

from  RedisConnection
false|int
callXtrim(mixed ...$arguments)

Trim a stream by its length or minimum ID.

from  RedisConnection
array
prepareZadd(mixed ...$arguments)

Prepare arguments for the zadd command.

from  RedisConnection
false|float|int
callZadd(string $key, mixed ...$dictionary)

Add one or more members to a sorted set or update its score if it already exists.

from  RedisConnection
array
prepareZcount(mixed ...$arguments)

Prepare arguments for the zcount command.

from  RedisConnection
false|int
callZcount(mixed ...$arguments)

Count sorted set members within the given score range.

from  RedisConnection
array
prepareZremrangebyscore(mixed ...$arguments)

Prepare arguments for the zremrangebyscore command.

from  RedisConnection
false|int
callZremrangebyscore(mixed ...$arguments)

Remove sorted set members within the given score range.

from  RedisConnection
array
prepareZrangebyscore(mixed ...$arguments)

Prepare arguments for the zrangebyscore command.

from  RedisConnection
array|false
callZrangebyscore(string $key, float|int|string $min, float|int|string $max, array $options = [])

Return elements with score between $min and $max.

from  RedisConnection
array
prepareZrevrangebyscore(mixed ...$arguments)

Prepare arguments for the zrevrangebyscore command.

from  RedisConnection
array|false
callZrevrangebyscore(string $key, float|int|string $max, float|int|string $min, array $options = [])

Return elements with score between $max and $min in reverse order.

from  RedisConnection
array
prepareZinterstore(mixed ...$arguments)

Prepare arguments for the zinterstore command.

from  RedisConnection
false|int
callZinterstore(string $output, array $keys, array $options = [])

Find the intersection between sets and store in a new set.

from  RedisConnection
array
prepareZunionstore(mixed ...$arguments)

Prepare arguments for the zunionstore command.

from  RedisConnection
false|int
callZunionstore(string $output, array $keys, array $options = [])

Find the union between sets and store in a new set.

from  RedisConnection
array
getScanOptions(array $arguments)

Get the Redis scan options.

from  RedisConnection
mixed
scan(mixed $cursor, mixed ...$arguments)

Scan all keys based on options.

from  RedisConnection
mixed
callScan(mixed $cursor, mixed ...$arguments)

Execute the transformed SCAN command.

from  RedisConnection
mixed
zscan(mixed $key, mixed $cursor, mixed ...$arguments)

Scan the given set for all values based on options.

from  RedisConnection
mixed
callZscan(mixed $key, mixed $cursor, mixed ...$arguments)

Execute the transformed ZSCAN command.

from  RedisConnection
mixed
hscan(mixed $key, mixed $cursor, mixed ...$arguments)

Scan the given hash for all values based on options.

from  RedisConnection
mixed
callHscan(mixed $key, mixed $cursor, mixed ...$arguments)

Execute the transformed HSCAN command.

from  RedisConnection
mixed
sscan(mixed $key, mixed $cursor, mixed ...$arguments)

Scan the given set for all values based on options.

from  RedisConnection
mixed
callSscan(mixed $key, mixed $cursor, mixed ...$arguments)

Execute the transformed SSCAN command.

from  RedisConnection
array
prepareEval(mixed ...$arguments)

Prepare arguments for the eval command.

from  RedisConnection
mixed
callEval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate a script and return its result.

from  RedisConnection
array
prepareEvalsha(mixed ...$arguments)

Prepare arguments for the evalsha command.

from  RedisConnection
mixed
callEvalsha(string $script, int $numkeys, mixed ...$arguments)

Evaluate a LUA script serverside, from the SHA1 hash of the script instead of the script itself.

from  RedisConnection
array
prepareExecuteRaw(mixed ...$arguments)

Prepare arguments for the executeRaw command.

from  RedisConnection
mixed
callExecuteRaw(array $parameters)

Execute a raw command.

from  RedisConnection
never
callSubscribe(string $name, array $arguments)

Reject subscriptions on raw pooled connections.

from  RedisConnection
bool
serialized()

Determine if a custom serializer is configured on the connection.

from  RedisConnection
bool
compressed()

Determine if compression is configured on the connection.

from  RedisConnection
bool
lzfCompressed()

Determine if LZF compression is enabled.

from  RedisConnection
bool
zstdCompressed()

Determine if ZSTD compression is enabled.

from  RedisConnection
bool
lz4Compressed()

Determine if LZ4 compression is enabled.

from  RedisConnection
mixed
withoutScanPrefix(callable $callback)

Execute the given callback without prefixing scan patterns.

from  RedisConnection
mixed
withoutSerializationOrCompression(callable $callback)

Execute the given callback without serialization or compression.

from  RedisConnection
array
pack(array $values)

Pack values for use in Lua script ARGV parameters.

from  RedisConnection
mixed
client()

Get the underlying Redis client instance.

from  RedisConnection
mixed
evalWithShaCache(string $script, array $keys = [], array $args = [])

Execute a Lua script using evalSha with automatic fallback to eval.

from  RedisConnection
Throwable
scriptException(string $error)

Create an exception for a Lua script error.

from  RedisConnection
mixed
normalizeNullReplies(mixed $result)

Normalize topology-specific null replies.

from  RedisConnection
Generator
safeScan(string $pattern, int $count = 1000)

Safely scan the Redis keyspace for keys matching a pattern.

from  RedisConnection
int
flushByPattern(string $pattern)

Flush (delete) all Redis keys matching a pattern.

from  RedisConnection
mixed
get(string $key)

Get the value of a key

from  RedisConnection
mixed
set(string $key, mixed $value, mixed $expireResolution = 'null', int|null $expireTTL = 'null', string|null $flag = 'null')

Set the value of a key

from  RedisConnection
RedisCluster
mget(array $keys)

Get the values of multiple keys

from  RedisConnection
RedisCluster
setnx(string $key, mixed $value)

Set key if not exists

from  RedisConnection
RedisCluster
hmget(string $key, array $fields)

Get hash field values

from  RedisConnection
RedisCluster
hmset(string $key, array $fieldValues)

Set hash field values

from  RedisConnection
RedisCluster
hsetnx(string $hash, string $key, mixed $value)

Set hash field if not exists

from  RedisConnection
mixed
hget(string $key, string $member)

Get hash field value

from  RedisConnection
RedisCluster
hset(string $key, mixed ...$fields_and_vals)

Set hash field values

from  RedisConnection
false|int
lrem(string $key, int $count, mixed $value)

Remove list elements

from  RedisConnection
RedisCluster
llen(string $key)

Get list length

from  RedisConnection
RedisCluster
blpop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

Blocking left pop from list

from  RedisConnection
RedisCluster
brpop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

Blocking right pop from list

from  RedisConnection
mixed
spop(string $key, int $count = '0')

Remove and return random set member

from  RedisConnection
RedisCluster
sRem(string $key, mixed $value, mixed ...$other_values)

Remove members from set

from  RedisConnection
RedisCluster
zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

Add members to sorted set

from  RedisConnection
RedisCluster
zcard(string $key)

Get sorted set cardinality

from  RedisConnection
RedisCluster
zcount(string $key, float|int|string $start, float|int|string $end)

Count sorted set members by score range

from  RedisConnection
RedisCluster
zrangebyscore(string $key, float|int|string $min, float|int|string $max, array $options = '[]')

Get sorted set members by score range

from  RedisConnection
RedisCluster
zrevrangebyscore(string $key, float|int|string $max, float|int|string $min, array $options = '[]') Get sorted set members by score range (reverse)

No description

from  RedisConnection
RedisCluster
zinterstore(string $output, array $keys, array $options = '[]')

Intersect sorted sets

from  RedisConnection
RedisCluster
zunionstore(string $output, array $keys, array $options = '[]')

Union sorted sets

from  RedisConnection
mixed
eval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate Lua script

from  RedisConnection
mixed
evalsha(string $script, int $numkeys, mixed ...$arguments)

Evaluate Lua script by SHA1

from  RedisConnection
mixed
flushdb(mixed ...$arguments)

Flush database

from  RedisConnection
mixed
executeRaw(array $parameters)

Execute raw Redis command

from  RedisConnection
Redis
pipeline()

Execute commands in a pipeline

from  RedisConnection
RedisCluster
smembers(string $key)

Get all set members

from  RedisConnection
RedisCluster
hdel(string $key, string $field, string ...$other_fields)

Delete hash fields

from  RedisConnection
RedisCluster
zrem(mixed $key, mixed $member, mixed ...$other_members)

Remove sorted set members

from  RedisConnection
RedisCluster
hlen(string $key)

Get number of hash fields

from  RedisConnection
RedisCluster
hkeys(string $key)

Get all hash field names

from  RedisConnection
string
_serialize(mixed $value)

Serialize a value using configured serializer

from  RedisConnection
string
_digest(mixed $value)

No description

from  RedisConnection
string
_pack(mixed $value)

No description

from  RedisConnection
mixed
_unpack(string $value)

No description

from  RedisConnection
mixed
acl(string $subcmd, string ...$args)

No description

from  RedisConnection
RedisCluster
append(string $key, mixed $value)

No description

from  RedisConnection
Redis
auth(mixed $credentials)

No description

from  RedisConnection
RedisCluster
bgSave()

No description

from  RedisConnection
RedisCluster
bgrewriteaof()

No description

from  RedisConnection
RedisCluster
waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

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

No description

from  RedisConnection
RedisCluster
bitop(string $operation, string $deskey, string $srckey, string ...$other_keys)

No description

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

No description

from  RedisConnection
RedisCluster|string
brpoplpush(string $src, string $dst, float|int $timeout)

No description

from  RedisConnection
RedisCluster
bzPopMax(array|string $key, int|string $timeout_or_key, mixed ...$extra_args)

No description

from  RedisConnection
RedisCluster
bzPopMin(array|string $key, int|string $timeout_or_key, mixed ...$extra_args)

No description

from  RedisConnection
RedisCluster
bzmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

from  RedisConnection
RedisCluster
zmpop(array $keys, string $from, int $count = '1')

No description

from  RedisConnection
RedisCluster
blmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

from  RedisConnection
RedisCluster
lmpop(array $keys, string $from, int $count = '1')

No description

from  RedisConnection
bool
clearLastError()

No description

from  RedisConnection
mixed
command(string|null $opt = 'null', mixed ...$args)

No description

from  RedisConnection
mixed
config(string $operation, array|string|null $key_or_settings = 'null', string|null $value = 'null')

No description

from  RedisConnection
bool
connect(string $host, int $port = '6379', float $timeout = '0', string|null $persistent_id = 'null', int $retry_interval = '0', float $read_timeout = '0', array|null $context = 'null')

No description

from  RedisConnection
RedisCluster
copy(string $src, string $dst, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
dbSize()

No description

from  RedisConnection
Redis|string
debug(string $key)

No description

from  RedisConnection
RedisCluster
decr(string $key, int $by = '1')

No description

from  RedisConnection
RedisCluster
decrBy(string $key, int $value)

No description

from  RedisConnection
RedisCluster
del(array|string $key, string ...$other_keys)

No description

from  RedisConnection
RedisCluster
delex(string $key, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
delifeq(string $key, mixed $value)

No description

from  RedisConnection
RedisCluster|string
digest(string $key)

No description

from  RedisConnection
RedisCluster|string
dump(string $key)

No description

from  RedisConnection
RedisCluster|string
echo(string $str)

No description

from  RedisConnection
mixed
eval_ro(string $script_sha, array $args = '[]', int $num_keys = '0')

No description

from  RedisConnection
mixed
evalsha_ro(string $sha1, array $args = '[]', int $num_keys = '0')

No description

from  RedisConnection
Redis
exec()

No description

from  RedisConnection
RedisCluster
exists(mixed $key, mixed ...$other_keys)

No description

from  RedisConnection
RedisCluster
expire(string $key, int $timeout, string|null $mode = 'null')

No description

from  RedisConnection
RedisCluster
expireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

from  RedisConnection
Redis
failover(array|null $to = 'null', bool $abort = 'false', int $timeout = '0')

No description

from  RedisConnection
RedisCluster
expiretime(string $key)

No description

from  RedisConnection
RedisCluster
pexpiretime(string $key)

No description

from  RedisConnection
mixed
fcall(string $fn, array $keys = '[]', array $args = '[]')

No description

from  RedisConnection
mixed
fcall_ro(string $fn, array $keys = '[]', array $args = '[]')

No description

from  RedisConnection
RedisCluster
flushAll(bool|null $sync = 'null')

No description

from  RedisConnection
Redis|string
function(string $operation, mixed ...$args)

No description

from  RedisConnection
RedisCluster
geoadd(string $key, float $lng, float $lat, string $member, mixed ...$other_triples_and_options)

No description

from  RedisConnection
RedisCluster
geodist(string $key, string $src, string $dst, string|null $unit = 'null')

No description

from  RedisConnection
RedisCluster
geohash(string $key, string $member, string ...$other_members)

No description

from  RedisConnection
RedisCluster
geopos(string $key, string $member, string ...$other_members)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

from  RedisConnection
mixed
getAuth()

No description

from  RedisConnection
RedisCluster
getBit(string $key, int $idx)

No description

from  RedisConnection
RedisCluster|string
getEx(string $key, array $options = '[]')

No description

from  RedisConnection
int
getDBNum()

No description

from  RedisConnection
RedisCluster|string
getDel(string $key)

No description

from  RedisConnection
string
getHost()

No description

from  RedisConnection
null|string
getLastError()

No description

from  RedisConnection
int
getMode()

No description

from  RedisConnection
mixed
getOption(int $option)

No description

from  RedisConnection
null|string
getPersistentID()

No description

from  RedisConnection
int
getPort()

No description

from  RedisConnection
RedisCluster|string
getRange(string $key, int $start, int $end)

No description

from  RedisConnection
RedisCluster|string
lcs(string $key1, string $key2, array|null $options = 'null')

No description

from  RedisConnection
float
getReadTimeout()

No description

from  RedisConnection
RedisCluster|string
getset(string $key, mixed $value)

No description

from  RedisConnection
false|float
getTimeout()

No description

from  RedisConnection
array
getTransferredBytes()

No description

from  RedisConnection
void
clearTransferredBytes()

No description

from  RedisConnection
RedisCluster
getWithMeta(string $key)

No description

from  RedisConnection
RedisCluster
hexpire(string $key, int $ttl, array $fields, string|null $mode = 'null')

No description

from  RedisConnection
RedisCluster
hpexpire(string $key, int $ttl, array $fields, string|null $mode = 'null')

No description

from  RedisConnection
RedisCluster
hexpireat(string $key, int $time, array $fields, string|null $mode = 'null')

No description

from  RedisConnection
RedisCluster
hpexpireat(string $key, int $mstime, array $fields, string|null $mode = 'null')

No description

from  RedisConnection
RedisCluster
httl(string $key, array $fields)

No description

from  RedisConnection
RedisCluster
hpttl(string $key, array $fields)

No description

from  RedisConnection
RedisCluster
hexpiretime(string $key, array $fields)

No description

from  RedisConnection
RedisCluster
hpexpiretime(string $key, array $fields)

No description

from  RedisConnection
RedisCluster
hpersist(string $key, array $fields)

No description

from  RedisConnection
RedisCluster
hExists(string $key, string $field)

No description

from  RedisConnection
RedisCluster
hGetAll(string $key)

No description

from  RedisConnection
mixed
hGetWithMeta(string $key, string $member)

No description

from  RedisConnection
RedisCluster
hgetdel(string $key, array $fields)

No description

from  RedisConnection
RedisCluster
hgetex(string $key, array $fields, string|array|null $expiry = 'null')

No description

from  RedisConnection
RedisCluster
hIncrBy(string $key, string $field, int $value)

No description

from  RedisConnection
RedisCluster
hIncrByFloat(string $key, string $field, float $value)

No description

from  RedisConnection
RedisCluster|string
hRandField(string $key, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
hsetex(string $key, array $fields, array|null $expiry = 'null')

No description

from  RedisConnection
RedisCluster
hStrLen(string $key, string $field)

No description

from  RedisConnection
RedisCluster
hVals(string $key)

No description

from  RedisConnection
RedisCluster
incr(string $key, int $by = '1')

No description

from  RedisConnection
RedisCluster
incrBy(string $key, int $value)

No description

from  RedisConnection
RedisCluster
incrByFloat(string $key, float $value)

No description

from  RedisConnection
RedisCluster
info(string ...$sections)

No description

from  RedisConnection
bool
isConnected()

No description

from  RedisConnection
RedisCluster
keys(string $pattern)

No description

from  RedisConnection
RedisCluster
lInsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

from  RedisConnection
RedisCluster|string
lMove(string $src, string $dst, string $wherefrom, string $whereto)

No description

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

No description

from  RedisConnection
RedisCluster|string
lPop(string $key, int $count = '0')

No description

from  RedisConnection
RedisCluster
lPos(string $key, mixed $value, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
lPush(string $key, mixed ...$elements)

No description

from  RedisConnection
RedisCluster
rPush(string $key, mixed ...$elements)

No description

from  RedisConnection
RedisCluster
lPushx(string $key, mixed $value)

No description

from  RedisConnection
RedisCluster
rPushx(string $key, mixed $value)

No description

from  RedisConnection
RedisCluster
lSet(string $key, int $index, mixed $value)

No description

from  RedisConnection
int
lastSave()

No description

from  RedisConnection
mixed
lindex(string $key, int $index)

No description

from  RedisConnection
RedisCluster
lrange(string $key, int $start, int $end)

No description

from  RedisConnection
RedisCluster
ltrim(string $key, int $start, int $end)

No description

from  RedisConnection
Redis
migrate(string $host, int $port, array|string $key, int $dstdb, int $timeout, bool $copy = 'false', bool $replace = 'false', mixed $credentials = 'null')

No description

from  RedisConnection
Redis
move(string $key, int $index)

No description

from  RedisConnection
RedisCluster
mset(array $key_values)

No description

from  RedisConnection
RedisCluster
msetex(array $key_values, int|float|array|null $expiry = 'null')

No description

from  RedisConnection
RedisCluster
msetnx(array $key_values)

No description

from  RedisConnection
RedisCluster
multi(int $value = '1')

No description

from  RedisConnection
RedisCluster|string
object(string $subcommand, string $key)

No description

from  RedisConnection
bool
pconnect(string $host, int $port = '6379', float $timeout = '0', string|null $persistent_id = 'null', int $retry_interval = '0', float $read_timeout = '0', array|null $context = 'null')

No description

from  RedisConnection
RedisCluster
persist(string $key)

No description

from  RedisConnection
bool
pexpire(string $key, int $timeout, string|null $mode = 'null')

No description

from  RedisConnection
RedisCluster
pexpireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

from  RedisConnection
RedisCluster
pfadd(string $key, array $elements)

No description

from  RedisConnection
RedisCluster
pfcount(array|string $key_or_keys)

No description

from  RedisConnection
RedisCluster
pfmerge(string $dst, array $srckeys)

No description

from  RedisConnection
RedisCluster|string
ping(string|null $message = 'null')

No description

from  RedisConnection
RedisCluster
psetex(string $key, int $expire, mixed $value)

No description

from  RedisConnection
RedisCluster
pttl(string $key)

No description

from  RedisConnection
RedisCluster
publish(string $channel, string $message)

No description

from  RedisConnection
mixed
pubsub(string $command, mixed $arg = 'null')

No description

from  RedisConnection
Redis
punsubscribe(array $patterns)

No description

from  RedisConnection
RedisCluster|string
rPop(string $key, int $count = '0')

No description

from  RedisConnection
RedisCluster|string
randomKey()

No description

from  RedisConnection
mixed
rawcommand(string $command, mixed ...$args)

No description

from  RedisConnection
RedisCluster
rename(string $old_name, string $new_name)

No description

from  RedisConnection
RedisCluster
renameNx(string $key_src, string $key_dst)

No description

from  RedisConnection
RedisCluster
restore(string $key, int $ttl, string $value, array|null $options = 'null')

No description

from  RedisConnection
mixed
role()

No description

from  RedisConnection
RedisCluster|string
rpoplpush(string $srckey, string $dstkey)

No description

from  RedisConnection
RedisCluster
sAdd(string $key, mixed $value, mixed ...$other_values)

No description

from  RedisConnection
int
sAddArray(string $key, array $values)

No description

from  RedisConnection
RedisCluster
sDiff(string $key, string ...$other_keys)

No description

from  RedisConnection
RedisCluster
sDiffStore(string $dst, string $key, string ...$other_keys)

No description

from  RedisConnection
RedisCluster
sInter(array|string $key, string ...$other_keys)

No description

from  RedisConnection
RedisCluster
sintercard(array $keys, int $limit = '-1')

No description

from  RedisConnection
RedisCluster
sInterStore(array|string $key, string ...$other_keys)

No description

from  RedisConnection
RedisCluster
sMisMember(string $key, string $member, string ...$other_members)

No description

from  RedisConnection
RedisCluster
sMove(string $src, string $dst, mixed $value)

No description

from  RedisConnection
mixed
sRandMember(string $key, int $count = '0')

No description

from  RedisConnection
RedisCluster
sUnion(string $key, string ...$other_keys)

No description

from  RedisConnection
RedisCluster
sUnionStore(string $dst, string $key, string ...$other_keys)

No description

from  RedisConnection
RedisCluster
save()

No description

from  RedisConnection
RedisCluster
scard(string $key)

No description

from  RedisConnection
mixed
script(string $command, mixed ...$args)

No description

from  RedisConnection
Redis
select(int $db)

No description

from  RedisConnection
false|string
serverName()

No description

from  RedisConnection
false|string
serverVersion()

No description

from  RedisConnection
RedisCluster
setBit(string $key, int $idx, bool $value)

No description

from  RedisConnection
RedisCluster
setRange(string $key, int $index, string $value)

No description

from  RedisConnection
bool
setOption(int $option, mixed $value)

No description

from  RedisConnection
RedisCluster
setex(string $key, int $expire, mixed $value)

No description

from  RedisConnection
RedisCluster
sismember(string $key, mixed $value)

No description

from  RedisConnection
Redis
replicaof(string|null $host = 'null', int $port = '6379')

No description

from  RedisConnection
RedisCluster
touch(array|string $key_or_array, string ...$more_keys)

No description

from  RedisConnection
mixed
slowlog(string $operation, int $length = '0')

No description

from  RedisConnection
mixed
sort(string $key, array|null $options = 'null')

No description

from  RedisConnection
mixed
sort_ro(string $key, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
strlen(string $key)

No description

from  RedisConnection
Redis
sunsubscribe(array $channels)

No description

from  RedisConnection
Redis
swapdb(int $src, int $dst)

No description

from  RedisConnection
RedisCluster
time()

No description

from  RedisConnection
RedisCluster
ttl(string $key)

No description

from  RedisConnection
RedisCluster
type(string $key)

No description

from  RedisConnection
RedisCluster
unlink(array|string $key, string ...$other_keys)

No description

from  RedisConnection
Redis
unsubscribe(array $channels)

No description

from  RedisConnection
Redis
unwatch()

No description

from  RedisConnection
RedisCluster
vadd(string $key, array $values, mixed $element, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
vcard(string $key)

No description

from  RedisConnection
RedisCluster
vdim(string $key)

No description

from  RedisConnection
RedisCluster
vemb(string $key, mixed $member, bool $raw = 'false')

No description

from  RedisConnection
RedisCluster|string
vgetattr(string $key, mixed $member, bool $decode = 'true')

No description

from  RedisConnection
RedisCluster
vinfo(string $key)

No description

from  RedisConnection
RedisCluster
vismember(string $key, mixed $member)

No description

from  RedisConnection
RedisCluster
vlinks(string $key, mixed $member, bool $withscores = 'false')

No description

from  RedisConnection
RedisCluster|string
vrandmember(string $key, int $count = '0')

No description

from  RedisConnection
RedisCluster
vrange(string $key, string $min, string $max, int $count = '-1')

No description

from  RedisConnection
RedisCluster
vrem(string $key, mixed $member)

No description

from  RedisConnection
RedisCluster
vsetattr(string $key, mixed $member, array|string $attributes)

No description

from  RedisConnection
RedisCluster
vsim(string $key, mixed $member, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
watch(array|string $key, string ...$other_keys)

No description

from  RedisConnection
false|int
wait(int $numreplicas, int $timeout)

No description

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

No description

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

No description

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

No description

from  RedisConnection
RedisCluster
xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options)

No description

from  RedisConnection
RedisCluster
xdel(string $key, array $ids)

No description

from  RedisConnection
RedisCluster
xdelex(string $key, array $ids, string|null $mode = 'null')

No description

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

No description

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

No description

from  RedisConnection
RedisCluster
xlen(string $key)

No description

from  RedisConnection
RedisCluster
xpending(string $key, string $group, int|string|null $start = 'null', int|string|null $end = 'null', int $count = '-1', string|null $consumer = 'null')

No description

from  RedisConnection
RedisCluster
xrange(string $key, int|string $start, int|string $end, int $count = '-1')

No description

from  RedisConnection
RedisCluster
xread(array $streams, int $count = '-1', int $block = '-1')

No description

from  RedisConnection
RedisCluster
xreadgroup(string $group, string $consumer, array $streams, int $count = '1', int $block = '1')

No description

from  RedisConnection
RedisCluster
xrevrange(string $key, int|string $end, int|string $start, int $count = '-1')

No description

from  RedisConnection
RedisCluster
xtrim(string $key, int|string $threshold, bool $approx = 'false', bool $minid = 'false', int $limit = '-1')

No description

from  RedisConnection
RedisCluster
zIncrBy(string $key, float $value, mixed $member)

No description

from  RedisConnection
RedisCluster
zLexCount(string $key, string $min, string $max)

No description

from  RedisConnection
RedisCluster
zMscore(string $key, mixed $member, mixed ...$other_members)

No description

from  RedisConnection
RedisCluster
zPopMax(string $key, int|null $count = 'null')

No description

from  RedisConnection
RedisCluster
zPopMin(string $key, int|null $count = 'null')

No description

from  RedisConnection
RedisCluster
zRange(string $key, string|int $start, string|int $end, array|bool|null $options = 'null')

No description

from  RedisConnection
RedisCluster
zRangeByLex(string $key, string $min, string $max, int $offset = '-1', int $count = '-1')

No description

from  RedisConnection
RedisCluster
zrangestore(string $dstkey, string $srckey, string $start, string $end, array|bool|null $options = 'null')

No description

from  RedisConnection
RedisCluster|string
zRandMember(string $key, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
zRank(string $key, mixed $member)

No description

from  RedisConnection
RedisCluster
zRemRangeByLex(string $key, string $min, string $max)

No description

from  RedisConnection
RedisCluster
zRemRangeByRank(string $key, int $start, int $end)

No description

from  RedisConnection
RedisCluster
zRemRangeByScore(string $key, float|int|string $start, float|int|string $end)

No description

from  RedisConnection
RedisCluster
zRevRange(string $key, int $start, int $end, mixed $scores = 'null')

No description

from  RedisConnection
RedisCluster
zRevRangeByLex(string $key, string $max, string $min, int $offset = '-1', int $count = '-1')

No description

from  RedisConnection
RedisCluster
zRevRank(string $key, mixed $member)

No description

from  RedisConnection
RedisCluster
zScore(string $key, mixed $member)

No description

from  RedisConnection
RedisCluster
zdiff(array $keys, array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
zdiffstore(string $dst, array $keys)

No description

from  RedisConnection
RedisCluster
zinter(array $keys, array|null $weights = 'null', array|null $options = 'null')

No description

from  RedisConnection
RedisCluster
zintercard(array $keys, int $limit = '-1')

No description

from  RedisConnection
RedisCluster
zunion(array $keys, array|null $weights = 'null', array|null $options = 'null')

No description

from  RedisConnection
mixed
callFlushdb(mixed ...$arguments)

Flush the selected Redis database.

Redis
createRedis(array $config)

Create a redis connection.

string
formatHost(array $config)

Format the host using the scheme if available.

array
normalizeContext(array $context)

Normalize the SSL context for a standalone Redis connection.

Redis
createRedisSentinel()

Create a redis sentinel connection.

Details

at line 26
__construct(Container $container, ConnectionPool $pool, array $config)

Create a new PhpRedis connection instance.

Parameters

Container $container
ConnectionPool $pool
array $config

in RedisConnection at line 719
void release()

Release the connection back to pool.

Return Value

void

in Connection at line 103
void discard()

Discard the connection from its pool.

Return Value

void

in Connection at line 111
mixed getConnection()

Get the underlying connection.

Return Value

mixed

in RedisConnection at line 465
bool check()

Check if the connection is still valid.

Return Value

bool

in Connection at line 138
float getLastUseTime()

Get the last use time.

Return Value

float

in Connection at line 146
float getLastReleaseTime()

Get the last release time.

Return Value

float

in Connection at line 154
protected void markInvalid()

Mark the connection as invalid.

Return Value

void

in Connection at line 162
protected void markValid()

Mark the connection as valid.

Return Value

void

in RedisConnection at line 447
mixed getActiveConnection()

Get the active connection.

Return Value

mixed

in Macroable at line 30
static void macro(string $name, callable|object $macro)

Register a custom macro.

Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 44
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 61
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 83
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 108
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in RedisConnection at line 498
void invalidate()

internal  
 

Mark the connection invalid before its next use.

Return Value

void

in RedisConnection at line 506
string getName()

Get the connection name.

Return Value

string

in RedisConnection at line 514
Dispatcher|null getEventDispatcher()

Get the event dispatcher instance.

Return Value

Dispatcher|null

at line 39
bool reconnect()

Reconnect to Redis.

Return Value

bool

Exceptions

RedisException
ConnectionException

in RedisConnection at line 530
protected void markReconnected()

Mark the underlying Redis client as freshly connected.

Return Value

void

in RedisConnection at line 544
protected void setOptions(Redis|RedisCluster $redis)

Set configured options on a Redis or RedisCluster client.

Parameters

Redis|RedisCluster $redis

Return Value

void

in RedisConnection at line 587
protected array configuredPhpRedisOptions()

Get the phpredis options configured on the connection.

Return Value

array

in RedisConnection at line 607
protected int phpRedisOption(string $name)

Resolve a phpredis option name to its native option constant.

Parameters

string $name

Return Value

int

in RedisConnection at line 633
protected int parseBackoffAlgorithm(mixed $algorithm)

Parse a friendly phpredis backoff algorithm name.

Parameters

mixed $algorithm

Return Value

int

Exceptions

InvalidRedisOptionException

in RedisConnection at line 662
bool close()

Close the current connection.

Calling the native phpredis close() releases the underlying socket deterministically rather than relying on PHP refcount destruction - connections trapped in pool/connection reference cycles would otherwise keep their FDs open until the cycle collector runs.

Return Value

bool

Exceptions

CanceledException

in RedisConnection at line 688
bool heartbeatCheck(float $timeout)

Check the Redis client for heartbeat health.

Parameters

float $timeout

Return Value

bool

in RedisConnection at line 868
bool|Redis discardTransaction()

Execute the native Redis DISCARD command.

Use this method on a held connection because discard() removes the connection from its pool.

Return Value

bool|Redis

in RedisConnection at line 884
void clearWatchState()

internal  
 

Clear the tracked watch state after callback-form transaction completion.

Return Value

void

in RedisConnection at line 892
bool isIdleExpired(float|null $now = null)

Determine if this connection has been idle long enough to be evicted.

Parameters

float|null $now

Return Value

bool

in RedisConnection at line 907
float getCreatedAt()

Get the connection generation creation time.

Return Value

float

in RedisConnection at line 915
bool isLifetimeExpired(float|null $now = null)

Determine if this connection generation has reached its maximum lifetime.

Parameters

float|null $now

Return Value

bool

in RedisConnection at line 927
protected bool shouldInvalidateAfter(RedisException|RedisClusterException|ErrorException $exception)

Determine whether a failed command left the connection unsafe to reuse.

Parameters

RedisException|RedisClusterException|ErrorException $exception

Return Value

bool

at line 109
protected bool isQueueingMode()

Determine if the underlying Redis client is in pipeline/multi mode.

Return Value

bool

at line 101
bool isCluster()

Determine if the connection is to a Redis Cluster.

Return Value

bool

in RedisConnection at line 970
static bool hasHashTag(string $key)

Determine if the given key contains a Redis Cluster hash tag.

Parameters

string $key

Return Value

bool

in RedisConnection at line 986
protected bool pingForHeartbeat()

Ping Redis for heartbeat health without shadowing the public Redis PING command.

Return Value

bool

in RedisConnection at line 1025
protected void log(string $message, string $level = LogLevel::WARNING)

Log a redis connection message.

Parameters

string $message
string $level

Return Value

void

in RedisConnection at line 1035
RedisConnection shouldTransform(bool $shouldTransform = true)

Determine if the connection calls should be transformed to Laravel style.

Parameters

bool $shouldTransform

Return Value

RedisConnection

in RedisConnection at line 1045
bool getShouldTransform()

Get the current transformation state.

Return Value

bool

in RedisConnection at line 1053
protected mixed callGet(string $key)

Returns the value of the given key.

Parameters

string $key

Return Value

mixed

in RedisConnection at line 1063
protected array|false callMget(array $keys)

Get the values of all the given keys.

Parameters

array $keys

Return Value

array|false

in RedisConnection at line 1086
protected array prepareSet(mixed ...$arguments)

Prepare arguments for the set command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1099
protected mixed callSet(string $key, mixed $value, mixed $expireResolution = null, int|null $expireTTL = null, string|null $flag = null)

Set the string value in the argument as the value of the key.

Parameters

string $key
mixed $value
mixed $expireResolution
int|null $expireTTL
string|null $flag

Return Value

mixed

in RedisConnection at line 1110
protected int callSetnx(string $key, mixed $value)

Set the given key if it doesn't exist.

Parameters

string $key
mixed $value

Return Value

int

in RedisConnection at line 1120
protected array prepareHmget(mixed ...$arguments)

Prepare arguments for the hmget command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1131
protected array|false callHmget(string $key, mixed ...$dictionary)

Get the value of the given hash fields.

Parameters

string $key
mixed ...$dictionary

Return Value

array|false

in RedisConnection at line 1149
protected array prepareHmset(mixed ...$arguments)

Prepare arguments for the hmset command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1167
protected bool callHmset(string $key, mixed ...$dictionary)

Set the given hash fields to their respective values.

Parameters

string $key
mixed ...$dictionary

Return Value

bool

in RedisConnection at line 1177
protected int callHsetnx(string $hash, string $key, mixed $value)

Set the given hash field if it doesn't exist.

Parameters

string $hash
string $key
mixed $value

Return Value

int

in RedisConnection at line 1187
protected array prepareLrem(mixed ...$arguments)

Prepare arguments for the lrem command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1197
protected false|int callLrem(string $key, int $count, mixed $value)

Removes the first count occurrences of the value element from the list.

Parameters

string $key
int $count
mixed $value

Return Value

false|int

in RedisConnection at line 1207
protected array|null callBlpop(mixed ...$arguments)

Removes and returns the first element of the list stored at key.

Parameters

mixed ...$arguments

Return Value

array|null

in RedisConnection at line 1217
protected array|null callBrpop(mixed ...$arguments)

Removes and returns the last element of the list stored at key.

Parameters

mixed ...$arguments

Return Value

array|null

in RedisConnection at line 1230
protected mixed callSpop(string $key, int|null $count = null)

Removes and returns random elements from the set value at key.

When called without count, returns a single element (string|false). When called with count, returns an array of elements.

Parameters

string $key
int|null $count

Return Value

mixed

in RedisConnection at line 1264
protected array prepareXadd(mixed ...$arguments)

Prepare arguments for the xadd command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1272
protected false|string callXadd(mixed ...$arguments)

Add an entry to a stream.

Parameters

mixed ...$arguments

Return Value

false|string

in RedisConnection at line 1284
protected array prepareXautoclaim(mixed ...$arguments)

Prepare arguments for the xautoclaim command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1292
protected array|bool callXautoclaim(mixed ...$arguments)

Claim pending stream entries that have been idle long enough.

Parameters

mixed ...$arguments

Return Value

array|bool

in RedisConnection at line 1304
protected array prepareXgroup(mixed ...$arguments)

Prepare arguments for the xgroup command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1312
protected mixed callXgroup(mixed ...$arguments)

Manage stream consumer groups.

Parameters

mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1324
protected array prepareXpending(mixed ...$arguments)

Prepare arguments for the xpending command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1332
protected array|false callXpending(mixed ...$arguments)

Get pending entries in a stream consumer group.

Parameters

mixed ...$arguments

Return Value

array|false

in RedisConnection at line 1344
protected array prepareXrange(mixed ...$arguments)

Prepare arguments for the xrange command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1352
protected array|bool callXrange(mixed ...$arguments)

Get stream entries within the given ID range.

Parameters

mixed ...$arguments

Return Value

array|bool

in RedisConnection at line 1364
protected array prepareXrevrange(mixed ...$arguments)

Prepare arguments for the xrevrange command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1372
protected array|bool callXrevrange(mixed ...$arguments)

Get stream entries within the given ID range in reverse order.

Parameters

mixed ...$arguments

Return Value

array|bool

in RedisConnection at line 1384
protected array prepareXtrim(mixed ...$arguments)

Prepare arguments for the xtrim command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1392
protected false|int callXtrim(mixed ...$arguments)

Trim a stream by its length or minimum ID.

Parameters

mixed ...$arguments

Return Value

false|int

in RedisConnection at line 1404
protected array prepareZadd(mixed ...$arguments)

Prepare arguments for the zadd command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1432
protected false|float|int callZadd(string $key, mixed ...$dictionary)

Add one or more members to a sorted set or update its score if it already exists.

Parameters

string $key
mixed ...$dictionary

Return Value

false|float|int

in RedisConnection at line 1444
protected array prepareZcount(mixed ...$arguments)

Prepare arguments for the zcount command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1452
protected false|int callZcount(mixed ...$arguments)

Count sorted set members within the given score range.

Parameters

mixed ...$arguments

Return Value

false|int

in RedisConnection at line 1464
protected array prepareZremrangebyscore(mixed ...$arguments)

Prepare arguments for the zremrangebyscore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1472
protected false|int callZremrangebyscore(mixed ...$arguments)

Remove sorted set members within the given score range.

Parameters

mixed ...$arguments

Return Value

false|int

in RedisConnection at line 1484
protected array prepareZrangebyscore(mixed ...$arguments)

Prepare arguments for the zrangebyscore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1502
protected array|false callZrangebyscore(string $key, float|int|string $min, float|int|string $max, array $options = [])

Return elements with score between $min and $max.

Parameters

string $key
float|int|string $min
float|int|string $max
array $options

Return Value

array|false

in RedisConnection at line 1514
protected array prepareZrevrangebyscore(mixed ...$arguments)

Prepare arguments for the zrevrangebyscore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1532
protected array|false callZrevrangebyscore(string $key, float|int|string $max, float|int|string $min, array $options = [])

Return elements with score between $max and $min in reverse order.

Parameters

string $key
float|int|string $max
float|int|string $min
array $options

Return Value

array|false

in RedisConnection at line 1544
protected array prepareZinterstore(mixed ...$arguments)

Prepare arguments for the zinterstore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1555
protected false|int callZinterstore(string $output, array $keys, array $options = [])

Find the intersection between sets and store in a new set.

Parameters

string $output
array $keys
array $options

Return Value

false|int

in RedisConnection at line 1567
protected array prepareZunionstore(mixed ...$arguments)

Prepare arguments for the zunionstore command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1578
protected false|int callZunionstore(string $output, array $keys, array $options = [])

Find the union between sets and store in a new set.

Parameters

string $output
array $keys
array $options

Return Value

false|int

in RedisConnection at line 1588
protected array getScanOptions(array $arguments)

Get the Redis scan options.

Parameters

array $arguments

Return Value

array

in RedisConnection at line 1601
mixed scan(mixed $cursor, mixed ...$arguments)

Scan all keys based on options.

Parameters

mixed $cursor
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1609
protected mixed callScan(mixed $cursor, mixed ...$arguments)

Execute the transformed SCAN command.

Parameters

mixed $cursor
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1631
mixed zscan(mixed $key, mixed $cursor, mixed ...$arguments)

Scan the given set for all values based on options.

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1639
protected mixed callZscan(mixed $key, mixed $cursor, mixed ...$arguments)

Execute the transformed ZSCAN command.

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1662
mixed hscan(mixed $key, mixed $cursor, mixed ...$arguments)

Scan the given hash for all values based on options.

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1670
protected mixed callHscan(mixed $key, mixed $cursor, mixed ...$arguments)

Execute the transformed HSCAN command.

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1693
mixed sscan(mixed $key, mixed $cursor, mixed ...$arguments)

Scan the given set for all values based on options.

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1701
protected mixed callSscan(mixed $key, mixed $cursor, mixed ...$arguments)

Execute the transformed SSCAN command.

Parameters

mixed $key
mixed $cursor
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1724
protected array prepareEval(mixed ...$arguments)

Prepare arguments for the eval command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1736
protected mixed callEval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate a script and return its result.

Parameters

string $script
int $numberOfKeys
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1751
protected array prepareEvalsha(mixed ...$arguments)

Prepare arguments for the evalsha command.

Falls back to eval in MULTI/PIPELINE mode because script('load') cannot execute synchronously while the connection is queueing.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1763
protected mixed callEvalsha(string $script, int $numkeys, mixed ...$arguments)

Evaluate a LUA script serverside, from the SHA1 hash of the script instead of the script itself.

Parameters

string $script
int $numkeys
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 1777
protected array prepareExecuteRaw(mixed ...$arguments)

Prepare arguments for the executeRaw command.

Parameters

mixed ...$arguments

Return Value

array

in RedisConnection at line 1785
protected mixed callExecuteRaw(array $parameters)

Execute a raw command.

Parameters

array $parameters

Return Value

mixed

in RedisConnection at line 1804
protected never callSubscribe(string $name, array $arguments)

Reject subscriptions on raw pooled connections.

Pub/sub requires a dedicated, long-lived connection that is incompatible with connection pooling. Use the coroutine-native subscriber instead:

Redis::subscribe($channels, $callback);
Redis::psubscribe($channels, $callback);
$subscriber = Redis::subscriber();

Parameters

string $name
array $arguments

Return Value

never

Exceptions

BadMethodCallException

in RedisConnection at line 1815
bool serialized()

Determine if a custom serializer is configured on the connection.

Return Value

bool

in RedisConnection at line 1823
bool compressed()

Determine if compression is configured on the connection.

Return Value

bool

in RedisConnection at line 1831
bool lzfCompressed()

Determine if LZF compression is enabled.

Return Value

bool

in RedisConnection at line 1840
bool zstdCompressed()

Determine if ZSTD compression is enabled.

Return Value

bool

in RedisConnection at line 1849
bool lz4Compressed()

Determine if LZ4 compression is enabled.

Return Value

bool

in RedisConnection at line 1866
mixed withoutScanPrefix(callable $callback)

Execute the given callback without prefixing scan patterns.

Key prefixing remains unchanged. Hold this connection until the callback finishes so its scan options are restored before returning it to the pool.

Parameters

callable $callback

Return Value

mixed

in RedisConnection at line 1894
mixed withoutSerializationOrCompression(callable $callback)

Execute the given callback without serialization or compression.

Temporarily disables phpredis serialization and compression on the raw connection for operations that require raw integer values (e.g., rate limiter counters), then restores the original settings.

Parameters

callable $callback

Return Value

mixed

in RedisConnection at line 1935
array pack(array $values)

Pack values for use in Lua script ARGV parameters.

Unlike regular Redis commands where phpredis auto-serializes, Lua ARGV parameters must be pre-serialized strings.

Requires phpredis 6.0+ which provides the _pack() method.

Parameters

array $values

Return Value

array

in RedisConnection at line 1949
mixed client()

Get the underlying Redis client instance.

Return Value

mixed

in RedisConnection at line 1974
mixed evalWithShaCache(string $script, array $keys = [], array $args = [])

Execute a Lua script using evalSha with automatic fallback to eval.

Redis caches compiled Lua scripts by SHA1 hash. This method tries evalSha first (uses cached compiled script), and falls back to eval if the script isn't cached yet (NOSCRIPT error).

Unlike naive implementations that treat any false return as NOSCRIPT, this method wraps script and data errors returned by phpredis as false while native server, cluster, authentication, and transport exceptions propagate unchanged.

Parameters

string $script

The Lua script to execute
array $keys

Redis keys (passed as KEYS[] in Lua)
array $args

Additional arguments (passed as ARGV[] in Lua)

Return Value

mixed

The script's return value

Exceptions

LuaScriptException
RedisException

in RedisConnection at line 2026
protected Throwable scriptException(string $error)

Create an exception for a Lua script error.

Parameters

string $error

Return Value

Throwable

in RedisConnection at line 2034
protected mixed normalizeNullReplies(mixed $result)

Normalize topology-specific null replies.

Parameters

mixed $result

Return Value

mixed

in RedisConnection at line 2054
Generator safeScan(string $pattern, int $count = 1000)

Safely scan the Redis keyspace for keys matching a pattern.

This method handles the phpredis OPT_PREFIX complexity correctly:

  • Applies OPT_PREFIX to the scan pattern exactly once, respecting SCAN_PREFIX
  • Strips OPT_PREFIX from returned keys so they work with other commands

The connection must be held with transform disabled so SCAN retains its native phpredis cursor and result shape.

Parameters

string $pattern

The logical key pattern (e.g., "cache:users:*"). OPT_PREFIX is added automatically; the pattern is preserved even when it starts with the same bytes as OPT_PREFIX.
int $count

The COUNT hint for SCAN (not a limit, just a hint to Redis)

Return Value

Generator

Yields keys with OPT_PREFIX stripped

in RedisConnection at line 2080
int flushByPattern(string $pattern)

Flush (delete) all Redis keys matching a pattern.

Use this inside withConnection(..., transform: false) when doing multiple operations on the same connection. No connection lifecycle overhead since you're operating on an existing connection.

For standalone/one-off operations, use Redis::flushByPattern() instead, which handles connection lifecycle automatically.

Uses SCAN to iterate keys efficiently and deletes them in batches. Correctly handles OPT_PREFIX to avoid the double-prefixing bug.

Parameters

string $pattern

The logical key pattern (e.g., "cache:test:*"). OPT_PREFIX is added automatically; the pattern is preserved even when it starts with the same bytes as OPT_PREFIX.

Return Value

int

Number of keys deleted

Exceptions

RedisException

in RedisConnection at line 303
mixed get(string $key)

Get the value of a key

Parameters

string $key

Return Value

mixed

in RedisConnection at line 303
mixed set(string $key, mixed $value, mixed $expireResolution = 'null', int|null $expireTTL = 'null', string|null $flag = 'null')

Set the value of a key

Parameters

string $key
mixed $value
mixed $expireResolution
int|null $expireTTL
string|null $flag

Return Value

mixed

in RedisConnection at line 303
RedisCluster mget(array $keys)

Get the values of multiple keys

Parameters

array $keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster setnx(string $key, mixed $value)

Set key if not exists

Parameters

string $key
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hmget(string $key, array $fields)

Get hash field values

Parameters

string $key
array $fields

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hmset(string $key, array $fieldValues)

Set hash field values

Parameters

string $key
array $fieldValues

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hsetnx(string $hash, string $key, mixed $value)

Set hash field if not exists

Parameters

string $hash
string $key
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
mixed hget(string $key, string $member)

Get hash field value

Parameters

string $key
string $member

Return Value

mixed

in RedisConnection at line 303
RedisCluster hset(string $key, mixed ...$fields_and_vals)

Set hash field values

Parameters

string $key
mixed ...$fields_and_vals

Return Value

RedisCluster

in RedisConnection at line 303
false|int lrem(string $key, int $count, mixed $value)

Remove list elements

Parameters

string $key
int $count
mixed $value

Return Value

false|int

in RedisConnection at line 303
RedisCluster llen(string $key)

Get list length

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster blpop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

Blocking left pop from list

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster brpop(array|string $key_or_keys, float|int|string $timeout_or_key, mixed ...$extra_args)

Blocking right pop from list

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
mixed spop(string $key, int $count = '0')

Remove and return random set member

Parameters

string $key
int $count

Return Value

mixed

in RedisConnection at line 303
RedisCluster sRem(string $key, mixed $value, mixed ...$other_values)

Remove members from set

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zadd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

Add members to sorted set

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zcard(string $key)

Get sorted set cardinality

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zcount(string $key, float|int|string $start, float|int|string $end)

Count sorted set members by score range

Parameters

string $key
float|int|string $start
float|int|string $end

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zrangebyscore(string $key, float|int|string $min, float|int|string $max, array $options = '[]')

Get sorted set members by score range

Parameters

string $key
float|int|string $min
float|int|string $max
array $options

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zrevrangebyscore(string $key, float|int|string $max, float|int|string $min, array $options = '[]') Get sorted set members by score range (reverse)

No description

Parameters

string $key
float|int|string $max
float|int|string $min
array $options

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zinterstore(string $output, array $keys, array $options = '[]')

Intersect sorted sets

Parameters

string $output
array $keys
array $options

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zunionstore(string $output, array $keys, array $options = '[]')

Union sorted sets

Parameters

string $output
array $keys
array $options

Return Value

RedisCluster

in RedisConnection at line 303
mixed eval(string $script, int $numberOfKeys, mixed ...$arguments)

Evaluate Lua script

Parameters

string $script
int $numberOfKeys
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 303
mixed evalsha(string $script, int $numkeys, mixed ...$arguments)

Evaluate Lua script by SHA1

Parameters

string $script
int $numkeys
mixed ...$arguments

Return Value

mixed

in RedisConnection at line 303
mixed flushdb(mixed ...$arguments)

Flush database

Parameters

mixed ...$arguments

Return Value

mixed

in RedisConnection at line 303
mixed executeRaw(array $parameters)

Execute raw Redis command

Parameters

array $parameters

Return Value

mixed

in RedisConnection at line 303
Redis pipeline()

Execute commands in a pipeline

Return Value

Redis

in RedisConnection at line 303
RedisCluster smembers(string $key)

Get all set members

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hdel(string $key, string $field, string ...$other_fields)

Delete hash fields

Parameters

string $key
string $field
string ...$other_fields

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zrem(mixed $key, mixed $member, mixed ...$other_members)

Remove sorted set members

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hlen(string $key)

Get number of hash fields

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hkeys(string $key)

Get all hash field names

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
string _serialize(mixed $value)

Serialize a value using configured serializer

Parameters

mixed $value

Return Value

string

in RedisConnection at line 303
string _digest(mixed $value)

No description

Parameters

mixed $value

Return Value

string

in RedisConnection at line 303
string _pack(mixed $value)

No description

Parameters

mixed $value

Return Value

string

in RedisConnection at line 303
mixed _unpack(string $value)

No description

Parameters

string $value

Return Value

mixed

in RedisConnection at line 303
mixed acl(string $subcmd, string ...$args)

No description

Parameters

string $subcmd
string ...$args

Return Value

mixed

in RedisConnection at line 303
RedisCluster append(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
Redis auth(mixed $credentials)

No description

Parameters

mixed $credentials

Return Value

Redis

in RedisConnection at line 303
RedisCluster bgSave()

No description

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster bgrewriteaof()

No description

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

Parameters

int $numlocal
int $numreplicas
int $timeout

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster bitop(string $operation, string $deskey, string $srckey, string ...$other_keys)

No description

Parameters

string $operation
string $deskey
string $srckey
string ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster bitpos(string $key, bool $bit, int $start = '0', int $end = '-1', bool $bybit = 'false')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string brpoplpush(string $src, string $dst, float|int $timeout)

No description

Parameters

string $src
string $dst
float|int $timeout

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster bzPopMax(array|string $key, int|string $timeout_or_key, mixed ...$extra_args)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster bzPopMin(array|string $key, int|string $timeout_or_key, mixed ...$extra_args)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster bzmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zmpop(array $keys, string $from, int $count = '1')

No description

Parameters

array $keys
string $from
int $count

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster blmpop(float $timeout, array $keys, string $from, int $count = '1')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster lmpop(array $keys, string $from, int $count = '1')

No description

Parameters

array $keys
string $from
int $count

Return Value

RedisCluster

in RedisConnection at line 303
bool clearLastError()

No description

Return Value

bool

in RedisConnection at line 303
mixed command(string|null $opt = 'null', mixed ...$args)

No description

Parameters

string|null $opt
mixed ...$args

Return Value

mixed

in RedisConnection at line 303
mixed config(string $operation, array|string|null $key_or_settings = 'null', string|null $value = 'null')

No description

Parameters

string $operation
array|string|null $key_or_settings
string|null $value

Return Value

mixed

in RedisConnection at line 303
bool connect(string $host, int $port = '6379', float $timeout = '0', string|null $persistent_id = 'null', int $retry_interval = '0', float $read_timeout = '0', array|null $context = 'null')

No description

Parameters

string $host
int $port
float $timeout
string|null $persistent_id
int $retry_interval
float $read_timeout
array|null $context

Return Value

bool

in RedisConnection at line 303
RedisCluster copy(string $src, string $dst, array|null $options = 'null')

No description

Parameters

string $src
string $dst
array|null $options

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster dbSize()

No description

Return Value

RedisCluster

in RedisConnection at line 303
Redis|string debug(string $key)

No description

Parameters

string $key

Return Value

Redis|string

in RedisConnection at line 303
RedisCluster decr(string $key, int $by = '1')

No description

Parameters

string $key
int $by

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster decrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster del(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster delex(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster delifeq(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string digest(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster|string dump(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster|string echo(string $str)

No description

Parameters

string $str

Return Value

RedisCluster|string

in RedisConnection at line 303
mixed eval_ro(string $script_sha, array $args = '[]', int $num_keys = '0')

No description

Parameters

string $script_sha
array $args
int $num_keys

Return Value

mixed

in RedisConnection at line 303
mixed evalsha_ro(string $sha1, array $args = '[]', int $num_keys = '0')

No description

Parameters

string $sha1
array $args
int $num_keys

Return Value

mixed

in RedisConnection at line 303
Redis exec()

No description

Return Value

Redis

in RedisConnection at line 303
RedisCluster exists(mixed $key, mixed ...$other_keys)

No description

Parameters

mixed $key
mixed ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster expire(string $key, int $timeout, string|null $mode = 'null')

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster expireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

RedisCluster

in RedisConnection at line 303
Redis failover(array|null $to = 'null', bool $abort = 'false', int $timeout = '0')

No description

Parameters

array|null $to
bool $abort
int $timeout

Return Value

Redis

in RedisConnection at line 303
RedisCluster expiretime(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster pexpiretime(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
mixed fcall(string $fn, array $keys = '[]', array $args = '[]')

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

in RedisConnection at line 303
mixed fcall_ro(string $fn, array $keys = '[]', array $args = '[]')

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

in RedisConnection at line 303
RedisCluster flushAll(bool|null $sync = 'null')

No description

Parameters

bool|null $sync

Return Value

RedisCluster

in RedisConnection at line 303
Redis|string function(string $operation, mixed ...$args)

No description

Parameters

string $operation
mixed ...$args

Return Value

Redis|string

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster geodist(string $key, string $src, string $dst, string|null $unit = 'null')

No description

Parameters

string $key
string $src
string $dst
string|null $unit

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster geohash(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster geopos(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
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

in RedisConnection at line 303
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

in RedisConnection at line 303
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

in RedisConnection at line 303
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

in RedisConnection at line 303
array geosearch(string $key, array|string $position, array|int|float $shape, string $unit, array $options = '[]')

No description

Parameters

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

Return Value

array

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
mixed getAuth()

No description

Return Value

mixed

in RedisConnection at line 303
RedisCluster getBit(string $key, int $idx)

No description

Parameters

string $key
int $idx

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string getEx(string $key, array $options = '[]')

No description

Parameters

string $key
array $options

Return Value

RedisCluster|string

in RedisConnection at line 303
int getDBNum()

No description

Return Value

int

in RedisConnection at line 303
RedisCluster|string getDel(string $key)

No description

Parameters

string $key

Return Value

RedisCluster|string

in RedisConnection at line 303
string getHost()

No description

Return Value

string

in RedisConnection at line 303
null|string getLastError()

No description

Return Value

null|string

in RedisConnection at line 303
int getMode()

No description

Return Value

int

in RedisConnection at line 303
mixed getOption(int $option)

No description

Parameters

int $option

Return Value

mixed

in RedisConnection at line 303
null|string getPersistentID()

No description

Return Value

null|string

in RedisConnection at line 303
int getPort()

No description

Return Value

int

in RedisConnection at line 303
RedisCluster|string getRange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster|string lcs(string $key1, string $key2, array|null $options = 'null')

No description

Parameters

string $key1
string $key2
array|null $options

Return Value

RedisCluster|string

in RedisConnection at line 303
float getReadTimeout()

No description

Return Value

float

in RedisConnection at line 303
RedisCluster|string getset(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster|string

in RedisConnection at line 303
false|float getTimeout()

No description

Return Value

false|float

in RedisConnection at line 303
array getTransferredBytes()

No description

Return Value

array

in RedisConnection at line 303
void clearTransferredBytes()

No description

Return Value

void

in RedisConnection at line 303
RedisCluster getWithMeta(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster httl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hpttl(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hpexpiretime(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hpersist(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hExists(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hGetAll(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
mixed hGetWithMeta(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

in RedisConnection at line 303
RedisCluster hgetdel(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hgetex(string $key, array $fields, string|array|null $expiry = 'null')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hIncrBy(string $key, string $field, int $value)

No description

Parameters

string $key
string $field
int $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hIncrByFloat(string $key, string $field, float $value)

No description

Parameters

string $key
string $field
float $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string hRandField(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster hsetex(string $key, array $fields, array|null $expiry = 'null')

No description

Parameters

string $key
array $fields
array|null $expiry

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hStrLen(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster hVals(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster incr(string $key, int $by = '1')

No description

Parameters

string $key
int $by

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster incrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster incrByFloat(string $key, float $value)

No description

Parameters

string $key
float $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster info(string ...$sections)

No description

Parameters

string ...$sections

Return Value

RedisCluster

in RedisConnection at line 303
bool isConnected()

No description

Return Value

bool

in RedisConnection at line 303
RedisCluster keys(string $pattern)

No description

Parameters

string $pattern

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster lInsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string lMove(string $src, string $dst, string $wherefrom, string $whereto)

No description

Parameters

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

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster|string blmove(string $src, string $dst, string $wherefrom, string $whereto, float $timeout)

No description

Parameters

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

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster|string lPop(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster lPos(string $key, mixed $value, array|null $options = 'null')

No description

Parameters

string $key
mixed $value
array|null $options

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster lPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster rPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster lPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster rPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster lSet(string $key, int $index, mixed $value)

No description

Parameters

string $key
int $index
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
int lastSave()

No description

Return Value

int

in RedisConnection at line 303
mixed lindex(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

mixed

in RedisConnection at line 303
RedisCluster lrange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster ltrim(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster

in RedisConnection at line 303
Redis migrate(string $host, int $port, array|string $key, int $dstdb, int $timeout, bool $copy = 'false', bool $replace = 'false', mixed $credentials = 'null')

No description

Parameters

string $host
int $port
array|string $key
int $dstdb
int $timeout
bool $copy
bool $replace
mixed $credentials

Return Value

Redis

in RedisConnection at line 303
Redis move(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

Redis

in RedisConnection at line 303
RedisCluster mset(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster msetex(array $key_values, int|float|array|null $expiry = 'null')

No description

Parameters

array $key_values
int|float|array|null $expiry

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster msetnx(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster multi(int $value = '1')

No description

Parameters

int $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string object(string $subcommand, string $key)

No description

Parameters

string $subcommand
string $key

Return Value

RedisCluster|string

in RedisConnection at line 303
bool pconnect(string $host, int $port = '6379', float $timeout = '0', string|null $persistent_id = 'null', int $retry_interval = '0', float $read_timeout = '0', array|null $context = 'null')

No description

Parameters

string $host
int $port
float $timeout
string|null $persistent_id
int $retry_interval
float $read_timeout
array|null $context

Return Value

bool

in RedisConnection at line 303
RedisCluster persist(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
bool pexpire(string $key, int $timeout, string|null $mode = 'null')

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

bool

in RedisConnection at line 303
RedisCluster pexpireAt(string $key, int $timestamp, string|null $mode = 'null')

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster pfadd(string $key, array $elements)

No description

Parameters

string $key
array $elements

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster pfcount(array|string $key_or_keys)

No description

Parameters

array|string $key_or_keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster pfmerge(string $dst, array $srckeys)

No description

Parameters

string $dst
array $srckeys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string ping(string|null $message = 'null')

No description

Parameters

string|null $message

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster psetex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster pttl(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster publish(string $channel, string $message)

No description

Parameters

string $channel
string $message

Return Value

RedisCluster

in RedisConnection at line 303
mixed pubsub(string $command, mixed $arg = 'null')

No description

Parameters

string $command
mixed $arg

Return Value

mixed

in RedisConnection at line 303
Redis punsubscribe(array $patterns)

No description

Parameters

array $patterns

Return Value

Redis

in RedisConnection at line 303
RedisCluster|string rPop(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster|string randomKey()

No description

Return Value

RedisCluster|string

in RedisConnection at line 303
mixed rawcommand(string $command, mixed ...$args)

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

in RedisConnection at line 303
RedisCluster rename(string $old_name, string $new_name)

No description

Parameters

string $old_name
string $new_name

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster renameNx(string $key_src, string $key_dst)

No description

Parameters

string $key_src
string $key_dst

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster restore(string $key, int $ttl, string $value, array|null $options = 'null')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
mixed role()

No description

Return Value

mixed

in RedisConnection at line 303
RedisCluster|string rpoplpush(string $srckey, string $dstkey)

No description

Parameters

string $srckey
string $dstkey

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster sAdd(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
int sAddArray(string $key, array $values)

No description

Parameters

string $key
array $values

Return Value

int

in RedisConnection at line 303
RedisCluster sDiff(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster sDiffStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster sInter(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster sintercard(array $keys, int $limit = '-1')

No description

Parameters

array $keys
int $limit

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster sInterStore(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster sMisMember(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster sMove(string $src, string $dst, mixed $value)

No description

Parameters

string $src
string $dst
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
mixed sRandMember(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

mixed

in RedisConnection at line 303
RedisCluster sUnion(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster sUnionStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster save()

No description

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster scard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
mixed script(string $command, mixed ...$args)

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

in RedisConnection at line 303
Redis select(int $db)

No description

Parameters

int $db

Return Value

Redis

in RedisConnection at line 303
false|string serverName()

No description

Return Value

false|string

in RedisConnection at line 303
false|string serverVersion()

No description

Return Value

false|string

in RedisConnection at line 303
RedisCluster setBit(string $key, int $idx, bool $value)

No description

Parameters

string $key
int $idx
bool $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster setRange(string $key, int $index, string $value)

No description

Parameters

string $key
int $index
string $value

Return Value

RedisCluster

in RedisConnection at line 303
bool setOption(int $option, mixed $value)

No description

Parameters

int $option
mixed $value

Return Value

bool

in RedisConnection at line 303
RedisCluster setex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster sismember(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisCluster

in RedisConnection at line 303
Redis replicaof(string|null $host = 'null', int $port = '6379')

No description

Parameters

string|null $host
int $port

Return Value

Redis

in RedisConnection at line 303
RedisCluster touch(array|string $key_or_array, string ...$more_keys)

No description

Parameters

array|string $key_or_array
string ...$more_keys

Return Value

RedisCluster

in RedisConnection at line 303
mixed slowlog(string $operation, int $length = '0')

No description

Parameters

string $operation
int $length

Return Value

mixed

in RedisConnection at line 303
mixed sort(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

mixed

in RedisConnection at line 303
mixed sort_ro(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

mixed

in RedisConnection at line 303
RedisCluster strlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
Redis sunsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis

in RedisConnection at line 303
Redis swapdb(int $src, int $dst)

No description

Parameters

int $src
int $dst

Return Value

Redis

in RedisConnection at line 303
RedisCluster time()

No description

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster ttl(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster type(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
Redis unsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

Redis

in RedisConnection at line 303
Redis unwatch()

No description

Return Value

Redis

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster vcard(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster vdim(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster vemb(string $key, mixed $member, bool $raw = 'false')

No description

Parameters

string $key
mixed $member
bool $raw

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string vgetattr(string $key, mixed $member, bool $decode = 'true')

No description

Parameters

string $key
mixed $member
bool $decode

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster vinfo(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster vismember(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

No description

Parameters

string $key
mixed $member
bool $withscores

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string vrandmember(string $key, int $count = '0')

No description

Parameters

string $key
int $count

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster vrange(string $key, string $min, string $max, int $count = '-1')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster vrem(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster vsetattr(string $key, mixed $member, array|string $attributes)

No description

Parameters

string $key
mixed $member
array|string $attributes

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster vsim(string $key, mixed $member, array|null $options = 'null')

No description

Parameters

string $key
mixed $member
array|null $options

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster watch(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisCluster

in RedisConnection at line 303
false|int wait(int $numreplicas, int $timeout)

No description

Parameters

int $numreplicas
int $timeout

Return Value

false|int

in RedisConnection at line 303
false|int xack(string $key, string $group, array $ids)

No description

Parameters

string $key
string $group
array $ids

Return Value

false|int

in RedisConnection at line 303
RedisCluster|string xadd(string $key, int|string $id, array $values, int $maxlen = '0', bool $approx = 'false', bool $nomkstream = 'false')

No description

Parameters

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

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster xautoclaim(string $key, string $group, string $consumer, int $min_idle, int|string $start, int $count = '-1', bool $justid = 'false')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster xdel(string $key, array $ids)

No description

Parameters

string $key
array $ids

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster xdelex(string $key, array $ids, string|null $mode = 'null')

No description

Parameters

string $key
array $ids
string|null $mode

Return Value

RedisCluster

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

No description

Parameters

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

Return Value

mixed

in RedisConnection at line 303
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

in RedisConnection at line 303
RedisCluster xlen(string $key)

No description

Parameters

string $key

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster xpending(string $key, string $group, int|string|null $start = 'null', int|string|null $end = 'null', int $count = '-1', string|null $consumer = 'null')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster xrange(string $key, int|string $start, int|string $end, int $count = '-1')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster xread(array $streams, int $count = '-1', int $block = '-1')

No description

Parameters

array $streams
int $count
int $block

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster xrevrange(string $key, int|string $end, int|string $start, int $count = '-1')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster xtrim(string $key, int|string $threshold, bool $approx = 'false', bool $minid = 'false', int $limit = '-1')

No description

Parameters

string $key
int|string $threshold
bool $approx
bool $minid
int $limit

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zIncrBy(string $key, float $value, mixed $member)

No description

Parameters

string $key
float $value
mixed $member

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zLexCount(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zMscore(string $key, mixed $member, mixed ...$other_members)

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zPopMax(string $key, int|null $count = 'null')

No description

Parameters

string $key
int|null $count

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zPopMin(string $key, int|null $count = 'null')

No description

Parameters

string $key
int|null $count

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zRange(string $key, string|int $start, string|int $end, array|bool|null $options = 'null')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster zrangestore(string $dstkey, string $srckey, string $start, string $end, array|bool|null $options = 'null')

No description

Parameters

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

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster|string zRandMember(string $key, array|null $options = 'null')

No description

Parameters

string $key
array|null $options

Return Value

RedisCluster|string

in RedisConnection at line 303
RedisCluster zRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zRemRangeByLex(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zRemRangeByRank(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zRemRangeByScore(string $key, float|int|string $start, float|int|string $end)

No description

Parameters

string $key
float|int|string $start
float|int|string $end

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zRevRange(string $key, int $start, int $end, mixed $scores = 'null')

No description

Parameters

string $key
int $start
int $end
mixed $scores

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster zRevRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zScore(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zdiff(array $keys, array|null $options = 'null')

No description

Parameters

array $keys
array|null $options

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster zdiffstore(string $dst, array $keys)

No description

Parameters

string $dst
array $keys

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster 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

in RedisConnection at line 303
RedisCluster zintercard(array $keys, int $limit = '-1')

No description

Parameters

array $keys
int $limit

Return Value

RedisCluster

in RedisConnection at line 303
RedisCluster 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

at line 117
protected mixed callFlushdb(mixed ...$arguments)

Flush the selected Redis database.

Parameters

mixed ...$arguments

Return Value

mixed

at line 133
protected Redis createRedis(array $config)

Create a redis connection.

Parameters

array $config

Return Value

Redis

Exceptions

ConnectionException
RedisException

at line 162
protected string formatHost(array $config)

Format the host using the scheme if available.

Parameters

array $config

Return Value

string

at line 197
protected array normalizeContext(array $context)

Normalize the SSL context for a standalone Redis connection.

Redis::connect() expects the context as ['stream' => ['verify_peer' => false, ...]].

Parameters

array $context

Return Value

array

at line 215
protected Redis createRedisSentinel()

Create a redis sentinel connection.

Return Value

Redis

Exceptions

ConnectionException