Interface yii\redis\ConnectionInterface
| Implemented by | yii\redis\Connection, yii\redis\predis\PredisConnection |
|---|---|
| Source Code | https://github.com/yiisoft/yii2-redis/blob/master/src/ConnectionInterface.php |
The execution of redis commands is possible with via executeCommand().
Public Methods
| Method | Description | Defined By |
|---|---|---|
| append() | Append a value to a key. | yii\redis\ConnectionInterface |
| auth() | Authenticate to the server. | yii\redis\ConnectionInterface |
| bgrewriteaof() | Asynchronously rewrite the append-only file. | yii\redis\ConnectionInterface |
| bgsave() | Asynchronously save the dataset to disk. | yii\redis\ConnectionInterface |
| bitcount() | Count set bits in a string. | yii\redis\ConnectionInterface |
| bitfield() | Perform arbitrary bitfield integer operations on strings. | yii\redis\ConnectionInterface |
| bitop() | Perform bitwise operations between strings. | yii\redis\ConnectionInterface |
| bitpos() | Find first bit set or clear in a string. | yii\redis\ConnectionInterface |
| blpop() | Remove and get the first element in a list, or block until one is available. | yii\redis\ConnectionInterface |
| brpop() | Remove and get the last element in a list, or block until one is available. | yii\redis\ConnectionInterface |
| brpoplpush() | Pop a value from a list, push it to another list and return it; or block until one is available. | yii\redis\ConnectionInterface |
| clientGetname() | Get the current connection name. | yii\redis\ConnectionInterface |
| clientKill() | Kill the connection of a client. | yii\redis\ConnectionInterface |
| clientList() | Get the list of client connections. | yii\redis\ConnectionInterface |
| clientPause() | Stop processing commands from clients for some time. | yii\redis\ConnectionInterface |
| clientReply() | Instruct the server whether to reply to commands. | yii\redis\ConnectionInterface |
| clientSetname() | Set the current connection name. | yii\redis\ConnectionInterface |
| close() | yii\redis\ConnectionInterface | |
| clusterAddslots() | Assign new hash slots to receiving node. | yii\redis\ConnectionInterface |
| clusterCountkeysinslot() | Return the number of local keys in the specified hash slot. | yii\redis\ConnectionInterface |
| clusterDelslots() | Set hash slots as unbound in receiving node. | yii\redis\ConnectionInterface |
| clusterFailover() | Forces a slave to perform a manual failover of its master.. | yii\redis\ConnectionInterface |
| clusterForget() | Remove a node from the nodes table. | yii\redis\ConnectionInterface |
| clusterGetkeysinslot() | Return local key names in the specified hash slot. | yii\redis\ConnectionInterface |
| clusterInfo() | Provides info about Redis Cluster node state. | yii\redis\ConnectionInterface |
| clusterKeyslot() | Returns the hash slot of the specified key. | yii\redis\ConnectionInterface |
| clusterMeet() | Force a node cluster to handshake with another node. | yii\redis\ConnectionInterface |
| clusterNodes() | Get Cluster config for the node. | yii\redis\ConnectionInterface |
| clusterReplicate() | Reconfigure a node as a slave of the specified master node. | yii\redis\ConnectionInterface |
| clusterReset() | Reset a Redis Cluster node. | yii\redis\ConnectionInterface |
| clusterSaveconfig() | Forces the node to save cluster state on disk. | yii\redis\ConnectionInterface |
| clusterSetslot() | Bind a hash slot to a specific node. | yii\redis\ConnectionInterface |
| clusterSlaves() | List slave nodes of the specified master node. | yii\redis\ConnectionInterface |
| clusterSlots() | Get array of Cluster slot to node mappings. | yii\redis\ConnectionInterface |
| command() | Get array of Redis command details. | yii\redis\ConnectionInterface |
| commandCount() | Get total number of Redis commands. | yii\redis\ConnectionInterface |
| commandGetkeys() | Extract keys given a full Redis command. | yii\redis\ConnectionInterface |
| commandInfo() | Get array of specific Redis command details. | yii\redis\ConnectionInterface |
| configGet() | Get the value of a configuration parameter. | yii\redis\ConnectionInterface |
| configResetstat() | Reset the stats returned by INFO. | yii\redis\ConnectionInterface |
| configRewrite() | Rewrite the configuration file with the in memory configuration. | yii\redis\ConnectionInterface |
| configSet() | Set a configuration parameter to the given value. | yii\redis\ConnectionInterface |
| dbsize() | Return the number of keys in the selected database. | yii\redis\ConnectionInterface |
| debugObject() | Get debugging information about a key. | yii\redis\ConnectionInterface |
| debugSegfault() | Make the server crash. | yii\redis\ConnectionInterface |
| decr() | Decrement the integer value of a key by one. | yii\redis\ConnectionInterface |
| decrby() | Decrement the integer value of a key by the given number. | yii\redis\ConnectionInterface |
| del() | Delete a key. | yii\redis\ConnectionInterface |
| discard() | Discard all commands issued after MULTI. | yii\redis\ConnectionInterface |
| dump() | Return a serialized version of the value stored at the specified key.. | yii\redis\ConnectionInterface |
| echo() | Echo the given string. | yii\redis\ConnectionInterface |
| eval() | Execute a Lua script server side. | yii\redis\ConnectionInterface |
| evalsha() | Execute a Lua script server side. | yii\redis\ConnectionInterface |
| exec() | Execute all commands issued after MULTI. | yii\redis\ConnectionInterface |
| executeCommand() | yii\redis\ConnectionInterface | |
| exists() | Determine if a key exists. | yii\redis\ConnectionInterface |
| expire() | Set a key's time to live in seconds. | yii\redis\ConnectionInterface |
| expireat() | Set the expiration for a key as a UNIX timestamp. | yii\redis\ConnectionInterface |
| flushall() | Remove all keys from all databases. | yii\redis\ConnectionInterface |
| flushdb() | Remove all keys from the current database. | yii\redis\ConnectionInterface |
| geoadd() | Add one or more geospatial items in the geospatial index represented using a sorted set. | yii\redis\ConnectionInterface |
| geodist() | Returns the distance between two members of a geospatial index. | yii\redis\ConnectionInterface |
| geohash() | Returns members of a geospatial index as standard geohash strings. | yii\redis\ConnectionInterface |
| geopos() | Returns longitude and latitude of members of a geospatial index. | yii\redis\ConnectionInterface |
| georadius() | Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point. | yii\redis\ConnectionInterface |
| georadiusbymember() | Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member. | yii\redis\ConnectionInterface |
| get() | Get the value of a key. | yii\redis\ConnectionInterface |
| getIsActive() | yii\redis\ConnectionInterface | |
| getbit() | Returns the bit value at offset in the string value stored at key. | yii\redis\ConnectionInterface |
| getrange() | Get a substring of the string stored at a key. | yii\redis\ConnectionInterface |
| getset() | Set the string value of a key and return its old value. | yii\redis\ConnectionInterface |
| hdel() | Delete one or more hash fields. | yii\redis\ConnectionInterface |
| hexists() | Determine if a hash field exists. | yii\redis\ConnectionInterface |
| hget() | Get the value of a hash field. | yii\redis\ConnectionInterface |
| hgetall() | Get all the fields and values in a hash. | yii\redis\ConnectionInterface |
| hincrby() | Increment the integer value of a hash field by the given number. | yii\redis\ConnectionInterface |
| hincrbyfloat() | Increment the float value of a hash field by the given amount. | yii\redis\ConnectionInterface |
| hkeys() | Get all the fields in a hash. | yii\redis\ConnectionInterface |
| hlen() | Get the number of fields in a hash. | yii\redis\ConnectionInterface |
| hmget() | Get the values of all the given hash fields. | yii\redis\ConnectionInterface |
| hmset() | Set multiple hash fields to multiple values. | yii\redis\ConnectionInterface |
| hscan() | Incrementally iterate hash fields and associated values. | yii\redis\ConnectionInterface |
| hset() | Set the string value of a hash field. | yii\redis\ConnectionInterface |
| hsetnx() | Set the value of a hash field, only if the field does not exist. | yii\redis\ConnectionInterface |
| hstrlen() | Get the length of the value of a hash field. | yii\redis\ConnectionInterface |
| hvals() | Get all the values in a hash. | yii\redis\ConnectionInterface |
| incr() | Increment the integer value of a key by one. | yii\redis\ConnectionInterface |
| incrby() | Increment the integer value of a key by the given amount. | yii\redis\ConnectionInterface |
| incrbyfloat() | Increment the float value of a key by the given amount. | yii\redis\ConnectionInterface |
| info() | Get information and statistics about the server. | yii\redis\ConnectionInterface |
| keys() | Find all keys matching the given pattern. | yii\redis\ConnectionInterface |
| lastsave() | Get the UNIX time stamp of the last successful save to disk. | yii\redis\ConnectionInterface |
| lindex() | Get an element from a list by its index. | yii\redis\ConnectionInterface |
| linsert() | Insert an element before or after another element in a list. | yii\redis\ConnectionInterface |
| llen() | Get the length of a list. | yii\redis\ConnectionInterface |
| lpop() | Remove and get the first element in a list. | yii\redis\ConnectionInterface |
| lpush() | Prepend one or multiple values to a list. | yii\redis\ConnectionInterface |
| lpushx() | Prepend a value to a list, only if the list exists. | yii\redis\ConnectionInterface |
| lrange() | Get a range of elements from a list. | yii\redis\ConnectionInterface |
| lrem() | Remove elements from a list. | yii\redis\ConnectionInterface |
| lset() | Set the value of an element in a list by its index. | yii\redis\ConnectionInterface |
| ltrim() | Trim a list to the specified range. | yii\redis\ConnectionInterface |
| mget() | Get the values of all the given keys. | yii\redis\ConnectionInterface |
| migrate() | Atomically transfer a key from a Redis instance to another one.. | yii\redis\ConnectionInterface |
| monitor() | Listen for all requests received by the server in real time. | yii\redis\ConnectionInterface |
| move() | Move a key to another database. | yii\redis\ConnectionInterface |
| mset() | Set multiple keys to multiple values. | yii\redis\ConnectionInterface |
| msetnx() | Set multiple keys to multiple values, only if none of the keys exist. | yii\redis\ConnectionInterface |
| multi() | Mark the start of a transaction block. | yii\redis\ConnectionInterface |
| object() | Inspect the internals of Redis objects. | yii\redis\ConnectionInterface |
| open() | yii\redis\ConnectionInterface | |
| persist() | Remove the expiration from a key. | yii\redis\ConnectionInterface |
| pexpire() | Set a key's time to live in milliseconds. | yii\redis\ConnectionInterface |
| pexpireat() | Set the expiration for a key as a UNIX timestamp specified in milliseconds. | yii\redis\ConnectionInterface |
| pfadd() | Adds the specified elements to the specified HyperLogLog.. | yii\redis\ConnectionInterface |
| pfcount() | Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).. | yii\redis\ConnectionInterface |
| pfmerge() | Merge N different HyperLogLogs into a single one.. | yii\redis\ConnectionInterface |
| ping() | Ping the server. | yii\redis\ConnectionInterface |
| psetex() | Set the value and expiration in milliseconds of a key. | yii\redis\ConnectionInterface |
| psubscribe() | Listen for messages published to channels matching the given patterns. | yii\redis\ConnectionInterface |
| pttl() | Get the time to live for a key in milliseconds. | yii\redis\ConnectionInterface |
| publish() | Post a message to a channel. | yii\redis\ConnectionInterface |
| pubsub() | Inspect the state of the Pub/Sub subsystem. | yii\redis\ConnectionInterface |
| punsubscribe() | Stop listening for messages posted to channels matching the given patterns. | yii\redis\ConnectionInterface |
| quit() | Close the connection. | yii\redis\ConnectionInterface |
| randomkey() | Return a random key from the keyspace. | yii\redis\ConnectionInterface |
| readonly() | Enables read queries for a connection to a cluster slave node. | yii\redis\ConnectionInterface |
| readwrite() | Disables read queries for a connection to a cluster slave node. | yii\redis\ConnectionInterface |
| rename() | Rename a key. | yii\redis\ConnectionInterface |
| renamenx() | Rename a key, only if the new key does not exist. | yii\redis\ConnectionInterface |
| restore() | Create a key using the provided serialized value, previously obtained using DUMP.. | yii\redis\ConnectionInterface |
| role() | Return the role of the instance in the context of replication. | yii\redis\ConnectionInterface |
| rpop() | Remove and get the last element in a list. | yii\redis\ConnectionInterface |
| rpoplpush() | Remove the last element in a list, prepend it to another list and return it. | yii\redis\ConnectionInterface |
| rpush() | Append one or multiple values to a list. | yii\redis\ConnectionInterface |
| rpushx() | Append a value to a list, only if the list exists. | yii\redis\ConnectionInterface |
| sadd() | Add one or more members to a set. | yii\redis\ConnectionInterface |
| save() | Synchronously save the dataset to disk. | yii\redis\ConnectionInterface |
| scan() | Incrementally iterate the keys space. | yii\redis\ConnectionInterface |
| scard() | Get the number of members in a set. | yii\redis\ConnectionInterface |
| scriptDebug() | Set the debug mode for executed scripts.. | yii\redis\ConnectionInterface |
| scriptExists() | Check existence of scripts in the script cache.. | yii\redis\ConnectionInterface |
| scriptFlush() | Remove all the scripts from the script cache.. | yii\redis\ConnectionInterface |
| scriptKill() | Kill the script currently in execution.. | yii\redis\ConnectionInterface |
| scriptLoad() | Load the specified Lua script into the script cache.. | yii\redis\ConnectionInterface |
| sdiff() | Subtract multiple sets. | yii\redis\ConnectionInterface |
| sdiffstore() | Subtract multiple sets and store the resulting set in a key. | yii\redis\ConnectionInterface |
| select() | Change the selected database for the current connection. | yii\redis\ConnectionInterface |
| set() | Set the string value of a key. | yii\redis\ConnectionInterface |
| setbit() | Sets or clears the bit at offset in the string value stored at key. | yii\redis\ConnectionInterface |
| setex() | Set the value and expiration of a key. | yii\redis\ConnectionInterface |
| setnx() | Set the value of a key, only if the key does not exist. | yii\redis\ConnectionInterface |
| setrange() | Overwrite part of a string at key starting at the specified offset. | yii\redis\ConnectionInterface |
| shutdown() | Synchronously save the dataset to disk and then shut down the server. | yii\redis\ConnectionInterface |
| sinter() | Intersect multiple sets. | yii\redis\ConnectionInterface |
| sinterstore() | Intersect multiple sets and store the resulting set in a key. | yii\redis\ConnectionInterface |
| sismember() | Determine if a given value is a member of a set. | yii\redis\ConnectionInterface |
| slaveof() | Make the server a slave of another instance, or promote it as master. | yii\redis\ConnectionInterface |
| slowlog() | Manages the Redis slow queries log. | yii\redis\ConnectionInterface |
| smembers() | Get all the members in a set. | yii\redis\ConnectionInterface |
| smove() | Move a member from one set to another. | yii\redis\ConnectionInterface |
| sort() | Sort the elements in a list, set or sorted set. | yii\redis\ConnectionInterface |
| spop() | Remove and return one or multiple random members from a set. | yii\redis\ConnectionInterface |
| srandmember() | Get one or multiple random members from a set. | yii\redis\ConnectionInterface |
| srem() | Remove one or more members from a set. | yii\redis\ConnectionInterface |
| sscan() | Incrementally iterate Set elements. | yii\redis\ConnectionInterface |
| strlen() | Get the length of the value stored in a key. | yii\redis\ConnectionInterface |
| subscribe() | Listen for messages published to the given channels. | yii\redis\ConnectionInterface |
| sunion() | Add multiple sets. | yii\redis\ConnectionInterface |
| sunionstore() | Add multiple sets and store the resulting set in a key. | yii\redis\ConnectionInterface |
| swapdb() | Swaps two Redis databases. | yii\redis\ConnectionInterface |
| sync() | Internal command used for replication. | yii\redis\ConnectionInterface |
| time() | Return the current server time. | yii\redis\ConnectionInterface |
| touch() | Alters the last access time of a key(s). | yii\redis\ConnectionInterface |
| ttl() | Get the time to live for a key. | yii\redis\ConnectionInterface |
| type() | Determine the type stored at key. | yii\redis\ConnectionInterface |
| unlink() | Delete a key asynchronously in another thread. | yii\redis\ConnectionInterface |
| unsubscribe() | Stop listening for messages posted to the given channels. | yii\redis\ConnectionInterface |
| unwatch() | Forget about all watched keys. | yii\redis\ConnectionInterface |
| wait() | Wait for the synchronous replication of all the write commands sent in the context of the current connection. | yii\redis\ConnectionInterface |
| watch() | Watch the given keys to determine execution of the MULTI/EXEC block. | yii\redis\ConnectionInterface |
| xack() | Removes one or multiple messages from the pending entries list (PEL) of a stream consumer group https://redis.io/commands/xack | yii\redis\ConnectionInterface |
| xadd() | Appends the specified stream entry to the stream at the specified key https://redis.io/commands/xadd | yii\redis\ConnectionInterface |
| xclaim() | Changes the ownership of a pending message, so that the new owner is the consumer specified as the command argument https://redis.io/commands/xclaim | yii\redis\ConnectionInterface |
| xdel() | Removes the specified entries from a stream, and returns the number of entries deleted https://redis.io/commands/xdel | yii\redis\ConnectionInterface |
| xgroup() | Manages the consumer groups associated with a stream data structure https://redis.io/commands/xgroup | yii\redis\ConnectionInterface |
| xinfo() | Retrieves different information about the streams and associated consumer groups https://redis.io/commands/xinfo | yii\redis\ConnectionInterface |
| xlen() | Returns the number of entries inside a stream https://redis.io/commands/xlen | yii\redis\ConnectionInterface |
| xpending() | Fetching data from a stream via a consumer group, and not acknowledging such data, has the effect of creating pending entries https://redis.io/commands/xpending | yii\redis\ConnectionInterface |
| xrange() | Returns the stream entries matching a given range of IDs https://redis.io/commands/xrange | yii\redis\ConnectionInterface |
| xread() | Read data from one or multiple streams, only returning entries with an ID greater than the last received ID reported by the caller https://redis.io/commands/xread | yii\redis\ConnectionInterface |
| xreadgroup() | Special version of the XREAD command with support for consumer groups https://redis.io/commands/xreadgroup | yii\redis\ConnectionInterface |
| xrevrange() | Exactly like XRANGE, but with the notable difference of returning the entries in reverse order, and also taking the start-end range in reverse order https://redis.io/commands/xrevrange | yii\redis\ConnectionInterface |
| xtrim() | Trims the stream to a given number of items, evicting older items (items with lower IDs) if needed https://redis.io/commands/xtrim | yii\redis\ConnectionInterface |
| zadd() | Add one or more members to a sorted set, or update its score if it already exists. | yii\redis\ConnectionInterface |
| zcard() | Get the number of members in a sorted set. | yii\redis\ConnectionInterface |
| zcount() | Count the members in a sorted set with scores within the given values. | yii\redis\ConnectionInterface |
| zincrby() | Increment the score of a member in a sorted set. | yii\redis\ConnectionInterface |
| zinterstore() | Intersect multiple sorted sets and store the resulting sorted set in a new key. | yii\redis\ConnectionInterface |
| zlexcount() | Count the number of members in a sorted set between a given lexicographical range. | yii\redis\ConnectionInterface |
| zrange() | Return a range of members in a sorted set, by index. | yii\redis\ConnectionInterface |
| zrangebylex() | Return a range of members in a sorted set, by lexicographical range. | yii\redis\ConnectionInterface |
| zrangebyscore() | Return a range of members in a sorted set, by score. | yii\redis\ConnectionInterface |
| zrank() | Determine the index of a member in a sorted set. | yii\redis\ConnectionInterface |
| zrem() | Remove one or more members from a sorted set. | yii\redis\ConnectionInterface |
| zremrangebylex() | Remove all members in a sorted set between the given lexicographical range. | yii\redis\ConnectionInterface |
| zremrangebyrank() | Remove all members in a sorted set within the given indexes. | yii\redis\ConnectionInterface |
| zremrangebyscore() | Remove all members in a sorted set within the given scores. | yii\redis\ConnectionInterface |
| zrevrange() | Return a range of members in a sorted set, by index, with scores ordered from high to low. | yii\redis\ConnectionInterface |
| zrevrangebylex() | Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings.. | yii\redis\ConnectionInterface |
| zrevrangebyscore() | Return a range of members in a sorted set, by score, with scores ordered from high to low. | yii\redis\ConnectionInterface |
| zrevrank() | Determine the index of a member in a sorted set, with scores ordered from high to low. | yii\redis\ConnectionInterface |
| zscan() | Incrementally iterate sorted sets elements and associated scores. | yii\redis\ConnectionInterface |
| zscore() | Get the score associated with the given member in a sorted set. | yii\redis\ConnectionInterface |
| zunionstore() | Add multiple sorted sets and store the resulting sorted set in a new key. | yii\redis\ConnectionInterface |
Method Details
Append a value to a key.
| public abstract mixed append ( mixed $key, mixed $value ) | ||
| $key | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Authenticate to the server.
| public abstract mixed auth ( mixed $password ) | ||
| $password | mixed | |
| return | mixed | |
|---|---|---|
Asynchronously rewrite the append-only file.
| public abstract mixed bgrewriteaof ( ) | ||
| return | mixed | |
|---|---|---|
Count set bits in a string.
| public abstract mixed bitcount ( mixed $key, mixed $start, mixed $end ) | ||
| $key | mixed | |
| $start | mixed | |
| $end | mixed | |
| return | mixed | |
|---|---|---|
Perform arbitrary bitfield integer operations on strings.
| public abstract mixed bitfield ( mixed $key, mixed $operations ) | ||
| $key | mixed | |
| $operations | mixed | |
| return | mixed | |
|---|---|---|
Perform bitwise operations between strings.
| public abstract mixed bitop ( mixed $operation, mixed $destkey, mixed $keys ) | ||
| $operation | mixed | |
| $destkey | mixed | |
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Find first bit set or clear in a string.
| public abstract mixed bitpos ( mixed $key, mixed $bit, mixed $start, mixed $end ) | ||
| $key | mixed | |
| $bit | mixed | |
| $start | mixed | |
| $end | mixed | |
| return | mixed | |
|---|---|---|
Remove and get the first element in a list, or block until one is available.
| public abstract mixed blpop ( mixed $keys, mixed $timeout ) | ||
| $keys | mixed | |
| $timeout | mixed | |
| return | mixed | |
|---|---|---|
Remove and get the last element in a list, or block until one is available.
| public abstract mixed brpop ( mixed $keys, mixed $timeout ) | ||
| $keys | mixed | |
| $timeout | mixed | |
| return | mixed | |
|---|---|---|
Pop a value from a list, push it to another list and return it; or block until one is available.
| public abstract mixed brpoplpush ( mixed $source, mixed $destination, mixed $timeout ) | ||
| $source | mixed | |
| $destination | mixed | |
| $timeout | mixed | |
| return | mixed | |
|---|---|---|
Get the current connection name.
| public abstract mixed clientGetname ( ) | ||
| return | mixed | |
|---|---|---|
Kill the connection of a client.
| public abstract mixed clientKill ( mixed $filters ) | ||
| $filters | mixed | |
| return | mixed | |
|---|---|---|
Get the list of client connections.
| public abstract mixed clientList ( ) | ||
| return | mixed | |
|---|---|---|
Stop processing commands from clients for some time.
| public abstract mixed clientPause ( mixed $timeout ) | ||
| $timeout | mixed | |
| return | mixed | |
|---|---|---|
Instruct the server whether to reply to commands.
| public abstract mixed clientReply ( mixed $option ) | ||
| $option | mixed | |
| return | mixed | |
|---|---|---|
Set the current connection name.
| public abstract mixed clientSetname ( mixed $connectionName ) | ||
| $connectionName | mixed | |
| return | mixed | |
|---|---|---|
Assign new hash slots to receiving node.
| public abstract mixed clusterAddslots ( mixed $slots ) | ||
| $slots | mixed | |
| return | mixed | |
|---|---|---|
Return the number of local keys in the specified hash slot.
| public abstract mixed clusterCountkeysinslot ( mixed $slot ) | ||
| $slot | mixed | |
| return | mixed | |
|---|---|---|
Set hash slots as unbound in receiving node.
| public abstract mixed clusterDelslots ( mixed $slots ) | ||
| $slots | mixed | |
| return | mixed | |
|---|---|---|
Forces a slave to perform a manual failover of its master..
| public abstract mixed clusterFailover ( mixed $option ) | ||
| $option | mixed | |
| return | mixed | |
|---|---|---|
Remove a node from the nodes table.
| public abstract mixed clusterForget ( mixed $nodeId ) | ||
| $nodeId | mixed | |
| return | mixed | |
|---|---|---|
Return local key names in the specified hash slot.
| public abstract mixed clusterGetkeysinslot ( mixed $slot, mixed $count ) | ||
| $slot | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Provides info about Redis Cluster node state.
| public abstract mixed clusterInfo ( ) | ||
| return | mixed | |
|---|---|---|
Returns the hash slot of the specified key.
| public abstract mixed clusterKeyslot ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Force a node cluster to handshake with another node.
| public abstract mixed clusterMeet ( mixed $ip, mixed $port ) | ||
| $ip | mixed | |
| $port | mixed | |
| return | mixed | |
|---|---|---|
Get Cluster config for the node.
| public abstract mixed clusterNodes ( ) | ||
| return | mixed | |
|---|---|---|
Reconfigure a node as a slave of the specified master node.
| public abstract mixed clusterReplicate ( mixed $nodeId ) | ||
| $nodeId | mixed | |
| return | mixed | |
|---|---|---|
Reset a Redis Cluster node.
| public abstract mixed clusterReset ( mixed $resetType ) | ||
| $resetType | mixed | |
| return | mixed | |
|---|---|---|
Forces the node to save cluster state on disk.
| public abstract mixed clusterSaveconfig ( ) | ||
| return | mixed | |
|---|---|---|
Bind a hash slot to a specific node.
| public abstract mixed clusterSetslot ( mixed $slot, mixed $type, mixed $nodeid ) | ||
| $slot | mixed | |
| $type | mixed | |
| $nodeid | mixed | |
| return | mixed | |
|---|---|---|
List slave nodes of the specified master node.
| public abstract mixed clusterSlaves ( mixed $nodeId ) | ||
| $nodeId | mixed | |
| return | mixed | |
|---|---|---|
Get array of Cluster slot to node mappings.
| public abstract mixed clusterSlots ( ) | ||
| return | mixed | |
|---|---|---|
Get total number of Redis commands.
| public abstract mixed commandCount ( ) | ||
| return | mixed | |
|---|---|---|
Extract keys given a full Redis command.
| public abstract mixed commandGetkeys ( ) | ||
| return | mixed | |
|---|---|---|
Get array of specific Redis command details.
| public abstract mixed commandInfo ( mixed $commandNames ) | ||
| $commandNames | mixed | |
| return | mixed | |
|---|---|---|
Get the value of a configuration parameter.
| public abstract mixed configGet ( mixed $parameter ) | ||
| $parameter | mixed | |
| return | mixed | |
|---|---|---|
Reset the stats returned by INFO.
| public abstract mixed configResetstat ( ) | ||
| return | mixed | |
|---|---|---|
Rewrite the configuration file with the in memory configuration.
| public abstract mixed configRewrite ( ) | ||
| return | mixed | |
|---|---|---|
Set a configuration parameter to the given value.
| public abstract mixed configSet ( mixed $parameter, mixed $value ) | ||
| $parameter | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Get debugging information about a key.
| public abstract mixed debugObject ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Make the server crash.
| public abstract mixed debugSegfault ( ) | ||
| return | mixed | |
|---|---|---|
Decrement the integer value of a key by one.
| public abstract mixed decr ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Decrement the integer value of a key by the given number.
| public abstract mixed decrby ( mixed $key, mixed $decrement ) | ||
| $key | mixed | |
| $decrement | mixed | |
| return | mixed | |
|---|---|---|
Return a serialized version of the value stored at the specified key..
| public abstract mixed dump ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Execute a Lua script server side.
| public abstract mixed eval ( mixed $script, mixed $numkeys, mixed $keys, mixed $args ) | ||
| $script | mixed | |
| $numkeys | mixed | |
| $keys | mixed | |
| $args | mixed | |
| return | mixed | |
|---|---|---|
Execute a Lua script server side.
| public abstract mixed evalsha ( mixed $sha1, mixed $numkeys, mixed $keys, mixed $args ) | ||
| $sha1 | mixed | |
| $numkeys | mixed | |
| $keys | mixed | |
| $args | mixed | |
| return | mixed | |
|---|---|---|
| public abstract mixed executeCommand ( mixed $name, mixed $params = [] ) | ||
| $name | mixed | |
| $params | mixed | |
public function executeCommand($name, $params = []);
Set a key's time to live in seconds.
| public abstract mixed expire ( mixed $key, mixed $seconds ) | ||
| $key | mixed | |
| $seconds | mixed | |
| return | mixed | |
|---|---|---|
Set the expiration for a key as a UNIX timestamp.
| public abstract mixed expireat ( mixed $key, mixed $timestamp ) | ||
| $key | mixed | |
| $timestamp | mixed | |
| return | mixed | |
|---|---|---|
Remove all keys from all databases.
| public abstract mixed flushall ( mixed $ASYNC ) | ||
| $ASYNC | mixed | |
| return | mixed | |
|---|---|---|
Remove all keys from the current database.
| public abstract mixed flushdb ( mixed $ASYNC ) | ||
| $ASYNC | mixed | |
| return | mixed | |
|---|---|---|
Add one or more geospatial items in the geospatial index represented using a sorted set.
| public abstract mixed geoadd ( mixed $key, mixed $longitude, mixed $latitude, mixed $member, mixed $more ) | ||
| $key | mixed | |
| $longitude | mixed | |
| $latitude | mixed | |
| $member | mixed | |
| $more | mixed | |
| return | mixed | |
|---|---|---|
Returns the distance between two members of a geospatial index.
| public abstract mixed geodist ( mixed $key, mixed $member1, mixed $member2, mixed $unit ) | ||
| $key | mixed | |
| $member1 | mixed | |
| $member2 | mixed | |
| $unit | mixed | |
| return | mixed | |
|---|---|---|
Returns members of a geospatial index as standard geohash strings.
| public abstract mixed geohash ( mixed $key, mixed $members ) | ||
| $key | mixed | |
| $members | mixed | |
| return | mixed | |
|---|---|---|
Returns longitude and latitude of members of a geospatial index.
| public abstract mixed geopos ( mixed $key, mixed $members ) | ||
| $key | mixed | |
| $members | mixed | |
| return | mixed | |
|---|---|---|
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point.
| public abstract mixed georadius ( mixed $key, mixed $longitude, mixed $latitude, mixed $radius, mixed $metric, mixed $options ) | ||
| $key | mixed | |
| $longitude | mixed | |
| $latitude | mixed | |
| $radius | mixed | |
| $metric | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member.
| public abstract mixed georadiusbymember ( mixed $key, mixed $member, mixed $radius, mixed $metric, mixed $options ) | ||
| $key | mixed | |
| $member | mixed | |
| $radius | mixed | |
| $metric | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Returns the bit value at offset in the string value stored at key.
| public abstract mixed getbit ( mixed $key, mixed $offset ) | ||
| $key | mixed | |
| $offset | mixed | |
| return | mixed | |
|---|---|---|
Get a substring of the string stored at a key.
| public abstract mixed getrange ( mixed $key, mixed $start, mixed $end ) | ||
| $key | mixed | |
| $start | mixed | |
| $end | mixed | |
| return | mixed | |
|---|---|---|
Set the string value of a key and return its old value.
| public abstract mixed getset ( mixed $key, mixed $value ) | ||
| $key | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Delete one or more hash fields.
| public abstract mixed hdel ( mixed $key, mixed $fields ) | ||
| $key | mixed | |
| $fields | mixed | |
| return | mixed | |
|---|---|---|
Determine if a hash field exists.
| public abstract mixed hexists ( mixed $key, mixed $field ) | ||
| $key | mixed | |
| $field | mixed | |
| return | mixed | |
|---|---|---|
Get the value of a hash field.
| public abstract mixed hget ( mixed $key, mixed $field ) | ||
| $key | mixed | |
| $field | mixed | |
| return | mixed | |
|---|---|---|
Get all the fields and values in a hash.
| public abstract mixed hgetall ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Increment the integer value of a hash field by the given number.
| public abstract mixed hincrby ( mixed $key, mixed $field, mixed $increment ) | ||
| $key | mixed | |
| $field | mixed | |
| $increment | mixed | |
| return | mixed | |
|---|---|---|
Increment the float value of a hash field by the given amount.
| public abstract mixed hincrbyfloat ( mixed $key, mixed $field, mixed $increment ) | ||
| $key | mixed | |
| $field | mixed | |
| $increment | mixed | |
| return | mixed | |
|---|---|---|
Get the number of fields in a hash.
| public abstract mixed hlen ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Get the values of all the given hash fields.
| public abstract mixed hmget ( mixed $key, mixed $fields ) | ||
| $key | mixed | |
| $fields | mixed | |
| return | mixed | |
|---|---|---|
Set multiple hash fields to multiple values.
| public abstract mixed hmset ( mixed $key, mixed $field, mixed $value, mixed $more ) | ||
| $key | mixed | |
| $field | mixed | |
| $value | mixed | |
| $more | mixed | |
| return | mixed | |
|---|---|---|
Incrementally iterate hash fields and associated values.
| public abstract mixed hscan ( mixed $key, mixed $cursor, mixed $MATCH, mixed $pattern, mixed $COUNT, mixed $count ) | ||
| $key | mixed | |
| $cursor | mixed | |
| $MATCH | mixed | |
| $pattern | mixed | |
| $COUNT | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Set the string value of a hash field.
| public abstract mixed hset ( mixed $key, mixed $field, mixed $value ) | ||
| $key | mixed | |
| $field | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Set the value of a hash field, only if the field does not exist.
| public abstract mixed hsetnx ( mixed $key, mixed $field, mixed $value ) | ||
| $key | mixed | |
| $field | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Get the length of the value of a hash field.
| public abstract mixed hstrlen ( mixed $key, mixed $field ) | ||
| $key | mixed | |
| $field | mixed | |
| return | mixed | |
|---|---|---|
Increment the integer value of a key by one.
| public abstract mixed incr ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Increment the integer value of a key by the given amount.
| public abstract mixed incrby ( mixed $key, mixed $increment ) | ||
| $key | mixed | |
| $increment | mixed | |
| return | mixed | |
|---|---|---|
Increment the float value of a key by the given amount.
| public abstract mixed incrbyfloat ( mixed $key, mixed $increment ) | ||
| $key | mixed | |
| $increment | mixed | |
| return | mixed | |
|---|---|---|
Get information and statistics about the server.
| public abstract mixed info ( mixed $section ) | ||
| $section | mixed | |
| return | mixed | |
|---|---|---|
Find all keys matching the given pattern.
| public abstract mixed keys ( mixed $pattern ) | ||
| $pattern | mixed | |
| return | mixed | |
|---|---|---|
Get the UNIX time stamp of the last successful save to disk.
| public abstract mixed lastsave ( ) | ||
| return | mixed | |
|---|---|---|
Get an element from a list by its index.
| public abstract mixed lindex ( mixed $key, mixed $index ) | ||
| $key | mixed | |
| $index | mixed | |
| return | mixed | |
|---|---|---|
Insert an element before or after another element in a list.
| public abstract mixed linsert ( mixed $key, mixed $where, mixed $pivot, mixed $value ) | ||
| $key | mixed | |
| $where | mixed | |
| $pivot | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Remove and get the first element in a list.
| public abstract mixed lpop ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Prepend one or multiple values to a list.
| public abstract mixed lpush ( mixed $key, mixed $values ) | ||
| $key | mixed | |
| $values | mixed | |
| return | mixed | |
|---|---|---|
Prepend a value to a list, only if the list exists.
| public abstract mixed lpushx ( mixed $key, mixed $value ) | ||
| $key | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Get a range of elements from a list.
| public abstract mixed lrange ( mixed $key, mixed $start, mixed $stop ) | ||
| $key | mixed | |
| $start | mixed | |
| $stop | mixed | |
| return | mixed | |
|---|---|---|
Remove elements from a list.
| public abstract mixed lrem ( mixed $key, mixed $count, mixed $value ) | ||
| $key | mixed | |
| $count | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Set the value of an element in a list by its index.
| public abstract mixed lset ( mixed $key, mixed $index, mixed $value ) | ||
| $key | mixed | |
| $index | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Trim a list to the specified range.
| public abstract mixed ltrim ( mixed $key, mixed $start, mixed $stop ) | ||
| $key | mixed | |
| $start | mixed | |
| $stop | mixed | |
| return | mixed | |
|---|---|---|
Get the values of all the given keys.
| public abstract mixed mget ( mixed $keys ) | ||
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Atomically transfer a key from a Redis instance to another one..
| public abstract mixed migrate ( mixed $host, mixed $port, mixed $key, mixed $destinationDb, mixed $timeout, mixed $options ) | ||
| $host | mixed | |
| $port | mixed | |
| $key | mixed | |
| $destinationDb | mixed | |
| $timeout | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Listen for all requests received by the server in real time.
| public abstract mixed monitor ( ) | ||
| return | mixed | |
|---|---|---|
Move a key to another database.
| public abstract mixed move ( mixed $key, mixed $db ) | ||
| $key | mixed | |
| $db | mixed | |
| return | mixed | |
|---|---|---|
Set multiple keys to multiple values.
| public abstract mixed mset ( mixed $keyValuePairs ) | ||
| $keyValuePairs | mixed | |
| return | mixed | |
|---|---|---|
Set multiple keys to multiple values, only if none of the keys exist.
| public abstract mixed msetnx ( mixed $keyValuePairs ) | ||
| $keyValuePairs | mixed | |
| return | mixed | |
|---|---|---|
Inspect the internals of Redis objects.
| public abstract mixed object ( mixed $subcommand, mixed $argumentss ) | ||
| $subcommand | mixed | |
| $argumentss | mixed | |
| return | mixed | |
|---|---|---|
Remove the expiration from a key.
| public abstract mixed persist ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Set a key's time to live in milliseconds.
| public abstract mixed pexpire ( mixed $key, mixed $milliseconds ) | ||
| $key | mixed | |
| $milliseconds | mixed | |
| return | mixed | |
|---|---|---|
Set the expiration for a key as a UNIX timestamp specified in milliseconds.
| public abstract mixed pexpireat ( mixed $key, mixed $millisecondsTimestamp ) | ||
| $key | mixed | |
| $millisecondsTimestamp | mixed | |
| return | mixed | |
|---|---|---|
Adds the specified elements to the specified HyperLogLog..
| public abstract mixed pfadd ( mixed $key, mixed $elements ) | ||
| $key | mixed | |
| $elements | mixed | |
| return | mixed | |
|---|---|---|
Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s)..
| public abstract mixed pfcount ( mixed $keys ) | ||
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Merge N different HyperLogLogs into a single one..
| public abstract mixed pfmerge ( mixed $destkey, mixed $sourcekeys ) | ||
| $destkey | mixed | |
| $sourcekeys | mixed | |
| return | mixed | |
|---|---|---|
Set the value and expiration in milliseconds of a key.
| public abstract mixed psetex ( mixed $key, mixed $milliseconds, mixed $value ) | ||
| $key | mixed | |
| $milliseconds | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Listen for messages published to channels matching the given patterns.
| public abstract mixed psubscribe ( mixed $patterns ) | ||
| $patterns | mixed | |
| return | mixed | |
|---|---|---|
Get the time to live for a key in milliseconds.
| public abstract mixed pttl ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Post a message to a channel.
| public abstract mixed publish ( mixed $channel, mixed $message ) | ||
| $channel | mixed | |
| $message | mixed | |
| return | mixed | |
|---|---|---|
Inspect the state of the Pub/Sub subsystem.
| public abstract mixed pubsub ( mixed $subcommand, mixed $arguments ) | ||
| $subcommand | mixed | |
| $arguments | mixed | |
| return | mixed | |
|---|---|---|
Stop listening for messages posted to channels matching the given patterns.
| public abstract mixed punsubscribe ( mixed $patterns ) | ||
| $patterns | mixed | |
| return | mixed | |
|---|---|---|
Enables read queries for a connection to a cluster slave node.
| public abstract mixed readonly ( ) | ||
| return | mixed | |
|---|---|---|
Disables read queries for a connection to a cluster slave node.
| public abstract mixed readwrite ( ) | ||
| return | mixed | |
|---|---|---|
Rename a key.
| public abstract mixed rename ( mixed $key, mixed $newkey ) | ||
| $key | mixed | |
| $newkey | mixed | |
| return | mixed | |
|---|---|---|
Rename a key, only if the new key does not exist.
| public abstract mixed renamenx ( mixed $key, mixed $newkey ) | ||
| $key | mixed | |
| $newkey | mixed | |
| return | mixed | |
|---|---|---|
Create a key using the provided serialized value, previously obtained using DUMP..
| public abstract mixed restore ( mixed $key, mixed $ttl, mixed $serializedValue, mixed $REPLACE ) | ||
| $key | mixed | |
| $ttl | mixed | |
| $serializedValue | mixed | |
| $REPLACE | mixed | |
| return | mixed | |
|---|---|---|
Return the role of the instance in the context of replication.
| public abstract mixed role ( ) | ||
| return | mixed | |
|---|---|---|
Remove and get the last element in a list.
| public abstract mixed rpop ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Remove the last element in a list, prepend it to another list and return it.
| public abstract mixed rpoplpush ( mixed $source, mixed $destination ) | ||
| $source | mixed | |
| $destination | mixed | |
| return | mixed | |
|---|---|---|
Append one or multiple values to a list.
| public abstract mixed rpush ( mixed $key, mixed $values ) | ||
| $key | mixed | |
| $values | mixed | |
| return | mixed | |
|---|---|---|
Append a value to a list, only if the list exists.
| public abstract mixed rpushx ( mixed $key, mixed $value ) | ||
| $key | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Add one or more members to a set.
| public abstract mixed sadd ( mixed $key, mixed $members ) | ||
| $key | mixed | |
| $members | mixed | |
| return | mixed | |
|---|---|---|
Incrementally iterate the keys space.
| public abstract mixed scan ( mixed $cursor, mixed $MATCH, mixed $pattern, mixed $COUNT, mixed $count ) | ||
| $cursor | mixed | |
| $MATCH | mixed | |
| $pattern | mixed | |
| $COUNT | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Get the number of members in a set.
| public abstract mixed scard ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Set the debug mode for executed scripts..
| public abstract mixed scriptDebug ( mixed $option ) | ||
| $option | mixed | |
| return | mixed | |
|---|---|---|
Check existence of scripts in the script cache..
| public abstract mixed scriptExists ( mixed $sha1s ) | ||
| $sha1s | mixed | |
| return | mixed | |
|---|---|---|
Remove all the scripts from the script cache..
| public abstract mixed scriptFlush ( ) | ||
| return | mixed | |
|---|---|---|
Kill the script currently in execution..
| public abstract mixed scriptKill ( ) | ||
| return | mixed | |
|---|---|---|
Load the specified Lua script into the script cache..
| public abstract mixed scriptLoad ( mixed $script ) | ||
| $script | mixed | |
| return | mixed | |
|---|---|---|
Subtract multiple sets and store the resulting set in a key.
| public abstract mixed sdiffstore ( mixed $destination, mixed $keys ) | ||
| $destination | mixed | |
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Change the selected database for the current connection.
| public abstract mixed select ( mixed $index ) | ||
| $index | mixed | |
| return | mixed | |
|---|---|---|
Set the string value of a key.
| public abstract mixed set ( mixed $key, mixed $value, mixed $options ) | ||
| $key | mixed | |
| $value | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Sets or clears the bit at offset in the string value stored at key.
| public abstract mixed setbit ( mixed $key, mixed $offset, mixed $value ) | ||
| $key | mixed | |
| $offset | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Set the value and expiration of a key.
| public abstract mixed setex ( mixed $key, mixed $seconds, mixed $value ) | ||
| $key | mixed | |
| $seconds | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Set the value of a key, only if the key does not exist.
| public abstract mixed setnx ( mixed $key, mixed $value ) | ||
| $key | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Overwrite part of a string at key starting at the specified offset.
| public abstract mixed setrange ( mixed $key, mixed $offset, mixed $value ) | ||
| $key | mixed | |
| $offset | mixed | |
| $value | mixed | |
| return | mixed | |
|---|---|---|
Synchronously save the dataset to disk and then shut down the server.
| public abstract mixed shutdown ( mixed $saveOption ) | ||
| $saveOption | mixed | |
| return | mixed | |
|---|---|---|
Intersect multiple sets and store the resulting set in a key.
| public abstract mixed sinterstore ( mixed $destination, mixed $keys ) | ||
| $destination | mixed | |
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Determine if a given value is a member of a set.
| public abstract mixed sismember ( mixed $key, mixed $member ) | ||
| $key | mixed | |
| $member | mixed | |
| return | mixed | |
|---|---|---|
Make the server a slave of another instance, or promote it as master.
| public abstract mixed slaveof ( mixed $host, mixed $port ) | ||
| $host | mixed | |
| $port | mixed | |
| return | mixed | |
|---|---|---|
Manages the Redis slow queries log.
| public abstract mixed slowlog ( mixed $subcommand, mixed $argument ) | ||
| $subcommand | mixed | |
| $argument | mixed | |
| return | mixed | |
|---|---|---|
Move a member from one set to another.
| public abstract mixed smove ( mixed $source, mixed $destination, mixed $member ) | ||
| $source | mixed | |
| $destination | mixed | |
| $member | mixed | |
| return | mixed | |
|---|---|---|
Sort the elements in a list, set or sorted set.
| public abstract mixed sort ( mixed $key, mixed $options ) | ||
| $key | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Remove and return one or multiple random members from a set.
| public abstract mixed spop ( mixed $key, mixed $count ) | ||
| $key | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Get one or multiple random members from a set.
| public abstract mixed srandmember ( mixed $key, mixed $count ) | ||
| $key | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Remove one or more members from a set.
| public abstract mixed srem ( mixed $key, mixed $members ) | ||
| $key | mixed | |
| $members | mixed | |
| return | mixed | |
|---|---|---|
Incrementally iterate Set elements.
| public abstract mixed sscan ( mixed $key, mixed $cursor, mixed $MATCH, mixed $pattern, mixed $COUNT, mixed $count ) | ||
| $key | mixed | |
| $cursor | mixed | |
| $MATCH | mixed | |
| $pattern | mixed | |
| $COUNT | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Get the length of the value stored in a key.
| public abstract mixed strlen ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Listen for messages published to the given channels.
| public abstract mixed subscribe ( mixed $channels ) | ||
| $channels | mixed | |
| return | mixed | |
|---|---|---|
Add multiple sets and store the resulting set in a key.
| public abstract mixed sunionstore ( mixed $destination, mixed $keys ) | ||
| $destination | mixed | |
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Swaps two Redis databases.
| public abstract mixed swapdb ( mixed $index, mixed $index ) | ||
| $index | mixed | |
| $index | mixed | |
| return | mixed | |
|---|---|---|
Alters the last access time of a key(s).
Returns the number of existing keys specified.. https://redis.io/commands/touch
| public abstract mixed touch ( mixed $keys ) | ||
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Delete a key asynchronously in another thread.
Otherwise it is just as DEL, but non blocking.. https://redis.io/commands/unlink
| public abstract mixed unlink ( mixed $keys ) | ||
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Stop listening for messages posted to the given channels.
| public abstract mixed unsubscribe ( mixed $channels ) | ||
| $channels | mixed | |
| return | mixed | |
|---|---|---|
Wait for the synchronous replication of all the write commands sent in the context of the current connection.
| public abstract mixed wait ( mixed $numslaves, mixed $timeout ) | ||
| $numslaves | mixed | |
| $timeout | mixed | |
| return | mixed | |
|---|---|---|
Watch the given keys to determine execution of the MULTI/EXEC block.
| public abstract mixed watch ( mixed $keys ) | ||
| $keys | mixed | |
| return | mixed | |
|---|---|---|
Removes one or multiple messages from the pending entries list (PEL) of a stream consumer group https://redis.io/commands/xack
| public abstract mixed xack ( mixed $stream, mixed $group, mixed $ids ) | ||
| $stream | mixed | |
| $group | mixed | |
| $ids | mixed | |
| return | mixed | |
|---|---|---|
Appends the specified stream entry to the stream at the specified key https://redis.io/commands/xadd
| public abstract mixed xadd ( mixed $stream, mixed $id, mixed $field, mixed $value, mixed $fieldsValues ) | ||
| $stream | mixed | |
| $id | mixed | |
| $field | mixed | |
| $value | mixed | |
| $fieldsValues | mixed | |
| return | mixed | |
|---|---|---|
Changes the ownership of a pending message, so that the new owner is the consumer specified as the command argument https://redis.io/commands/xclaim
| public abstract mixed xclaim ( mixed $stream, mixed $group, mixed $consumer, mixed $minIdleTimeMs, mixed $id, mixed $options ) | ||
| $stream | mixed | |
| $group | mixed | |
| $consumer | mixed | |
| $minIdleTimeMs | mixed | |
| $id | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Removes the specified entries from a stream, and returns the number of entries deleted https://redis.io/commands/xdel
| public abstract mixed xdel ( mixed $stream, mixed $ids ) | ||
| $stream | mixed | |
| $ids | mixed | |
| return | mixed | |
|---|---|---|
Manages the consumer groups associated with a stream data structure https://redis.io/commands/xgroup
| public abstract mixed xgroup ( mixed $subCommand, mixed $stream, mixed $group, mixed $options ) | ||
| $subCommand | mixed | |
| $stream | mixed | |
| $group | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Retrieves different information about the streams and associated consumer groups https://redis.io/commands/xinfo
| public abstract mixed xinfo ( mixed $subCommand, mixed $stream, mixed $options ) | ||
| $subCommand | mixed | |
| $stream | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Returns the number of entries inside a stream https://redis.io/commands/xlen
| public abstract mixed xlen ( mixed $stream ) | ||
| $stream | mixed | |
| return | mixed | |
|---|---|---|
Fetching data from a stream via a consumer group, and not acknowledging such data, has the effect of creating pending entries https://redis.io/commands/xpending
| public abstract mixed xpending ( mixed $stream, mixed $group, mixed $options ) | ||
| $stream | mixed | |
| $group | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Returns the stream entries matching a given range of IDs https://redis.io/commands/xrange
| public abstract mixed xrange ( mixed $stream, mixed $start, mixed $end, mixed $options ) | ||
| $stream | mixed | |
| $start | mixed | |
| $end | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Read data from one or multiple streams, only returning entries with an ID greater than the last received ID reported by the caller https://redis.io/commands/xread
| public abstract mixed xread ( mixed $options ) | ||
| $options | mixed | |
| return | mixed | |
|---|---|---|
Special version of the XREAD command with support for consumer groups https://redis.io/commands/xreadgroup
| public abstract mixed xreadgroup ( mixed $subCommand, mixed $group, mixed $consumer, mixed $options ) | ||
| $subCommand | mixed | |
| $group | mixed | |
| $consumer | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Exactly like XRANGE, but with the notable difference of returning the entries in reverse order, and also taking the start-end range in reverse order https://redis.io/commands/xrevrange
| public abstract mixed xrevrange ( mixed $stream, mixed $end, mixed $start, mixed $options ) | ||
| $stream | mixed | |
| $end | mixed | |
| $start | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Trims the stream to a given number of items, evicting older items (items with lower IDs) if needed https://redis.io/commands/xtrim
| public abstract mixed xtrim ( mixed $stream, mixed $strategy, mixed $options ) | ||
| $stream | mixed | |
| $strategy | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Add one or more members to a sorted set, or update its score if it already exists.
| public abstract mixed zadd ( mixed $key, mixed $options ) | ||
| $key | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Get the number of members in a sorted set.
| public abstract mixed zcard ( mixed $key ) | ||
| $key | mixed | |
| return | mixed | |
|---|---|---|
Count the members in a sorted set with scores within the given values.
| public abstract mixed zcount ( mixed $key, mixed $min, mixed $max ) | ||
| $key | mixed | |
| $min | mixed | |
| $max | mixed | |
| return | mixed | |
|---|---|---|
Increment the score of a member in a sorted set.
| public abstract mixed zincrby ( mixed $key, mixed $increment, mixed $member ) | ||
| $key | mixed | |
| $increment | mixed | |
| $member | mixed | |
| return | mixed | |
|---|---|---|
Intersect multiple sorted sets and store the resulting sorted set in a new key.
| public abstract mixed zinterstore ( mixed $destination, mixed $numkeys, mixed $key, mixed $options ) | ||
| $destination | mixed | |
| $numkeys | mixed | |
| $key | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Count the number of members in a sorted set between a given lexicographical range.
| public abstract mixed zlexcount ( mixed $key, mixed $min, mixed $max ) | ||
| $key | mixed | |
| $min | mixed | |
| $max | mixed | |
| return | mixed | |
|---|---|---|
Return a range of members in a sorted set, by index.
| public abstract mixed zrange ( mixed $key, mixed $start, mixed $stop, mixed $WITHSCORES ) | ||
| $key | mixed | |
| $start | mixed | |
| $stop | mixed | |
| $WITHSCORES | mixed | |
| return | mixed | |
|---|---|---|
Return a range of members in a sorted set, by lexicographical range.
| public abstract mixed zrangebylex ( mixed $key, mixed $min, mixed $max, mixed $LIMIT, mixed $offset, mixed $count ) | ||
| $key | mixed | |
| $min | mixed | |
| $max | mixed | |
| $LIMIT | mixed | |
| $offset | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Return a range of members in a sorted set, by score.
| public abstract mixed zrangebyscore ( mixed $key, mixed $min, mixed $max, mixed $options ) | ||
| $key | mixed | |
| $min | mixed | |
| $max | mixed | |
| $options | mixed | |
| return | mixed | |
|---|---|---|
Determine the index of a member in a sorted set.
| public abstract mixed zrank ( mixed $key, mixed $member ) | ||
| $key | mixed | |
| $member | mixed | |
| return | mixed | |
|---|---|---|
Remove one or more members from a sorted set.
| public abstract mixed zrem ( mixed $key, mixed $members ) | ||
| $key | mixed | |
| $members | mixed | |
| return | mixed | |
|---|---|---|
Remove all members in a sorted set between the given lexicographical range.
| public abstract mixed zremrangebylex ( mixed $key, mixed $min, mixed $max ) | ||
| $key | mixed | |
| $min | mixed | |
| $max | mixed | |
| return | mixed | |
|---|---|---|
Remove all members in a sorted set within the given indexes.
| public abstract mixed zremrangebyrank ( mixed $key, mixed $start, mixed $stop ) | ||
| $key | mixed | |
| $start | mixed | |
| $stop | mixed | |
| return | mixed | |
|---|---|---|
Remove all members in a sorted set within the given scores.
| public abstract mixed zremrangebyscore ( mixed $key, mixed $min, mixed $max ) | ||
| $key | mixed | |
| $min | mixed | |
| $max | mixed | |
| return | mixed | |
|---|---|---|
Return a range of members in a sorted set, by index, with scores ordered from high to low.
| public abstract mixed zrevrange ( mixed $key, mixed $start, mixed $stop, mixed $WITHSCORES ) | ||
| $key | mixed | |
| $start | mixed | |
| $stop | mixed | |
| $WITHSCORES | mixed | |
| return | mixed | |
|---|---|---|
Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings..
| public abstract mixed zrevrangebylex ( mixed $key, mixed $max, mixed $min, mixed $LIMIT, mixed $offset, mixed $count ) | ||
| $key | mixed | |
| $max | mixed | |
| $min | mixed | |
| $LIMIT | mixed | |
| $offset | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Return a range of members in a sorted set, by score, with scores ordered from high to low.
| public abstract mixed zrevrangebyscore ( mixed $key, mixed $max, mixed $min, mixed $WITHSCORES, mixed $LIMIT, mixed $offset, mixed $count ) | ||
| $key | mixed | |
| $max | mixed | |
| $min | mixed | |
| $WITHSCORES | mixed | |
| $LIMIT | mixed | |
| $offset | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Determine the index of a member in a sorted set, with scores ordered from high to low.
| public abstract mixed zrevrank ( mixed $key, mixed $member ) | ||
| $key | mixed | |
| $member | mixed | |
| return | mixed | |
|---|---|---|
Incrementally iterate sorted sets elements and associated scores.
| public abstract mixed zscan ( mixed $key, mixed $cursor, mixed $MATCH, mixed $pattern, mixed $COUNT, mixed $count ) | ||
| $key | mixed | |
| $cursor | mixed | |
| $MATCH | mixed | |
| $pattern | mixed | |
| $COUNT | mixed | |
| $count | mixed | |
| return | mixed | |
|---|---|---|
Get the score associated with the given member in a sorted set.
| public abstract mixed zscore ( mixed $key, mixed $member ) | ||
| $key | mixed | |
| $member | mixed | |
| return | mixed | |
|---|---|---|