class RedisArray (View source)

Helper autocomplete for php redis extension

Methods

__construct(string|array $hosts, array|null $opts = null)

Constructor

bool|array
_continuum()

No description

bool|callable
_distributor()

No description

bool|callable
_function()

No description

bool|array
_hosts()

No description

bool|null|Redis
_instance(string $host)

No description

bool|null
_rehash(callable $fn = null)

Use this function when a new node is added and keys need to be rehashed.

bool|string|null
_target(string $key)

No description

bool|RedisArray
multi(string $host, int $mode = Redis::MULTI)

No description

bool|array
info()

Returns a hosts array of associative array of strings and integers, with the following keys:

  • redis_version
  • redis_git_sha1
  • redis_git_dirty
  • redis_build_id
  • redis_mode
  • os
  • arch_bits
  • multiplexing_api
  • atomicvar_api
  • gcc_version
  • process_id
  • run_id
  • tcp_port
  • uptime_in_seconds
  • uptime_in_days
  • hz
  • lru_clock
  • executable
  • config_file
  • connected_clients
  • client_longest_output_list
  • client_biggest_input_buf
  • blocked_clients
  • used_memory
  • used_memory_human
  • used_memory_rss
  • used_memory_rss_human
  • used_memory_peak
  • used_memory_peak_human
  • used_memory_peak_perc
  • used_memory_peak
  • used_memory_overhead
  • used_memory_startup
  • used_memory_dataset
  • used_memory_dataset_perc
  • total_system_memory
  • total_system_memory_human
  • used_memory_lua
  • used_memory_lua_human
  • maxmemory
  • maxmemory_human
  • maxmemory_policy
  • mem_fragmentation_ratio
  • mem_allocator
  • active_defrag_running
  • lazyfree_pending_objects
  • mem_fragmentation_ratio
  • loading
  • rdb_changes_since_last_save
  • rdb_bgsave_in_progress
  • rdb_last_save_time
  • rdb_last_bgsave_status
  • rdb_last_bgsave_time_sec
  • rdb_current_bgsave_time_sec
  • rdb_last_cow_size
  • aof_enabled
  • aof_rewrite_in_progress
  • aof_rewrite_scheduled
  • aof_last_rewrite_time_sec
  • aof_current_rewrite_time_sec
  • aof_last_bgrewrite_status
  • aof_last_write_status
  • aof_last_cow_size
  • changes_since_last_save
  • aof_current_size
  • aof_base_size
  • aof_pending_rewrite
  • aof_buffer_length
  • aof_rewrite_buffer_length
  • aof_pending_bio_fsync
  • aof_delayed_fsync
  • loading_start_time
  • loading_total_bytes
  • loading_loaded_bytes
  • loading_loaded_perc
  • loading_eta_seconds
  • total_connections_received
  • total_commands_processed
  • instantaneous_ops_per_sec
  • total_net_input_bytes
  • total_net_output_bytes
  • instantaneous_input_kbps
  • instantaneous_output_kbps
  • rejected_connections
  • maxclients
  • sync_full
  • sync_partial_ok
  • sync_partial_err
  • expired_keys
  • evicted_keys
  • keyspace_hits
  • keyspace_misses
  • pubsub_channels
  • pubsub_patterns
  • latest_fork_usec
  • migrate_cached_sockets
  • slave_expires_tracked_keys
  • active_defrag_hits
  • active_defrag_misses
  • active_defrag_key_hits
  • active_defrag_key_misses
  • role
  • master_replid
  • master_replid2
  • master_repl_offset
  • second_repl_offset
  • repl_backlog_active
  • repl_backlog_size
  • repl_backlog_first_byte_offset
  • repl_backlog_histlen
  • master_host
  • master_port
  • master_link_status
  • master_last_io_seconds_ago
  • master_sync_in_progress
  • slave_repl_offset
  • slave_priority
  • slave_read_only
  • master_sync_left_bytes
  • master_sync_last_io_seconds_ago
  • master_link_down_since_seconds
  • connected_slaves
  • min-slaves-to-write
  • min-replicas-to-write
  • min_slaves_good_slaves
  • used_cpu_sys
  • used_cpu_user
  • used_cpu_sys_children
  • used_cpu_user_children
  • cluster_enabled

array
bgsave()

No description

bool|int
del(string|array $key, string ...$otherkeys)

No description

bool|null
discard()

No description

bool|null|array
exec()

No description

bool|array
flushall()

No description

bool|array
flushdb()

No description

bool|array
getOption(int $opt)

No description

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

No description

bool|array
keys(string $pattern)

No description

bool|array
mget(array $keys)

No description

bool
mset(array $pairs)

No description

bool|array
ping()

No description

bool|array
save()

No description

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

No description

bool|array
select(int $index)

No description

bool|array
setOption(int $opt, string $value)

No description

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

No description

bool|int
unlink(string|array $key, string ...$otherkeys)

No description

bool|null
unwatch()

No description

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

No description

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

No description

RedisArray|int|false
append(string $key, mixed $value)

No description

RedisArray|bool
auth(mixed $credentials)

No description

RedisArray|bool
bgrewriteaof()

No description

RedisArray|array|false
waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

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

No description

RedisArray|int|false
bitop(string $operation, string $deskey, string $srckey, string ...$other_keys)

No description

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

No description

RedisArray|array|null|false
blPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed ...$extra_args)

No description

RedisArray|array|null|false
brPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed ...$extra_args)

No description

RedisArray|string|false
brpoplpush(string $src, string $dst, int|float $timeout)

No description

RedisArray|array|false
bzPopMax(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)

No description

RedisArray|array|false
bzPopMin(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)

No description

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

No description

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

No description

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

No description

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

No description

bool
clearLastError()

No description

mixed
client(string $opt, mixed ...$args)

No description

bool
close()

No description

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

No description

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

No description

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

No description

RedisArray|int|false
dbSize()

No description

RedisArray|string
debug(string $key)

No description

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

No description

RedisArray|int|false
decrBy(string $key, int $value)

No description

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

No description

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

No description

RedisArray|int|false
delete(array|string $key, string ...$other_keys)

No description

RedisArray|string|false
dump(string $key)

No description

RedisArray|string|false
echo(string $str)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

RedisArray|bool
expireAt(string $key, int $timestamp, string|null $mode = null)

No description

RedisArray|bool
failover(array|null $to = null, bool $abort = false, int $timeout = 0)

No description

RedisArray|int|false
expiretime(string $key)

No description

RedisArray|int|false
pexpiretime(string $key)

No description

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

No description

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

No description

RedisArray|bool|string|array
function(string $operation, mixed ...$args)

No description

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

No description

RedisArray|float|false
geodist(string $key, string $src, string $dst, string|null $unit = null)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

mixed
get(string $key)

No description

RedisArray|array|false
getWithMeta(string $key)

No description

mixed
getAuth()

No description

RedisArray|int|false
getBit(string $key, int $idx)

No description

RedisArray|string|bool
getEx(string $key, array $options = [])

No description

int
getDBNum()

No description

RedisArray|string|bool
getDel(string $key)

No description

string
getHost()

No description

string|null
getLastError()

No description

int
getMode()

No description

string|null
getPersistentID()

No description

int
getPort()

No description

string|false
serverName()

No description

string|false
serverVersion()

No description

RedisArray|string|false
getRange(string $key, int $start, int $end)

No description

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

No description

float
getReadTimeout()

No description

RedisArray|string|false
getset(string $key, mixed $value)

No description

float|false
getTimeout()

No description

array
getTransferredBytes()

No description

void
clearTransferredBytes()

No description

RedisArray|int|false
hDel(string $key, string $field, string ...$other_fields)

No description

RedisArray|bool
hExists(string $key, string $field)

No description

mixed
hGet(string $key, string $member)

No description

RedisArray|array|false
hGetAll(string $key)

No description

mixed
hGetWithMeta(string $key, string $member)

No description

RedisArray|int|false
hIncrBy(string $key, string $field, int $value)

No description

RedisArray|float|false
hIncrByFloat(string $key, string $field, float $value)

No description

RedisArray|array|false
hKeys(string $key)

No description

RedisArray|int|false
hLen(string $key)

No description

RedisArray|array|false
hMget(string $key, array $fields)

No description

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

No description

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

No description

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

No description

RedisArray|bool
hMset(string $key, array $fieldvals)

No description

RedisArray|string|array|false
hRandField(string $key, array|null $options = null)

No description

RedisArray|int|false
hSet(string $key, mixed ...$fields_and_vals)

No description

RedisArray|bool
hSetNx(string $key, string $field, mixed $value)

No description

RedisArray|int|false
hStrLen(string $key, string $field)

No description

RedisArray|array|false
hVals(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

RedisArray|int|false
incrBy(string $key, int $value)

No description

RedisArray|float|false
incrByFloat(string $key, float $value)

No description

bool
isConnected()

No description

RedisArray|int|false
lInsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

RedisArray|int|false
lLen(string $key)

No description

RedisArray|string|false
lMove(string $src, string $dst, string $wherefrom, string $whereto)

No description

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

No description

RedisArray|bool|string|array
lPop(string $key, int $count = 0)

No description

RedisArray|null|bool|int|array
lPos(string $key, mixed $value, array|null $options = null)

No description

RedisArray|int|false
lPush(string $key, mixed ...$elements)

No description

RedisArray|int|false
rPush(string $key, mixed ...$elements)

No description

RedisArray|int|false
lPushx(string $key, mixed $value)

No description

RedisArray|int|false
rPushx(string $key, mixed $value)

No description

RedisArray|bool
lSet(string $key, int $index, mixed $value)

No description

int
lastSave()

No description

mixed
lindex(string $key, int $index)

No description

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

No description

RedisArray|int|false
lrem(string $key, mixed $value, int $count = 0)

No description

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

No description

RedisArray|bool
move(string $key, int $index)

No description

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

No description

RedisArray|bool
msetnx(array $key_values)

No description

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

No description

bool
open(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

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

RedisArray|bool
persist(string $key)

No description

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

No description

RedisArray|bool
pexpireAt(string $key, int $timestamp, string|null $mode = null)

No description

pfadd(string $key, array $elements)

No description

RedisArray|int|false
pfcount(array|string $key_or_keys)

No description

RedisArray|bool
pfmerge(string $dst, array $srckeys)

No description

bool|RedisArray
pipeline()

No description

bool
popen(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

RedisArray|bool
psetex(string $key, int $expire, mixed $value)

No description

bool
psubscribe(array $patterns, callable $cb)

No description

RedisArray|int|false
pttl(string $key)

No description

RedisArray|int|false
publish(string $channel, string $message)

No description

mixed
pubsub(string $command, mixed $arg = null)

No description

RedisArray|array|bool
punsubscribe(array $patterns)

No description

RedisArray|array|string|bool
rPop(string $key, int $count = 0)

No description

RedisArray|string|false
randomKey()

No description

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

No description

RedisArray|bool
rename(string $old_name, string $new_name)

No description

RedisArray|bool
renameNx(string $key_src, string $key_dst)

No description

RedisArray|bool
reset()

No description

RedisArray|bool
restore(string $key, int $ttl, string $value, array|null $options = null)

No description

mixed
role()

No description

RedisArray|string|false
rpoplpush(string $srckey, string $dstkey)

No description

RedisArray|int|false
sAdd(string $key, mixed $value, mixed ...$other_values)

No description

int
sAddArray(string $key, array $values)

No description

RedisArray|array|false
sDiff(string $key, string ...$other_keys)

No description

RedisArray|int|false
sDiffStore(string $dst, string $key, string ...$other_keys)

No description

RedisArray|array|false
sInter(array|string $key, string ...$other_keys)

No description

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

No description

RedisArray|int|false
sInterStore(array|string $key, string ...$other_keys)

No description

RedisArray|array|false
sMembers(string $key)

No description

RedisArray|array|false
sMisMember(string $key, string $member, string ...$other_members)

No description

RedisArray|bool
sMove(string $src, string $dst, mixed $value)

No description

RedisArray|string|array|false
sPop(string $key, int $count = 0)

No description

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

No description

RedisArray|array|false
sUnion(string $key, string ...$other_keys)

No description

RedisArray|int|false
sUnionStore(string $dst, string $key, string ...$other_keys)

No description

RedisArray|int|false
scard(string $key)

No description

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

No description

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

No description

RedisArray|int|false
setBit(string $key, int $idx, bool $value)

No description

RedisArray|int|false
setRange(string $key, int $index, string $value)

No description

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

No description

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

No description

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

No description

RedisArray|bool
slaveof(string|null $host = null, int $port = 6379)

No description

RedisArray|bool
replicaof(string|null $host = null, int $port = 6379)

No description

RedisArray|int|false
touch(array|string $key_or_array, string ...$more_keys)

No description

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

No description

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

No description

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

No description

array
sortAsc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null)

No description

array
sortAscAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null)

No description

array
sortDesc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null)

No description

array
sortDescAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null)

No description

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

No description

bool
ssubscribe(array $channels, callable $cb)

No description

RedisArray|int|false
strlen(string $key)

No description

bool
subscribe(array $channels, callable $cb)

No description

RedisArray|array|bool
sunsubscribe(array $channels)

No description

RedisArray|bool
swapdb(int $src, int $dst)

No description

RedisArray|array
time()

No description

RedisArray|int|false
ttl(string $key)

No description

RedisArray|int|false
type(string $key)

No description

RedisArray|array|bool
unsubscribe(array $channels)

No description

RedisArray|bool
watch(array|string $key, string ...$other_keys)

No description

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

No description

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

No description

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

No description

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

No description

RedisArray|array|bool
xclaim(string $key, string $group, string $consumer, int $min_idle, array $ids, array $options)

No description

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

No description

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

No description

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

No description

RedisArray|int|false
xlen(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

RedisArray|int|false
vcard(string $key)

No description

RedisArray|int|false
vdim(string $key)

No description

RedisArray|array|false
vinfo(string $key)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

RedisArray|int|float|false
zAdd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

No description

RedisArray|int|false
zCard(string $key)

No description

RedisArray|int|false
zCount(string $key, int|string $start, int|string $end)

No description

RedisArray|float|false
zIncrBy(string $key, float $value, mixed $member)

No description

RedisArray|int|false
zLexCount(string $key, string $min, string $max)

No description

RedisArray|array|false
zMscore(string $key, mixed $member, mixed ...$other_members)

No description

RedisArray|array|false
zPopMax(string $key, int|null $count = null)

No description

RedisArray|array|false
zPopMin(string $key, int|null $count = null)

No description

RedisArray|array|false
zRange(string $key, string|int $start, string|int $end, array|bool|null $options = null)

No description

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

No description

RedisArray|array|false
zRangeByScore(string $key, string $start, string $end, array $options = [])

No description

RedisArray|string|array
zRandMember(string $key, array|null $options = null)

No description

RedisArray|int|false
zRank(string $key, mixed $member)

No description

RedisArray|int|false
zRem(mixed $key, mixed $member, mixed ...$other_members)

No description

RedisArray|int|false
zRemRangeByLex(string $key, string $min, string $max)

No description

RedisArray|int|false
zRemRangeByRank(string $key, int $start, int $end)

No description

RedisArray|int|false
zRemRangeByScore(string $key, string $start, string $end)

No description

RedisArray|array|false
zRevRange(string $key, int $start, int $end, mixed $scores = null)

No description

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

No description

RedisArray|array|false
zRevRangeByScore(string $key, string $max, string $min, array|bool $options = [])

No description

RedisArray|int|false
zRevRank(string $key, mixed $member)

No description

RedisArray|float|false
zScore(string $key, mixed $member)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

RedisArray|string|false
digest(string $key)

No description

Details

__construct(string|array $hosts, array|null $opts = null)

Constructor

Parameters

string|array $hosts

Name of the redis array from redis.ini or array of hosts to construct the array with

array|null $opts

Array of options

bool|array _continuum()

No description

Return Value

bool|array

returns a list of points on continuum; may be useful with custom distributor function.

bool|callable _distributor()

No description

Return Value

bool|callable

returns a custom distributor function.

bool|callable _function()

No description

Return Value

bool|callable

the name of the function used to extract key parts during consistent hashing.

bool|array _hosts()

No description

Return Value

bool|array

list of hosts for the selected array or false

bool|null|Redis _instance(string $host)

No description

Parameters

string $host

The host you want to retrieve the instance for

Return Value

bool|null|Redis

a redis instance connected to a specific node

bool|null _rehash(callable $fn = null)

Use this function when a new node is added and keys need to be rehashed.

Parameters

callable $fn

Return Value

bool|null

rehash result

bool|string|null _target(string $key)

No description

Parameters

string $key

The key for which you want to lookup the host

Return Value

bool|string|null

the host to be used for a certain key

bool|RedisArray multi(string $host, int $mode = Redis::MULTI)

No description

Parameters

string $host Host
int $mode \Redis::MULTI|\Redis::PIPELINE

Return Value

bool|RedisArray

the host to be used for a certain key

bool|array info()

Returns a hosts array of associative array of strings and integers, with the following keys:

  • redis_version
  • redis_git_sha1
  • redis_git_dirty
  • redis_build_id
  • redis_mode
  • os
  • arch_bits
  • multiplexing_api
  • atomicvar_api
  • gcc_version
  • process_id
  • run_id
  • tcp_port
  • uptime_in_seconds
  • uptime_in_days
  • hz
  • lru_clock
  • executable
  • config_file
  • connected_clients
  • client_longest_output_list
  • client_biggest_input_buf
  • blocked_clients
  • used_memory
  • used_memory_human
  • used_memory_rss
  • used_memory_rss_human
  • used_memory_peak
  • used_memory_peak_human
  • used_memory_peak_perc
  • used_memory_peak
  • used_memory_overhead
  • used_memory_startup
  • used_memory_dataset
  • used_memory_dataset_perc
  • total_system_memory
  • total_system_memory_human
  • used_memory_lua
  • used_memory_lua_human
  • maxmemory
  • maxmemory_human
  • maxmemory_policy
  • mem_fragmentation_ratio
  • mem_allocator
  • active_defrag_running
  • lazyfree_pending_objects
  • mem_fragmentation_ratio
  • loading
  • rdb_changes_since_last_save
  • rdb_bgsave_in_progress
  • rdb_last_save_time
  • rdb_last_bgsave_status
  • rdb_last_bgsave_time_sec
  • rdb_current_bgsave_time_sec
  • rdb_last_cow_size
  • aof_enabled
  • aof_rewrite_in_progress
  • aof_rewrite_scheduled
  • aof_last_rewrite_time_sec
  • aof_current_rewrite_time_sec
  • aof_last_bgrewrite_status
  • aof_last_write_status
  • aof_last_cow_size
  • changes_since_last_save
  • aof_current_size
  • aof_base_size
  • aof_pending_rewrite
  • aof_buffer_length
  • aof_rewrite_buffer_length
  • aof_pending_bio_fsync
  • aof_delayed_fsync
  • loading_start_time
  • loading_total_bytes
  • loading_loaded_bytes
  • loading_loaded_perc
  • loading_eta_seconds
  • total_connections_received
  • total_commands_processed
  • instantaneous_ops_per_sec
  • total_net_input_bytes
  • total_net_output_bytes
  • instantaneous_input_kbps
  • instantaneous_output_kbps
  • rejected_connections
  • maxclients
  • sync_full
  • sync_partial_ok
  • sync_partial_err
  • expired_keys
  • evicted_keys
  • keyspace_hits
  • keyspace_misses
  • pubsub_channels
  • pubsub_patterns
  • latest_fork_usec
  • migrate_cached_sockets
  • slave_expires_tracked_keys
  • active_defrag_hits
  • active_defrag_misses
  • active_defrag_key_hits
  • active_defrag_key_misses
  • role
  • master_replid
  • master_replid2
  • master_repl_offset
  • second_repl_offset
  • repl_backlog_active
  • repl_backlog_size
  • repl_backlog_first_byte_offset
  • repl_backlog_histlen
  • master_host
  • master_port
  • master_link_status
  • master_last_io_seconds_ago
  • master_sync_in_progress
  • slave_repl_offset
  • slave_priority
  • slave_read_only
  • master_sync_left_bytes
  • master_sync_last_io_seconds_ago
  • master_link_down_since_seconds
  • connected_slaves
  • min-slaves-to-write
  • min-replicas-to-write
  • min_slaves_good_slaves
  • used_cpu_sys
  • used_cpu_user
  • used_cpu_sys_children
  • used_cpu_user_children
  • cluster_enabled

Return Value

bool|array

Examples

<pre>
$redis->info();
</pre>

array bgsave()

No description

Return Value

array

bool|int del(string|array $key, string ...$otherkeys)

No description

Parameters

string|array $key
string ...$otherkeys

Return Value

bool|int

bool|null discard()

No description

Return Value

bool|null

bool|null|array exec()

No description

Return Value

bool|null|array

bool|array flushall()

No description

Return Value

bool|array

bool|array flushdb()

No description

Return Value

bool|array

bool|array getOption(int $opt)

No description

Parameters

int $opt

Return Value

bool|array

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

No description

Parameters

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

Return Value

bool|array

bool|array keys(string $pattern)

No description

Parameters

string $pattern

Return Value

bool|array

bool|array mget(array $keys)

No description

Parameters

array $keys

Return Value

bool|array

bool mset(array $pairs)

No description

Parameters

array $pairs

Return Value

bool

bool|array ping()

No description

Return Value

bool|array

bool|array save()

No description

Return Value

bool|array

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

No description

Parameters

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

Return Value

bool|array

bool|array select(int $index)

No description

Parameters

int $index

Return Value

bool|array

bool|array setOption(int $opt, string $value)

No description

Parameters

int $opt
string $value

Return Value

bool|array

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

No description

Parameters

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

Return Value

bool|array

No description

Parameters

string|array $key
string ...$otherkeys

Return Value

bool|int

bool|null unwatch()

No description

Return Value

bool|null

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

No description

Parameters

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

Return Value

bool|array

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

No description

Parameters

string $subcmd
string ...$args

Return Value

mixed

RedisArray|int|false append(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisArray|int|false

RedisArray|bool auth(mixed $credentials)

No description

Parameters

mixed $credentials

Return Value

RedisArray|bool

RedisArray|bool bgrewriteaof()

No description

Return Value

RedisArray|bool

RedisArray|array|false waitaof(int $numlocal, int $numreplicas, int $timeout)

No description

Parameters

int $numlocal
int $numreplicas
int $timeout

Return Value

RedisArray|array|false

RedisArray|int|false 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

RedisArray|int|false

RedisArray|int|false bitop(string $operation, string $deskey, string $srckey, string ...$other_keys)

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|int|false 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

RedisArray|int|false

RedisArray|array|null|false blPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed ...$extra_args)

No description

Parameters

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

Return Value

RedisArray|array|null|false

RedisArray|array|null|false brPop(string|array $key_or_keys, string|float|int $timeout_or_key, mixed ...$extra_args)

No description

Parameters

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

Return Value

RedisArray|array|null|false

RedisArray|string|false brpoplpush(string $src, string $dst, int|float $timeout)

No description

Parameters

string $src
string $dst
int|float $timeout

Return Value

RedisArray|string|false

RedisArray|array|false bzPopMax(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)

No description

Parameters

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

Return Value

RedisArray|array|false

RedisArray|array|false bzPopMin(string|array $key, string|int $timeout_or_key, mixed ...$extra_args)

No description

Parameters

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

Return Value

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|array|null|false

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

No description

Parameters

array $keys
string $from
int $count

Return Value

RedisArray|array|null|false

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

No description

Parameters

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

Return Value

RedisArray|array|null|false

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

No description

Parameters

array $keys
string $from
int $count

Return Value

RedisArray|array|null|false

bool clearLastError()

No description

Return Value

bool

mixed client(string $opt, mixed ...$args)

No description

Parameters

string $opt
mixed ...$args

Return Value

mixed

bool close()

No description

Return Value

bool

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

No description

Parameters

string|null $opt
mixed ...$args

Return Value

mixed

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

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

No description

Parameters

string $src
string $dst
array|null $options

Return Value

RedisArray|bool

RedisArray|int|false dbSize()

No description

Return Value

RedisArray|int|false

RedisArray|string debug(string $key)

No description

Parameters

string $key

Return Value

RedisArray|string

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

No description

Parameters

string $key
int $by

Return Value

RedisArray|int|false

RedisArray|int|false decrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
array|null $options

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
mixed $value

Return Value

RedisArray|int|false

RedisArray|int|false delete(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisArray|int|false

RedisArray|string|false dump(string $key)

No description

Parameters

string $key

Return Value

RedisArray|string|false

RedisArray|string|false echo(string $str)

No description

Parameters

string $str

Return Value

RedisArray|string|false

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

No description

Parameters

string $script
array $args
int $num_keys

Return Value

mixed

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

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

No description

Parameters

string $sha1
array $args
int $num_keys

Return Value

mixed

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

No description

Parameters

string $sha1
array $args
int $num_keys

Return Value

mixed

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

No description

Parameters

mixed $key
mixed ...$other_keys

Return Value

RedisArray|int|bool

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

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

RedisArray|bool

RedisArray|bool expireAt(string $key, int $timestamp, string|null $mode = null)

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

RedisArray|bool

RedisArray|bool failover(array|null $to = null, bool $abort = false, int $timeout = 0)

No description

Parameters

array|null $to
bool $abort
int $timeout

Return Value

RedisArray|bool

RedisArray|int|false expiretime(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|int|false pexpiretime(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

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

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

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

No description

Parameters

string $fn
array $keys
array $args

Return Value

mixed

RedisArray|bool|string|array function(string $operation, mixed ...$args)

No description

Parameters

string $operation
mixed ...$args

Return Value

RedisArray|bool|string|array

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

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|float|false 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

RedisArray|float|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

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

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

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

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

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

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

No description

Parameters

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

Return Value

RedisArray|array|int|false

mixed get(string $key)

No description

Parameters

string $key

Return Value

mixed

RedisArray|array|false getWithMeta(string $key)

No description

Parameters

string $key

Return Value

RedisArray|array|false

mixed getAuth()

No description

Return Value

mixed

RedisArray|int|false getBit(string $key, int $idx)

No description

Parameters

string $key
int $idx

Return Value

RedisArray|int|false

RedisArray|string|bool getEx(string $key, array $options = [])

No description

Parameters

string $key
array $options

Return Value

RedisArray|string|bool

int getDBNum()

No description

Return Value

int

RedisArray|string|bool getDel(string $key)

No description

Parameters

string $key

Return Value

RedisArray|string|bool

string getHost()

No description

Return Value

string

string|null getLastError()

No description

Return Value

string|null

int getMode()

No description

Return Value

int

string|null getPersistentID()

No description

Return Value

string|null

int getPort()

No description

Return Value

int

string|false serverName()

No description

Return Value

string|false

string|false serverVersion()

No description

Return Value

string|false

RedisArray|string|false getRange(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisArray|string|false

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

No description

Parameters

string $key1
string $key2
array|null $options

Return Value

RedisArray|string|array|int|false

float getReadTimeout()

No description

Return Value

float

RedisArray|string|false getset(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisArray|string|false

float|false getTimeout()

No description

Return Value

float|false

array getTransferredBytes()

No description

Return Value

array

void clearTransferredBytes()

No description

Return Value

void

RedisArray|int|false hDel(string $key, string $field, string ...$other_fields)

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|bool hExists(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

RedisArray|bool

mixed hGet(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

RedisArray|array|false hGetAll(string $key)

No description

Parameters

string $key

Return Value

RedisArray|array|false

mixed hGetWithMeta(string $key, string $member)

No description

Parameters

string $key
string $member

Return Value

mixed

RedisArray|int|false hIncrBy(string $key, string $field, int $value)

No description

Parameters

string $key
string $field
int $value

Return Value

RedisArray|int|false

RedisArray|float|false hIncrByFloat(string $key, string $field, float $value)

No description

Parameters

string $key
string $field
float $value

Return Value

RedisArray|float|false

RedisArray|array|false hKeys(string $key)

No description

Parameters

string $key

Return Value

RedisArray|array|false

RedisArray|int|false hLen(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|array|false hMget(string $key, array $fields)

No description

Parameters

string $key
array $fields

Return Value

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
array $fields
array|null $expiry

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
array $fields

Return Value

RedisArray|array|false

RedisArray|bool hMset(string $key, array $fieldvals)

No description

Parameters

string $key
array $fieldvals

Return Value

RedisArray|bool

RedisArray|string|array|false hRandField(string $key, array|null $options = null)

No description

Parameters

string $key
array|null $options

Return Value

RedisArray|string|array|false

RedisArray|int|false hSet(string $key, mixed ...$fields_and_vals)

No description

Parameters

string $key
mixed ...$fields_and_vals

Return Value

RedisArray|int|false

RedisArray|bool hSetNx(string $key, string $field, mixed $value)

No description

Parameters

string $key
string $field
mixed $value

Return Value

RedisArray|bool

RedisArray|int|false hStrLen(string $key, string $field)

No description

Parameters

string $key
string $field

Return Value

RedisArray|int|false

RedisArray|array|false hVals(string $key)

No description

Parameters

string $key

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
array $fields

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
array $fields

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
array $fields

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
array $fields

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
array $fields

Return Value

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
string $field
int $timestamp

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
int $by

Return Value

RedisArray|int|false

RedisArray|int|false incrBy(string $key, int $value)

No description

Parameters

string $key
int $value

Return Value

RedisArray|int|false

RedisArray|float|false incrByFloat(string $key, float $value)

No description

Parameters

string $key
float $value

Return Value

RedisArray|float|false

bool isConnected()

No description

Return Value

bool

RedisArray|int|false lInsert(string $key, string $pos, mixed $pivot, mixed $value)

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|int|false lLen(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|string|false lMove(string $src, string $dst, string $wherefrom, string $whereto)

No description

Parameters

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

Return Value

RedisArray|string|false

RedisArray|string|false 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

RedisArray|string|false

RedisArray|bool|string|array lPop(string $key, int $count = 0)

No description

Parameters

string $key
int $count

Return Value

RedisArray|bool|string|array

RedisArray|null|bool|int|array lPos(string $key, mixed $value, array|null $options = null)

No description

Parameters

string $key
mixed $value
array|null $options

Return Value

RedisArray|null|bool|int|array

RedisArray|int|false lPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

RedisArray|int|false

RedisArray|int|false rPush(string $key, mixed ...$elements)

No description

Parameters

string $key
mixed ...$elements

Return Value

RedisArray|int|false

RedisArray|int|false lPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisArray|int|false

RedisArray|int|false rPushx(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

RedisArray|int|false

RedisArray|bool lSet(string $key, int $index, mixed $value)

No description

Parameters

string $key
int $index
mixed $value

Return Value

RedisArray|bool

int lastSave()

No description

Return Value

int

mixed lindex(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

mixed

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

No description

Parameters

string $key
int $start
int $end

Return Value

RedisArray|array|false

RedisArray|int|false lrem(string $key, mixed $value, int $count = 0)

No description

Parameters

string $key
mixed $value
int $count

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
int $start
int $end

Return Value

RedisArray|bool

RedisArray|bool move(string $key, int $index)

No description

Parameters

string $key
int $index

Return Value

RedisArray|bool

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

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|bool msetnx(array $key_values)

No description

Parameters

array $key_values

Return Value

RedisArray|bool

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

No description

Parameters

string $subcommand
string $key

Return Value

RedisArray|int|string|false

bool open(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

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

RedisArray|bool persist(string $key)

No description

Parameters

string $key

Return Value

RedisArray|bool

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

No description

Parameters

string $key
int $timeout
string|null $mode

Return Value

bool

RedisArray|bool pexpireAt(string $key, int $timestamp, string|null $mode = null)

No description

Parameters

string $key
int $timestamp
string|null $mode

Return Value

RedisArray|bool

RedisArray|int pfadd(string $key, array $elements)

No description

Parameters

string $key
array $elements

Return Value

RedisArray|int

RedisArray|int|false pfcount(array|string $key_or_keys)

No description

Parameters

array|string $key_or_keys

Return Value

RedisArray|int|false

RedisArray|bool pfmerge(string $dst, array $srckeys)

No description

Parameters

string $dst
array $srckeys

Return Value

RedisArray|bool

bool|RedisArray pipeline()

No description

Return Value

bool|RedisArray

bool popen(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

RedisArray|bool psetex(string $key, int $expire, mixed $value)

No description

Parameters

string $key
int $expire
mixed $value

Return Value

RedisArray|bool

bool psubscribe(array $patterns, callable $cb)

No description

Parameters

array $patterns
callable $cb

Return Value

bool

RedisArray|int|false pttl(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|int|false publish(string $channel, string $message)

No description

Parameters

string $channel
string $message

Return Value

RedisArray|int|false

mixed pubsub(string $command, mixed $arg = null)

No description

Parameters

string $command
mixed $arg

Return Value

mixed

RedisArray|array|bool punsubscribe(array $patterns)

No description

Parameters

array $patterns

Return Value

RedisArray|array|bool

RedisArray|array|string|bool rPop(string $key, int $count = 0)

No description

Parameters

string $key
int $count

Return Value

RedisArray|array|string|bool

RedisArray|string|false randomKey()

No description

Return Value

RedisArray|string|false

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

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

RedisArray|bool rename(string $old_name, string $new_name)

No description

Parameters

string $old_name
string $new_name

Return Value

RedisArray|bool

RedisArray|bool renameNx(string $key_src, string $key_dst)

No description

Parameters

string $key_src
string $key_dst

Return Value

RedisArray|bool

RedisArray|bool reset()

No description

Return Value

RedisArray|bool

RedisArray|bool 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

RedisArray|bool

mixed role()

No description

Return Value

mixed

RedisArray|string|false rpoplpush(string $srckey, string $dstkey)

No description

Parameters

string $srckey
string $dstkey

Return Value

RedisArray|string|false

RedisArray|int|false sAdd(string $key, mixed $value, mixed ...$other_values)

No description

Parameters

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

Return Value

RedisArray|int|false

int sAddArray(string $key, array $values)

No description

Parameters

string $key
array $values

Return Value

int

RedisArray|array|false sDiff(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisArray|array|false

RedisArray|int|false sDiffStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|array|false sInter(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisArray|array|false

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

No description

Parameters

array $keys
int $limit

Return Value

RedisArray|int|false

RedisArray|int|false sInterStore(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisArray|int|false

RedisArray|array|false sMembers(string $key)

No description

Parameters

string $key

Return Value

RedisArray|array|false

RedisArray|array|false sMisMember(string $key, string $member, string ...$other_members)

No description

Parameters

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

Return Value

RedisArray|array|false

RedisArray|bool sMove(string $src, string $dst, mixed $value)

No description

Parameters

string $src
string $dst
mixed $value

Return Value

RedisArray|bool

RedisArray|string|array|false sPop(string $key, int $count = 0)

No description

Parameters

string $key
int $count

Return Value

RedisArray|string|array|false

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

No description

Parameters

string $key
int $count

Return Value

mixed

RedisArray|array|false sUnion(string $key, string ...$other_keys)

No description

Parameters

string $key
string ...$other_keys

Return Value

RedisArray|array|false

RedisArray|int|false sUnionStore(string $dst, string $key, string ...$other_keys)

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|int|false scard(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

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

No description

Parameters

string $command
mixed ...$args

Return Value

mixed

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

No description

Parameters

string $key
mixed $value
mixed $options

Return Value

RedisArray|string|bool

RedisArray|int|false setBit(string $key, int $idx, bool $value)

No description

Parameters

string $key
int $idx
bool $value

Return Value

RedisArray|int|false

RedisArray|int|false setRange(string $key, int $index, string $value)

No description

Parameters

string $key
int $index
string $value

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
int $expire
mixed $value

Return Value

RedisArray|bool

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

No description

Parameters

string $key
mixed $value

Return Value

RedisArray|bool

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

No description

Parameters

string $key
mixed $value

Return Value

RedisArray|bool

RedisArray|bool slaveof(string|null $host = null, int $port = 6379)

No description

Parameters

string|null $host
int $port

Return Value

RedisArray|bool

RedisArray|bool replicaof(string|null $host = null, int $port = 6379)

No description

Parameters

string|null $host
int $port

Return Value

RedisArray|bool

RedisArray|int|false touch(array|string $key_or_array, string ...$more_keys)

No description

Parameters

array|string $key_or_array
string ...$more_keys

Return Value

RedisArray|int|false

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

No description

Parameters

string $operation
int $length

Return Value

mixed

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

No description

Parameters

string $key
array|null $options

Return Value

mixed

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

No description

Parameters

string $key
array|null $options

Return Value

mixed

array sortAsc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null)

No description

Parameters

string $key
string|null $pattern
mixed $get
int $offset
int $count
string|null $store

Return Value

array

array sortAscAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null)

No description

Parameters

string $key
string|null $pattern
mixed $get
int $offset
int $count
string|null $store

Return Value

array

array sortDesc(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null)

No description

Parameters

string $key
string|null $pattern
mixed $get
int $offset
int $count
string|null $store

Return Value

array

array sortDescAlpha(string $key, string|null $pattern = null, mixed $get = null, int $offset = -1, int $count = -1, string|null $store = null)

No description

Parameters

string $key
string|null $pattern
mixed $get
int $offset
int $count
string|null $store

Return Value

array

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

No description

Parameters

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

Return Value

RedisArray|int|false

bool ssubscribe(array $channels, callable $cb)

No description

Parameters

array $channels
callable $cb

Return Value

bool

RedisArray|int|false strlen(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

bool subscribe(array $channels, callable $cb)

No description

Parameters

array $channels
callable $cb

Return Value

bool

RedisArray|array|bool sunsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

RedisArray|array|bool

RedisArray|bool swapdb(int $src, int $dst)

No description

Parameters

int $src
int $dst

Return Value

RedisArray|bool

RedisArray|array time()

No description

Return Value

RedisArray|array

RedisArray|int|false ttl(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|int|false type(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|array|bool unsubscribe(array $channels)

No description

Parameters

array $channels

Return Value

RedisArray|array|bool

RedisArray|bool watch(array|string $key, string ...$other_keys)

No description

Parameters

array|string $key
string ...$other_keys

Return Value

RedisArray|bool

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

No description

Parameters

int $numreplicas
int $timeout

Return Value

int|false

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

No description

Parameters

string $key
string $group
array $ids

Return Value

int|false

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

No description

Parameters

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

Return Value

RedisArray|string|false

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

No description

Parameters

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

Return Value

RedisArray|bool|array

RedisArray|array|bool 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

RedisArray|array|bool

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

No description

Parameters

string $key
array $ids

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
array $ids
string|null $mode

Return Value

RedisArray|array|false

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

RedisArray|int|false xlen(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|array|bool

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

No description

Parameters

array $streams
int $count
int $block

Return Value

RedisArray|array|bool

RedisArray|array|bool 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

RedisArray|array|bool

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

No description

Parameters

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

Return Value

RedisArray|array|bool

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

No description

Parameters

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

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
mixed $member
array|null $options

Return Value

RedisArray|array|false

RedisArray|int|false vcard(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|int|false vdim(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|array|false vinfo(string $key)

No description

Parameters

string $key

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
mixed $member

Return Value

RedisArray|bool

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

No description

Parameters

string $key
mixed $member
bool $raw

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
int $count

Return Value

RedisArray|array|string|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

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

No description

Parameters

string $key
mixed $member

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
mixed $member
array|string $attributes

Return Value

RedisArray|int|false

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

No description

Parameters

string $key
mixed $member
bool $decode

Return Value

RedisArray|array|string|false

No description

Parameters

string $key
mixed $member
bool $withscores

Return Value

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|int|float|false zAdd(string $key, array|float $score_or_options, mixed ...$more_scores_and_mems)

No description

Parameters

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

Return Value

RedisArray|int|float|false

RedisArray|int|false zCard(string $key)

No description

Parameters

string $key

Return Value

RedisArray|int|false

RedisArray|int|false zCount(string $key, int|string $start, int|string $end)

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|float|false zIncrBy(string $key, float $value, mixed $member)

No description

Parameters

string $key
float $value
mixed $member

Return Value

RedisArray|float|false

RedisArray|int|false zLexCount(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisArray|int|false

RedisArray|array|false zMscore(string $key, mixed $member, mixed ...$other_members)

No description

Parameters

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

Return Value

RedisArray|array|false

RedisArray|array|false zPopMax(string $key, int|null $count = null)

No description

Parameters

string $key
int|null $count

Return Value

RedisArray|array|false

RedisArray|array|false zPopMin(string $key, int|null $count = null)

No description

Parameters

string $key
int|null $count

Return Value

RedisArray|array|false

RedisArray|array|false 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

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

RedisArray|array|false zRangeByScore(string $key, string $start, string $end, array $options = [])

No description

Parameters

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

Return Value

RedisArray|array|false

RedisArray|string|array zRandMember(string $key, array|null $options = null)

No description

Parameters

string $key
array|null $options

Return Value

RedisArray|string|array

RedisArray|int|false zRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisArray|int|false

RedisArray|int|false zRem(mixed $key, mixed $member, mixed ...$other_members)

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|int|false zRemRangeByLex(string $key, string $min, string $max)

No description

Parameters

string $key
string $min
string $max

Return Value

RedisArray|int|false

RedisArray|int|false zRemRangeByRank(string $key, int $start, int $end)

No description

Parameters

string $key
int $start
int $end

Return Value

RedisArray|int|false

RedisArray|int|false zRemRangeByScore(string $key, string $start, string $end)

No description

Parameters

string $key
string $start
string $end

Return Value

RedisArray|int|false

RedisArray|array|false zRevRange(string $key, int $start, int $end, mixed $scores = null)

No description

Parameters

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

Return Value

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

RedisArray|array|false zRevRangeByScore(string $key, string $max, string $min, array|bool $options = [])

No description

Parameters

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

Return Value

RedisArray|array|false

RedisArray|int|false zRevRank(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisArray|int|false

RedisArray|float|false zScore(string $key, mixed $member)

No description

Parameters

string $key
mixed $member

Return Value

RedisArray|float|false

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

No description

Parameters

array $keys
array|null $options

Return Value

RedisArray|array|false

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

No description

Parameters

string $dst
array $keys

Return Value

RedisArray|int|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

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

No description

Parameters

array $keys
int $limit

Return Value

RedisArray|int|false

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

No description

Parameters

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

Return Value

RedisArray|int|false

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

No description

Parameters

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

Return Value

RedisArray|array|false

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

No description

Parameters

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

Return Value

RedisArray|int|false

RedisArray|string|false digest(string $key)

No description

Parameters

string $key

Return Value

RedisArray|string|false